Module clients_library
choreov3/clients_library
1.0.0
Clients
clients_library: APIMClient
Isolated
validateEnvName
Isolated Function
function validateEnvName(string orgUUID, string authHeader, string envName, string correlationId) returns json|errorParameters
- orgUUID string -
- authHeader string -
- envName string -
- correlationId string (default "" ) -
isValidEnvName
Isolated Function
function isValidEnvName(string orgUUID, string authHeader, string envName, string correlationId) returns boolean|errorParameters
- orgUUID string -
- authHeader string -
- envName string -
- correlationId string (default "" ) -
validateVhost
Isolated Function
function validateVhost(string orgUUID, string authHeader, string vhost, string correlationId) returns json|errorisValidVhost
Isolated Function
function isValidVhost(string orgUUID, string authHeader, string vhost, string correlationId) returns boolean|errorcreateApimGWEnv
Isolated Function
function createApimGWEnv(string orgUUID, ApimGwEnvironmentCreateRequest env, string authHeader, string correlationId) returns ApimEnvironment|errorgetApimGWEnvs
Isolated Function
function getApimGWEnvs(string orgUUID, string authHeader, string correlationId) returns ApimGwEnvironmentGetResponse|errordeleteApimGWEnvs
Isolated Function
function deleteApimGWEnvs(ApimEnvironment[] envs, string orguuid, string? authHeader, string correlationId) returns booleanParameters
- envs ApimEnvironment[] -
- orguuid string -
- authHeader string? -
- correlationId string (default "") -
deleteApimGWEnv
Isolated Function
function deleteApimGWEnv(string orgUUID, string environmentId, string authHeader, string correlationId) returns json|errorParameters
- orgUUID string -
- environmentId string -
- authHeader string -
- correlationId string (default "" ) -
getAccessToken
Isolated Function
getBase64EncodedAuthHeader
Isolated Function
function getBase64EncodedAuthHeader() returns stringclients_library: AppServiceClient
Isolated
getOrganization
Isolated Function
function getOrganization(string organizationName, string correlationId) returns GetOrganizationResponse|errorclients_library: CloudManagerClient
Isolated
getEnvironments
Isolated Function
function getEnvironments(int organizationId, string correlationId) returns GetEnvironmentsResponse|errorgetDeploymentPipelinesOfOrg
Isolated Function
function getDeploymentPipelinesOfOrg(int organizationId, string orgUUID, string correlationId) returns DeploymentPipelinesResponse|errorgetEnvironmentsOfDeploymentPipeline
Isolated Function
function getEnvironmentsOfDeploymentPipeline(int organizationId, string deploymentPipelineId, string correlationId) returns GetEnvironmentsResponse|errorgetEnvironmentsOfOrganization
Isolated Function
function getEnvironmentsOfOrganization(int organizationId, string correlationId) returns GetEnvironmentsResponse|errorgetAllDefaultEnvPresets
Isolated Function
function getAllDefaultEnvPresets(string correlationId) returns DefaultEnvPresetResponse|errorParameters
- correlationId string (default "") -
createEnvironment
Isolated Function
function createEnvironment(int organizationId, CreateEnvironment[] requestBody, string correlationId) returns GetEnvironmentsResponse|errorParameters
- organizationId int -
- requestBody CreateEnvironment[] -
- correlationId string (default "") -
getDefualtDeploymentPipelineByRegion
Isolated Function
function getDefualtDeploymentPipelineByRegion(string clusterName, string correlationId) returns DeploymentPipelineResponse|errorcreateDeploymentPipeline
Isolated Function
function createDeploymentPipeline(int organizationId, DeploymentPipelineCreationRequest deploymentPipeline, string correlationId) returns DeploymentPipelineResponse|errorParameters
- organizationId int -
- deploymentPipeline DeploymentPipelineCreationRequest -
- correlationId string (default "") -
updateDeploymentPipeline
Isolated Function
function updateDeploymentPipeline(int organizationId, DeploymentPipeline deploymentPipeline, string correlationId) returns DeploymentPipelineResponse|errorParameters
- organizationId int -
- deploymentPipeline DeploymentPipeline -
- correlationId string (default "") -
deleteEnvironment
Isolated Function
function deleteEnvironment(int organizationId, string envTemplateId, string correlationId) returns GetEnvironmentResponse|errorgetDataplaneStats
Isolated Function
function getDataplaneStats(string correlationId) returns GetDataplaneStatsResponse|errorParameters
- correlationId string (default "") -
clients_library: MizzenClient
Isolated
getCluster
Isolated Function
clients_library: SubscriptionServiceClient
Isolated
getSubscription
Isolated Function
function getSubscription(string orgId) returns SubscriptionResponse|errorParameters
- orgId string -
Constants
Records
clients_library: APIMConnectionConfig
Closed record
Fields
- url string -
- enableSSLVerification boolean -
- retryConfig RetryConfig -
clients_library: ApimEnvironment
ApimEnvironment record represents an environment in APIM
Fields
- id string -
- name string -
- displayName string -
- description string -
- dataPlaneId string -
- gatewayAccessibilityType string - Accessibility type of the environment (i.e. external or internal)
- vHost? string -
- vhosts? VHost[] -
clients_library: ApimEnvRespMapper
Fields
- list ApimEnvironment[] -
clients_library: ApimGwEnvironmentCreateRequest
Fields
- name string -
- displayName string -
- description? string -
- provider string -
- dataPlaneId string -
- gatewayAccessibilityType string -
- vhosts EnvVhost[] -
clients_library: ApimGwEnvironmentGetResponse
Fields
- count int -
- list ApimEnvironment[] -
clients_library: ApimTokenResponse
Fields
- access_token string -
- scope string -
- token_type string -
- expires_in int -
clients_library: ClientHttp1Settings
Closed record
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_NEVER) - Specifies whether to reuse a connection for multiple requests
clients_library: Cluster
Fields
- id string -
- name string -
- 'type string -
- createdOn string -
- labels? ClusterLabels? -
- isActive boolean -
- externalGatewayVirtualHost string? -
- internalGatewayVirtualHost string? -
- externalIngressDefaultDomain? string? -
- pdpInstallationConfig? PDPInstallationConfig? -
clients_library: ClusterLabels
Fields
- 'private? boolean -
clients_library: ConnectionConfig
Closed record
Fields
- httpVersion HttpVersion(default http:HTTP_1_1) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {keepAlive: http:KEEPALIVE_NEVER}) - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
clients_library: CreateEnvironment
Fields
- organization_id int -
- organization_uuid string -
- env_name string -
- region string -
- choreo_env string -
- cluster_id string -
- docker_credential_uuid string -
- external_apim_env_name string -
- internal_apim_env_name string -
- sandbox_apim_env_name string -
- critical boolean -
- pdp_web_app_dns_prefix string -
clients_library: DataplaneAvailability
Fields
- id string -
- name string -
- is_available boolean -
clients_library: DataplaneCapacity
Fields
- dataplane_id string -
- dataplane_name string -
- org_count int -
clients_library: DefaultEnvPreset
Fields
- id string -
- created_at string -
- env_name string -
- region string -
- choreo_env string -
- cluster_id string -
- docker_credential_uuid string -
- external_apim_env_name string -
- internal_apim_env_name string -
- sandbox_apim_env_name string -
- critical boolean -
clients_library: DefaultEnvPresetResponse
Fields
- data DefaultEnvPreset[] -
clients_library: DeploymentPipeline
Represents a deployment pipelines of an org.
Fields
- id string - UUID of the deployment pipeline
- created_at string - Created time of the deployment pipeline
- organization_uuid string - Organization UUID of the deployment pipeline
- promotion_order map<string[]> - Example for promotion_order: "promotion_order": { "235c88da-92ca-42a0-8ca5-121235d30268": [], "62964016-5a81-417f-b8ef-eed18790714f": ["235c88da-92ca-42a0-8ca5-121235d30268"], "a1391e96-a17c-4879-841a-80981bd150e8": ["235c88da-92ca-42a0-8ca5-121235d30268", "62964016-5a81-417f-b8ef-eed18790714f"] } In the above PromotionOrder, a1391e96-a17c-4879-841a-80981bd150e8 environment can be promoted to 235c88da-92ca-42a0-8ca5-121235d30268 and 62964016-5a81-417f-b8ef-eed18790714f environments.
- name string - Name of the deployment pipeline
- is_default boolean - Specifies whether the deployment pipeline is the default one or not
clients_library: DeploymentPipelineCreationRequest
Fields
- organization_uuid string -
- name string -
- is_default boolean -
clients_library: DeploymentPipelineResponse
Fields
- data DeploymentPipeline -
clients_library: DeploymentPipelinesResponse
Fields
- data DeploymentPipeline[] -
clients_library: DeploymentPipelineWithEnvironments
Fields
- deploymentPipeline DeploymentPipeline -
- environments EnvironmentData[] -
clients_library: EnvironmentData
Fields
- id string -
- created_at string -
- organization_id int -
- organization_uuid? string? -
- env_name string -
- region string -
- choreo_env string -
- cluster_id string -
- docker_credential_uuid string -
- external_apim_env_name string -
- internal_apim_env_name string -
- sandbox_apim_env_name string -
- critical boolean -
- promote_from? string[]? -
- pdp_web_app_dns_prefix? string? -
clients_library: EnvVhost
Fields
- host string -
- httpContext string -
- httpPort int -
- httpsPort int -
- wsPort int -
- wssPort int -
clients_library: GetDataplaneStatsResponse
Fields
- data DataplaneCapacity[] -
clients_library: GetEnvironmentResponse
Fields
- data EnvironmentData -
clients_library: GetEnvironmentsResponse
Fields
- data EnvironmentData[] -
clients_library: PDPInstallationConfig
Fields
- containerRegistryCredentialId? string? -
- isPersonalPDP? boolean? -
clients_library: RetryConfig
Closed record
Fields
- count int -
- interval decimal -
- backOffFactor float -
- maxWaitInterval decimal -
- statusCodes int[] -
clients_library: SubscriptionResponse
Fields
- org_id string(default "") -
- org_handle string(default "") -
- tier_id string(default "") -
- is_paid boolean(default false) -
clients_library: VHost
Fields
- host string -
Errors
clients_library: Error
Distinct
Import
import choreov3/clients_library;Other versions
1.0.0