From b362fbce3c435c020a3adf9daaab8003db5dc203 Mon Sep 17 00:00:00 2001 From: SaladTechnologies <415806+seniorquico@users.noreply.github.com> Date: Tue, 17 Sep 2024 04:03:12 +0000 Subject: [PATCH] liblab SDK update for version v0.9.0-alpha.3 --- .manifest.json | 24 +- README.md | 6 +- documentation/models/Container.md | 132 ++--- documentation/models/ContainerGroup.md | 42 +- .../models/ContainerGroupInstance.md | 32 +- .../ContainerGroupInstanceStatusCount.md | 12 +- .../models/ContainerGroupInstances.md | 6 +- documentation/models/ContainerGroupList.md | 6 +- .../models/ContainerGroupLivenessProbe.md | 22 +- .../models/ContainerGroupNetworking.md | 12 +- .../models/ContainerGroupPriority.md | 12 +- .../models/ContainerGroupProbeExec.md | 6 +- .../models/ContainerGroupProbeGrpc.md | 8 +- .../models/ContainerGroupProbeHttp.md | 12 +- .../models/ContainerGroupProbeHttpHeaders2.md | 8 +- .../models/ContainerGroupProbeTcp.md | 6 +- .../models/ContainerGroupQueueConnection.md | 10 +- .../models/ContainerGroupReadinessProbe.md | 22 +- .../models/ContainerGroupStartupProbe.md | 22 +- documentation/models/ContainerGroupState.md | 14 +- documentation/models/ContainerGroupStatus.md | 16 +- documentation/models/ContainerGroupsQuotas.md | 14 +- .../models/ContainerNetworkingProtocol.md | 6 +- .../models/ContainerProbeHttpScheme.md | 6 +- .../models/ContainerResourceRequirements.md | 12 +- .../models/ContainerRestartPolicy.md | 10 +- documentation/models/CountryCode.md | 502 +++++++++--------- documentation/models/CreateContainer.md | 180 +++---- documentation/models/CreateContainerGroup.md | 30 +- .../models/CreateContainerGroupNetworking.md | 10 +- .../models/CreateInferenceEndpointJob.md | 10 +- documentation/models/CreateQueue.md | 10 +- documentation/models/CreateQueueJob.md | 10 +- documentation/models/GpuClass.md | 12 +- documentation/models/GpuClassPrice.md | 8 +- documentation/models/GpuClassesList.md | 6 +- documentation/models/InferenceEndpoint.md | 20 +- documentation/models/InferenceEndpointJob.md | 40 +- .../models/InferenceEndpointJobEvent.md | 22 +- .../models/InferenceEndpointJobList.md | 6 +- .../models/InferenceEndpointsList.md | 6 +- documentation/models/Queue.md | 18 +- documentation/models/QueueAutoscaler.md | 16 +- documentation/models/QueueJob.md | 36 +- documentation/models/QueueJobEvent.md | 22 +- documentation/models/QueueJobList.md | 6 +- documentation/models/QueueList.md | 6 +- documentation/models/Quotas.md | 12 +- documentation/models/RecipesQuotas.md | 8 +- documentation/models/UpdateContainer.md | 192 +++---- documentation/models/UpdateContainerGroup.md | 20 +- .../models/UpdateContainerGroupNetworking.md | 6 +- documentation/models/UpdateQueue.md | 8 +- documentation/models/WebhookSecretKey.md | 6 +- documentation/models/WorkloadError.md | 18 +- documentation/models/WorkloadErrorList.md | 6 +- .../services/ContainerGroupsService.md | 130 ++--- .../services/InferenceEndpointsService.md | 60 +-- .../services/OrganizationDataService.md | 6 +- documentation/services/QueuesService.md | 100 ++-- documentation/services/QuotasService.md | 6 +- .../services/WebhookSecretKeyService.md | 12 +- .../services/WorkloadErrorsService.md | 10 +- ...projects-{project_name}-containers-post.md | 2 +- examples/package.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/http/client.ts | 2 +- src/http/index.ts | 1 + src/services/common/container-group.ts | 4 +- src/services/common/queue-autoscaler.ts | 4 +- .../models/create-container-group.ts | 4 +- 72 files changed, 1040 insertions(+), 1039 deletions(-) diff --git a/.manifest.json b/.manifest.json index 9b6a03a..d453cb7 100644 --- a/.manifest.json +++ b/.manifest.json @@ -1,10 +1,10 @@ { - "liblabVersion": "2.2.0", - "date": "2024-09-11T04:10:26.246Z", + "liblabVersion": "2.4.0", + "date": "2024-09-17T04:02:32.183Z", "config": { - "apiId": 1143, + "apiId": 1172, "sdkName": "salad-cloud-sdk", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "liblabVersion": "2", "deliveryMethods": ["zip"], "languages": ["typescript"], @@ -26,7 +26,7 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-dotnet", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "go": { @@ -34,7 +34,7 @@ "githubRepoName": "salad-cloud-sdk-go", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "java": { @@ -58,11 +58,11 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-java", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "python": { - "alwaysInitializeOptionals": true, + "alwaysInitializeOptionals": false, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", @@ -101,7 +101,7 @@ "githubRepoName": "salad-cloud-sdk-python", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" }, "terraform": { @@ -112,7 +112,7 @@ "providerSchemaConfig": { "authTokenKey": "api_key" }, - "providerVersion": "0.9.0-alpha.2", + "providerVersion": "0.9.0-alpha.3", "githubRepoName": "terraform-provider-salad-cloud", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", @@ -138,7 +138,7 @@ "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-javascript", "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.2", + "sdkVersion": "0.9.0-alpha.3", "targetBranch": "main" } }, @@ -232,7 +232,7 @@ } ], "apiName": "SaladCloud API", - "apiVersion": "0.9.0-alpha.2", + "apiVersion": "0.9.0-alpha.3", "authentication": { "apiKey": { "header": "Salad-Api-Key" diff --git a/README.md b/README.md index d96ece0..015b729 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# SaladCloudSdk TypeScript SDK 0.9.0-alpha.2 +# SaladCloudSdk TypeScript SDK 0.9.0-alpha.3 Welcome to the SaladCloudSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudSdk SDK in your project. ## Versions -- API version: `0.9.0-alpha.2` -- SDK version: `0.9.0-alpha.2` +- API version: `0.9.0-alpha.3` +- SDK version: `0.9.0-alpha.3` ## About the API diff --git a/documentation/models/Container.md b/documentation/models/Container.md index ab49964..ef9ca45 100644 --- a/documentation/models/Container.md +++ b/documentation/models/Container.md @@ -4,124 +4,124 @@ Represents a container **Properties** -| Name | Type | Required | Description | -| :------------------- | :------------------------------ | :------- | :------------------------------------------- | -| image | `string` | ✅ | | -| resources | `ContainerResourceRequirements` | ✅ | Represents a container resource requirements | -| command | `string[]` | ✅ | | -| priority | `ContainerGroupPriority` | ❌ | | -| size | `number` | ❌ | | -| hash | `string` | ❌ | | -| environmentVariables | `any` | ❌ | | -| logging | `ContainerLogging` | ❌ | | +| Name | Type | Required | Description | +| :------------------- | :---------------------------- | :------- | :------------------------------------------- | +| image | string | ✅ | | +| resources | ContainerResourceRequirements | ✅ | Represents a container resource requirements | +| command | string[] | ✅ | | +| priority | ContainerGroupPriority | ❌ | | +| size | number | ❌ | | +| hash | string | ❌ | | +| environmentVariables | any | ❌ | | +| logging | ContainerLogging | ❌ | | # ContainerLogging **Properties** -| Name | Type | Required | Description | -| :------- | :----------------- | :------- | :---------- | -| axiom | `LoggingAxiom1` | ❌ | | -| datadog | `LoggingDatadog1` | ❌ | | -| newRelic | `LoggingNewRelic1` | ❌ | | -| splunk | `LoggingSplunk1` | ❌ | | -| tcp | `LoggingTcp1` | ❌ | | -| http | `LoggingHttp1` | ❌ | | +| Name | Type | Required | Description | +| :------- | :--------------- | :------- | :---------- | +| axiom | LoggingAxiom1 | ❌ | | +| datadog | LoggingDatadog1 | ❌ | | +| newRelic | LoggingNewRelic1 | ❌ | | +| splunk | LoggingSplunk1 | ❌ | | +| tcp | LoggingTcp1 | ❌ | | +| http | LoggingHttp1 | ❌ | | # LoggingAxiom1 **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| apiToken | `string` | ✅ | | -| dataset | `string` | ✅ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :---------- | +| host | string | ✅ | | +| apiToken | string | ✅ | | +| dataset | string | ✅ | | # LoggingDatadog1 **Properties** -| Name | Type | Required | Description | -| :----- | :--------------- | :------- | :---------- | -| host | `string` | ✅ | | -| apiKey | `string` | ✅ | | -| tags | `DatadogTags1[]` | ❌ | | +| Name | Type | Required | Description | +| :----- | :------------- | :------- | :---------- | +| host | string | ✅ | | +| apiKey | string | ✅ | | +| tags | DatadogTags1[] | ❌ | | # DatadogTags1 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | # LoggingNewRelic1 **Properties** -| Name | Type | Required | Description | -| :----------- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| ingestionKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :----------- | :----- | :------- | :---------- | +| host | string | ✅ | | +| ingestionKey | string | ✅ | | # LoggingSplunk1 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| token | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| host | string | ✅ | | +| token | string | ✅ | | # LoggingTcp1 **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| port | `number` | ✅ | | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| host | string | ✅ | | +| port | number | ✅ | | # LoggingHttp1 **Properties** -| Name | Type | Required | Description | -| :---------- | :----------------- | :------- | :---------- | -| host | `string` | ✅ | | -| port | `number` | ✅ | | -| format | `HttpFormat1` | ✅ | | -| compression | `HttpCompression1` | ✅ | | -| user | `string` | ❌ | | -| password | `string` | ❌ | | -| path | `string` | ❌ | | -| headers | `HttpHeaders1[]` | ❌ | | +| Name | Type | Required | Description | +| :---------- | :--------------- | :------- | :---------- | +| host | string | ✅ | | +| port | number | ✅ | | +| format | HttpFormat1 | ✅ | | +| compression | HttpCompression1 | ✅ | | +| user | string | ❌ | | +| password | string | ❌ | | +| path | string | ❌ | | +| headers | HttpHeaders1[] | ❌ | | # HttpFormat1 **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :----------- | -| JSON | `string` | ✅ | "json" | -| JSONLINES | `string` | ✅ | "json_lines" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :----------- | +| JSON | string | ✅ | "json" | +| JSONLINES | string | ✅ | "json_lines" | # HttpCompression1 **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| NONE | `string` | ✅ | "none" | -| GZIP | `string` | ✅ | "gzip" | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| NONE | string | ✅ | "none" | +| GZIP | string | ✅ | "gzip" | # HttpHeaders1 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | diff --git a/documentation/models/ContainerGroup.md b/documentation/models/ContainerGroup.md index 0c8c06c..c5f627d 100644 --- a/documentation/models/ContainerGroup.md +++ b/documentation/models/ContainerGroup.md @@ -4,24 +4,24 @@ Represents a container group **Properties** -| Name | Type | Required | Description | -| :-------------- | :------------------------------ | :------- | :---------------------------------------------------------------------------------------------- | -| id | `string` | ✅ | | -| name | `string` | ✅ | | -| displayName | `string` | ✅ | | -| container | `Container` | ✅ | Represents a container | -| autostartPolicy | `boolean` | ✅ | | -| restartPolicy | `ContainerRestartPolicy` | ✅ | | -| replicas | `number` | ✅ | | -| currentState | `ContainerGroupState` | ✅ | Represents a container group state | -| createTime | `string` | ✅ | | -| updateTime | `string` | ✅ | | -| pendingChange | `boolean` | ✅ | | -| version | `number` | ✅ | | -| countryCodes | `CountryCode[]` | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. | -| networking | `ContainerGroupNetworking` | ❌ | Represents container group networking parameters | -| livenessProbe | `ContainerGroupLivenessProbe` | ❌ | Represents the container group liveness probe | -| readinessProbe | `ContainerGroupReadinessProbe` | ❌ | Represents the container group readiness probe | -| startupProbe | `ContainerGroupStartupProbe` | ❌ | Represents the container group startup probe | -| queueConnection | `ContainerGroupQueueConnection` | ❌ | Represents container group queue connection | -| queueAutoscaler | `QueueAutoscaler` | ❌ | Represents the autoscaling rules for a queue | +| Name | Type | Required | Description | +| :-------------- | :---------------------------- | :------- | :---------------------------------------------------------------------------------------------- | +| id | string | ✅ | | +| name | string | ✅ | | +| displayName | string | ✅ | | +| container | Container | ✅ | Represents a container | +| autostartPolicy | boolean | ✅ | | +| restartPolicy | ContainerRestartPolicy | ✅ | | +| replicas | number | ✅ | | +| currentState | ContainerGroupState | ✅ | Represents a container group state | +| createTime | string | ✅ | | +| updateTime | string | ✅ | | +| pendingChange | boolean | ✅ | | +| version | number | ✅ | | +| countryCodes | CountryCode[] | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. | +| networking | ContainerGroupNetworking | ❌ | Represents container group networking parameters | +| livenessProbe | ContainerGroupLivenessProbe | ❌ | Represents the container group liveness probe | +| readinessProbe | ContainerGroupReadinessProbe | ❌ | Represents the container group readiness probe | +| startupProbe | ContainerGroupStartupProbe | ❌ | Represents the container group startup probe | +| queueConnection | ContainerGroupQueueConnection | ❌ | Represents container group queue connection | +| queueAutoscaler | QueueAutoscaler | ❌ | Represents the autoscaling rules for a queue | diff --git a/documentation/models/ContainerGroupInstance.md b/documentation/models/ContainerGroupInstance.md index a6711b8..fafd3e9 100644 --- a/documentation/models/ContainerGroupInstance.md +++ b/documentation/models/ContainerGroupInstance.md @@ -4,15 +4,15 @@ Represents the details of a single container group instance **Properties** -| Name | Type | Required | Description | -| :--------- | :-------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | -| instanceId | `string` | ✅ | The unique instance ID | -| machineId | `string` | ✅ | The machine ID | -| state | `State` | ✅ | The state of the container group instance | -| updateTime | `string` | ✅ | The UTC date & time when the workload on this machine transitioned to the current state | -| version | `number` | ✅ | The version of the running container group | -| ready | `boolean` | ❌ | Specifies whether the container group instance is currently passing its readiness check. If no readiness probe is defined, is true once fully started. | -| started | `boolean` | ❌ | Specifies whether the container group instance passed its startup probe. Is always true when no startup probe is defined. | +| Name | Type | Required | Description | +| :--------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| instanceId | string | ✅ | The unique instance ID | +| machineId | string | ✅ | The machine ID | +| state | State | ✅ | The state of the container group instance | +| updateTime | string | ✅ | The UTC date & time when the workload on this machine transitioned to the current state | +| version | number | ✅ | The version of the running container group | +| ready | boolean | ❌ | Specifies whether the container group instance is currently passing its readiness check. If no readiness probe is defined, is true once fully started. | +| started | boolean | ❌ | Specifies whether the container group instance passed its startup probe. Is always true when no startup probe is defined. | # State @@ -20,10 +20,10 @@ The state of the container group instance **Properties** -| Name | Type | Required | Description | -| :---------- | :------- | :------- | :------------ | -| ALLOCATING | `string` | ✅ | "allocating" | -| DOWNLOADING | `string` | ✅ | "downloading" | -| CREATING | `string` | ✅ | "creating" | -| RUNNING | `string` | ✅ | "running" | -| STOPPING | `string` | ✅ | "stopping" | +| Name | Type | Required | Description | +| :---------- | :----- | :------- | :------------ | +| ALLOCATING | string | ✅ | "allocating" | +| DOWNLOADING | string | ✅ | "downloading" | +| CREATING | string | ✅ | "creating" | +| RUNNING | string | ✅ | "running" | +| STOPPING | string | ✅ | "stopping" | diff --git a/documentation/models/ContainerGroupInstanceStatusCount.md b/documentation/models/ContainerGroupInstanceStatusCount.md index 4fc8d1d..b8f00c9 100644 --- a/documentation/models/ContainerGroupInstanceStatusCount.md +++ b/documentation/models/ContainerGroupInstanceStatusCount.md @@ -4,9 +4,9 @@ Represents a container group instance status count **Properties** -| Name | Type | Required | Description | -| :-------------- | :------- | :------- | :---------- | -| allocatingCount | `number` | ✅ | | -| creatingCount | `number` | ✅ | | -| runningCount | `number` | ✅ | | -| stoppingCount | `number` | ✅ | | +| Name | Type | Required | Description | +| :-------------- | :----- | :------- | :---------- | +| allocatingCount | number | ✅ | | +| creatingCount | number | ✅ | | +| runningCount | number | ✅ | | +| stoppingCount | number | ✅ | | diff --git a/documentation/models/ContainerGroupInstances.md b/documentation/models/ContainerGroupInstances.md index b9cf26c..abd0293 100644 --- a/documentation/models/ContainerGroupInstances.md +++ b/documentation/models/ContainerGroupInstances.md @@ -4,6 +4,6 @@ Represents a list of container group instances **Properties** -| Name | Type | Required | Description | -| :-------- | :------------------------- | :------- | :---------- | -| instances | `ContainerGroupInstance[]` | ✅ | | +| Name | Type | Required | Description | +| :-------- | :----------------------- | :------- | :---------- | +| instances | ContainerGroupInstance[] | ✅ | | diff --git a/documentation/models/ContainerGroupList.md b/documentation/models/ContainerGroupList.md index 77526c2..c9ebe4a 100644 --- a/documentation/models/ContainerGroupList.md +++ b/documentation/models/ContainerGroupList.md @@ -4,6 +4,6 @@ Represents a list of container groups **Properties** -| Name | Type | Required | Description | -| :---- | :----------------- | :------- | :---------- | -| items | `ContainerGroup[]` | ✅ | | +| Name | Type | Required | Description | +| :---- | :--------------- | :------- | :---------- | +| items | ContainerGroup[] | ✅ | | diff --git a/documentation/models/ContainerGroupLivenessProbe.md b/documentation/models/ContainerGroupLivenessProbe.md index 1c3126f..88b9d30 100644 --- a/documentation/models/ContainerGroupLivenessProbe.md +++ b/documentation/models/ContainerGroupLivenessProbe.md @@ -4,14 +4,14 @@ Represents the container group liveness probe **Properties** -| Name | Type | Required | Description | -| :------------------ | :------------------------ | :------- | :---------- | -| initialDelaySeconds | `number` | ✅ | | -| periodSeconds | `number` | ✅ | | -| timeoutSeconds | `number` | ✅ | | -| successThreshold | `number` | ✅ | | -| failureThreshold | `number` | ✅ | | -| tcp | `ContainerGroupProbeTcp` | ❌ | | -| http | `ContainerGroupProbeHttp` | ❌ | | -| grpc | `ContainerGroupProbeGrpc` | ❌ | | -| exec | `ContainerGroupProbeExec` | ❌ | | +| Name | Type | Required | Description | +| :------------------ | :---------------------- | :------- | :---------- | +| initialDelaySeconds | number | ✅ | | +| periodSeconds | number | ✅ | | +| timeoutSeconds | number | ✅ | | +| successThreshold | number | ✅ | | +| failureThreshold | number | ✅ | | +| tcp | ContainerGroupProbeTcp | ❌ | | +| http | ContainerGroupProbeHttp | ❌ | | +| grpc | ContainerGroupProbeGrpc | ❌ | | +| exec | ContainerGroupProbeExec | ❌ | | diff --git a/documentation/models/ContainerGroupNetworking.md b/documentation/models/ContainerGroupNetworking.md index 0dd0c01..e4edd7d 100644 --- a/documentation/models/ContainerGroupNetworking.md +++ b/documentation/models/ContainerGroupNetworking.md @@ -4,9 +4,9 @@ Represents container group networking parameters **Properties** -| Name | Type | Required | Description | -| :------- | :---------------------------- | :------- | :---------- | -| protocol | `ContainerNetworkingProtocol` | ✅ | | -| port | `number` | ✅ | | -| auth | `boolean` | ✅ | | -| dns | `string` | ✅ | | +| Name | Type | Required | Description | +| :------- | :-------------------------- | :------- | :---------- | +| protocol | ContainerNetworkingProtocol | ✅ | | +| port | number | ✅ | | +| auth | boolean | ✅ | | +| dns | string | ✅ | | diff --git a/documentation/models/ContainerGroupPriority.md b/documentation/models/ContainerGroupPriority.md index 4d2b78c..76c8753 100644 --- a/documentation/models/ContainerGroupPriority.md +++ b/documentation/models/ContainerGroupPriority.md @@ -2,9 +2,9 @@ **Properties** -| Name | Type | Required | Description | -| :----- | :------- | :------- | :---------- | -| HIGH | `string` | ✅ | "high" | -| MEDIUM | `string` | ✅ | "medium" | -| LOW | `string` | ✅ | "low" | -| BATCH | `string` | ✅ | "batch" | +| Name | Type | Required | Description | +| :----- | :----- | :------- | :---------- | +| HIGH | string | ✅ | "high" | +| MEDIUM | string | ✅ | "medium" | +| LOW | string | ✅ | "low" | +| BATCH | string | ✅ | "batch" | diff --git a/documentation/models/ContainerGroupProbeExec.md b/documentation/models/ContainerGroupProbeExec.md index d75f64e..c249b5e 100644 --- a/documentation/models/ContainerGroupProbeExec.md +++ b/documentation/models/ContainerGroupProbeExec.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :------ | :--------- | :------- | :---------- | -| command | `string[]` | ✅ | | +| Name | Type | Required | Description | +| :------ | :------- | :------- | :---------- | +| command | string[] | ✅ | | diff --git a/documentation/models/ContainerGroupProbeGrpc.md b/documentation/models/ContainerGroupProbeGrpc.md index 53184d7..adc9c52 100644 --- a/documentation/models/ContainerGroupProbeGrpc.md +++ b/documentation/models/ContainerGroupProbeGrpc.md @@ -2,7 +2,7 @@ **Properties** -| Name | Type | Required | Description | -| :------ | :------- | :------- | :---------- | -| service | `string` | ✅ | | -| port | `number` | ✅ | | +| Name | Type | Required | Description | +| :------ | :----- | :------- | :---------- | +| service | string | ✅ | | +| port | number | ✅ | | diff --git a/documentation/models/ContainerGroupProbeHttp.md b/documentation/models/ContainerGroupProbeHttp.md index e263c82..aebb7e7 100644 --- a/documentation/models/ContainerGroupProbeHttp.md +++ b/documentation/models/ContainerGroupProbeHttp.md @@ -2,9 +2,9 @@ **Properties** -| Name | Type | Required | Description | -| :------ | :---------------------------------- | :------- | :---------- | -| path | `string` | ✅ | | -| port | `number` | ✅ | | -| scheme | `ContainerProbeHttpScheme` | ❌ | | -| headers | `ContainerGroupProbeHttpHeaders2[]` | ❌ | | +| Name | Type | Required | Description | +| :------ | :-------------------------------- | :------- | :---------- | +| path | string | ✅ | | +| port | number | ✅ | | +| scheme | ContainerProbeHttpScheme | ❌ | | +| headers | ContainerGroupProbeHttpHeaders2[] | ❌ | | diff --git a/documentation/models/ContainerGroupProbeHttpHeaders2.md b/documentation/models/ContainerGroupProbeHttpHeaders2.md index 7ba13dc..5637f42 100644 --- a/documentation/models/ContainerGroupProbeHttpHeaders2.md +++ b/documentation/models/ContainerGroupProbeHttpHeaders2.md @@ -2,7 +2,7 @@ **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | diff --git a/documentation/models/ContainerGroupProbeTcp.md b/documentation/models/ContainerGroupProbeTcp.md index 779189a..af946e7 100644 --- a/documentation/models/ContainerGroupProbeTcp.md +++ b/documentation/models/ContainerGroupProbeTcp.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| port | `number` | ✅ | | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| port | number | ✅ | | diff --git a/documentation/models/ContainerGroupQueueConnection.md b/documentation/models/ContainerGroupQueueConnection.md index 15dd948..c86bfbc 100644 --- a/documentation/models/ContainerGroupQueueConnection.md +++ b/documentation/models/ContainerGroupQueueConnection.md @@ -4,8 +4,8 @@ Represents container group queue connection **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :---------- | -| path | `string` | ✅ | | -| port | `number` | ✅ | | -| queueName | `string` | ✅ | | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :---------- | +| path | string | ✅ | | +| port | number | ✅ | | +| queueName | string | ✅ | | diff --git a/documentation/models/ContainerGroupReadinessProbe.md b/documentation/models/ContainerGroupReadinessProbe.md index c3f1979..115415d 100644 --- a/documentation/models/ContainerGroupReadinessProbe.md +++ b/documentation/models/ContainerGroupReadinessProbe.md @@ -4,14 +4,14 @@ Represents the container group readiness probe **Properties** -| Name | Type | Required | Description | -| :------------------ | :------------------------ | :------- | :---------- | -| initialDelaySeconds | `number` | ✅ | | -| periodSeconds | `number` | ✅ | | -| timeoutSeconds | `number` | ✅ | | -| successThreshold | `number` | ✅ | | -| failureThreshold | `number` | ✅ | | -| tcp | `ContainerGroupProbeTcp` | ❌ | | -| http | `ContainerGroupProbeHttp` | ❌ | | -| grpc | `ContainerGroupProbeGrpc` | ❌ | | -| exec | `ContainerGroupProbeExec` | ❌ | | +| Name | Type | Required | Description | +| :------------------ | :---------------------- | :------- | :---------- | +| initialDelaySeconds | number | ✅ | | +| periodSeconds | number | ✅ | | +| timeoutSeconds | number | ✅ | | +| successThreshold | number | ✅ | | +| failureThreshold | number | ✅ | | +| tcp | ContainerGroupProbeTcp | ❌ | | +| http | ContainerGroupProbeHttp | ❌ | | +| grpc | ContainerGroupProbeGrpc | ❌ | | +| exec | ContainerGroupProbeExec | ❌ | | diff --git a/documentation/models/ContainerGroupStartupProbe.md b/documentation/models/ContainerGroupStartupProbe.md index 189a060..7706dbc 100644 --- a/documentation/models/ContainerGroupStartupProbe.md +++ b/documentation/models/ContainerGroupStartupProbe.md @@ -4,14 +4,14 @@ Represents the container group startup probe **Properties** -| Name | Type | Required | Description | -| :------------------ | :------------------------ | :------- | :---------- | -| initialDelaySeconds | `number` | ✅ | | -| periodSeconds | `number` | ✅ | | -| timeoutSeconds | `number` | ✅ | | -| successThreshold | `number` | ✅ | | -| failureThreshold | `number` | ✅ | | -| tcp | `ContainerGroupProbeTcp` | ❌ | | -| http | `ContainerGroupProbeHttp` | ❌ | | -| grpc | `ContainerGroupProbeGrpc` | ❌ | | -| exec | `ContainerGroupProbeExec` | ❌ | | +| Name | Type | Required | Description | +| :------------------ | :---------------------- | :------- | :---------- | +| initialDelaySeconds | number | ✅ | | +| periodSeconds | number | ✅ | | +| timeoutSeconds | number | ✅ | | +| successThreshold | number | ✅ | | +| failureThreshold | number | ✅ | | +| tcp | ContainerGroupProbeTcp | ❌ | | +| http | ContainerGroupProbeHttp | ❌ | | +| grpc | ContainerGroupProbeGrpc | ❌ | | +| exec | ContainerGroupProbeExec | ❌ | | diff --git a/documentation/models/ContainerGroupState.md b/documentation/models/ContainerGroupState.md index bf7c223..2c7bdb2 100644 --- a/documentation/models/ContainerGroupState.md +++ b/documentation/models/ContainerGroupState.md @@ -4,10 +4,10 @@ Represents a container group state **Properties** -| Name | Type | Required | Description | -| :------------------- | :---------------------------------- | :------- | :------------------------------------------------- | -| status | `ContainerGroupStatus` | ✅ | | -| startTime | `string` | ✅ | | -| finishTime | `string` | ✅ | | -| instanceStatusCounts | `ContainerGroupInstanceStatusCount` | ✅ | Represents a container group instance status count | -| description | `string` | ❌ | | +| Name | Type | Required | Description | +| :------------------- | :-------------------------------- | :------- | :------------------------------------------------- | +| status | ContainerGroupStatus | ✅ | | +| startTime | string | ✅ | | +| finishTime | string | ✅ | | +| instanceStatusCounts | ContainerGroupInstanceStatusCount | ✅ | Represents a container group instance status count | +| description | string | ❌ | | diff --git a/documentation/models/ContainerGroupStatus.md b/documentation/models/ContainerGroupStatus.md index c46576e..951323d 100644 --- a/documentation/models/ContainerGroupStatus.md +++ b/documentation/models/ContainerGroupStatus.md @@ -2,11 +2,11 @@ **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :---------- | -| PENDING | `string` | ✅ | "pending" | -| RUNNING | `string` | ✅ | "running" | -| STOPPED | `string` | ✅ | "stopped" | -| SUCCEEDED | `string` | ✅ | "succeeded" | -| FAILED | `string` | ✅ | "failed" | -| DEPLOYING | `string` | ✅ | "deploying" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :---------- | +| PENDING | string | ✅ | "pending" | +| RUNNING | string | ✅ | "running" | +| STOPPED | string | ✅ | "stopped" | +| SUCCEEDED | string | ✅ | "succeeded" | +| FAILED | string | ✅ | "failed" | +| DEPLOYING | string | ✅ | "deploying" | diff --git a/documentation/models/ContainerGroupsQuotas.md b/documentation/models/ContainerGroupsQuotas.md index 0b68341..4fe27d9 100644 --- a/documentation/models/ContainerGroupsQuotas.md +++ b/documentation/models/ContainerGroupsQuotas.md @@ -2,10 +2,10 @@ **Properties** -| Name | Type | Required | Description | -| :-------------------------------------- | :------- | :------- | :---------- | -| maxCreatedContainerGroups | `number` | ✅ | | -| containerInstanceQuota | `number` | ✅ | | -| maxContainerGroupReallocationsPerMinute | `number` | ❌ | | -| maxContainerGroupRecreatesPerMinute | `number` | ❌ | | -| maxContainerGroupRestartsPerMinute | `number` | ❌ | | +| Name | Type | Required | Description | +| :-------------------------------------- | :----- | :------- | :---------- | +| maxCreatedContainerGroups | number | ✅ | | +| containerInstanceQuota | number | ✅ | | +| maxContainerGroupReallocationsPerMinute | number | ❌ | | +| maxContainerGroupRecreatesPerMinute | number | ❌ | | +| maxContainerGroupRestartsPerMinute | number | ❌ | | diff --git a/documentation/models/ContainerNetworkingProtocol.md b/documentation/models/ContainerNetworkingProtocol.md index f79398f..a8a9f17 100644 --- a/documentation/models/ContainerNetworkingProtocol.md +++ b/documentation/models/ContainerNetworkingProtocol.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| HTTP | `string` | ✅ | "http" | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| HTTP | string | ✅ | "http" | diff --git a/documentation/models/ContainerProbeHttpScheme.md b/documentation/models/ContainerProbeHttpScheme.md index efd6bb5..0aef268 100644 --- a/documentation/models/ContainerProbeHttpScheme.md +++ b/documentation/models/ContainerProbeHttpScheme.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| HTTP | `string` | ✅ | "http" | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| HTTP | string | ✅ | "http" | diff --git a/documentation/models/ContainerResourceRequirements.md b/documentation/models/ContainerResourceRequirements.md index a8d12e0..06341b1 100644 --- a/documentation/models/ContainerResourceRequirements.md +++ b/documentation/models/ContainerResourceRequirements.md @@ -4,9 +4,9 @@ Represents a container resource requirements **Properties** -| Name | Type | Required | Description | -| :------------ | :--------- | :------- | :---------- | -| cpu | `number` | ✅ | | -| memory | `number` | ✅ | | -| gpuClasses | `string[]` | ❌ | | -| storageAmount | `number` | ❌ | | +| Name | Type | Required | Description | +| :------------ | :------- | :------- | :---------- | +| cpu | number | ✅ | | +| memory | number | ✅ | | +| gpuClasses | string[] | ❌ | | +| storageAmount | number | ❌ | | diff --git a/documentation/models/ContainerRestartPolicy.md b/documentation/models/ContainerRestartPolicy.md index b92cfa9..62ff6d3 100644 --- a/documentation/models/ContainerRestartPolicy.md +++ b/documentation/models/ContainerRestartPolicy.md @@ -2,8 +2,8 @@ **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :----------- | -| ALWAYS | `string` | ✅ | "always" | -| ONFAILURE | `string` | ✅ | "on_failure" | -| NEVER | `string` | ✅ | "never" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :----------- | +| ALWAYS | string | ✅ | "always" | +| ONFAILURE | string | ✅ | "on_failure" | +| NEVER | string | ✅ | "never" | diff --git a/documentation/models/CountryCode.md b/documentation/models/CountryCode.md index 065f8df..77635e4 100644 --- a/documentation/models/CountryCode.md +++ b/documentation/models/CountryCode.md @@ -2,254 +2,254 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| AF | `string` | ✅ | "af" | -| AL | `string` | ✅ | "al" | -| DZ | `string` | ✅ | "dz" | -| AS\_ | `string` | ✅ | "as" | -| AD | `string` | ✅ | "ad" | -| AO | `string` | ✅ | "ao" | -| AI | `string` | ✅ | "ai" | -| AQ | `string` | ✅ | "aq" | -| AG | `string` | ✅ | "ag" | -| AR | `string` | ✅ | "ar" | -| AM | `string` | ✅ | "am" | -| AW | `string` | ✅ | "aw" | -| AU | `string` | ✅ | "au" | -| AT | `string` | ✅ | "at" | -| AZ | `string` | ✅ | "az" | -| BS | `string` | ✅ | "bs" | -| BH | `string` | ✅ | "bh" | -| BD | `string` | ✅ | "bd" | -| BB | `string` | ✅ | "bb" | -| BY | `string` | ✅ | "by" | -| BE | `string` | ✅ | "be" | -| BZ | `string` | ✅ | "bz" | -| BJ | `string` | ✅ | "bj" | -| BM | `string` | ✅ | "bm" | -| BT | `string` | ✅ | "bt" | -| BO | `string` | ✅ | "bo" | -| BQ | `string` | ✅ | "bq" | -| BA | `string` | ✅ | "ba" | -| BW | `string` | ✅ | "bw" | -| BV | `string` | ✅ | "bv" | -| BR | `string` | ✅ | "br" | -| IO | `string` | ✅ | "io" | -| BN | `string` | ✅ | "bn" | -| BG | `string` | ✅ | "bg" | -| BF | `string` | ✅ | "bf" | -| BI | `string` | ✅ | "bi" | -| CV | `string` | ✅ | "cv" | -| KH | `string` | ✅ | "kh" | -| CM | `string` | ✅ | "cm" | -| CA | `string` | ✅ | "ca" | -| KY | `string` | ✅ | "ky" | -| CF | `string` | ✅ | "cf" | -| TD | `string` | ✅ | "td" | -| CL | `string` | ✅ | "cl" | -| CN | `string` | ✅ | "cn" | -| CX | `string` | ✅ | "cx" | -| CC | `string` | ✅ | "cc" | -| CO | `string` | ✅ | "co" | -| KM | `string` | ✅ | "km" | -| CD | `string` | ✅ | "cd" | -| CG | `string` | ✅ | "cg" | -| CK | `string` | ✅ | "ck" | -| CR | `string` | ✅ | "cr" | -| HR | `string` | ✅ | "hr" | -| CU | `string` | ✅ | "cu" | -| CW | `string` | ✅ | "cw" | -| CY | `string` | ✅ | "cy" | -| CZ | `string` | ✅ | "cz" | -| CI | `string` | ✅ | "ci" | -| DK | `string` | ✅ | "dk" | -| DJ | `string` | ✅ | "dj" | -| DM | `string` | ✅ | "dm" | -| DO\_ | `string` | ✅ | "do" | -| EC | `string` | ✅ | "ec" | -| EG | `string` | ✅ | "eg" | -| SV | `string` | ✅ | "sv" | -| GQ | `string` | ✅ | "gq" | -| ER | `string` | ✅ | "er" | -| EE | `string` | ✅ | "ee" | -| SZ | `string` | ✅ | "sz" | -| ET | `string` | ✅ | "et" | -| FK | `string` | ✅ | "fk" | -| FO | `string` | ✅ | "fo" | -| FJ | `string` | ✅ | "fj" | -| FI | `string` | ✅ | "fi" | -| FR | `string` | ✅ | "fr" | -| GF | `string` | ✅ | "gf" | -| PF | `string` | ✅ | "pf" | -| TF | `string` | ✅ | "tf" | -| GA | `string` | ✅ | "ga" | -| GM | `string` | ✅ | "gm" | -| GE | `string` | ✅ | "ge" | -| DE | `string` | ✅ | "de" | -| GH | `string` | ✅ | "gh" | -| GI | `string` | ✅ | "gi" | -| GR | `string` | ✅ | "gr" | -| GL | `string` | ✅ | "gl" | -| GD | `string` | ✅ | "gd" | -| GP | `string` | ✅ | "gp" | -| GU | `string` | ✅ | "gu" | -| GT | `string` | ✅ | "gt" | -| GG | `string` | ✅ | "gg" | -| GN | `string` | ✅ | "gn" | -| GW | `string` | ✅ | "gw" | -| GY | `string` | ✅ | "gy" | -| HT | `string` | ✅ | "ht" | -| HM | `string` | ✅ | "hm" | -| VA | `string` | ✅ | "va" | -| HN | `string` | ✅ | "hn" | -| HK | `string` | ✅ | "hk" | -| HU | `string` | ✅ | "hu" | -| IS | `string` | ✅ | "is" | -| IN\_ | `string` | ✅ | "in" | -| ID | `string` | ✅ | "id" | -| IR | `string` | ✅ | "ir" | -| IQ | `string` | ✅ | "iq" | -| IE | `string` | ✅ | "ie" | -| IM | `string` | ✅ | "im" | -| IL | `string` | ✅ | "il" | -| IT | `string` | ✅ | "it" | -| JM | `string` | ✅ | "jm" | -| JP | `string` | ✅ | "jp" | -| JE | `string` | ✅ | "je" | -| JO | `string` | ✅ | "jo" | -| KZ | `string` | ✅ | "kz" | -| KE | `string` | ✅ | "ke" | -| KI | `string` | ✅ | "ki" | -| KP | `string` | ✅ | "kp" | -| KR | `string` | ✅ | "kr" | -| KW | `string` | ✅ | "kw" | -| KG | `string` | ✅ | "kg" | -| LA | `string` | ✅ | "la" | -| LV | `string` | ✅ | "lv" | -| LB | `string` | ✅ | "lb" | -| LS | `string` | ✅ | "ls" | -| LR | `string` | ✅ | "lr" | -| LY | `string` | ✅ | "ly" | -| LI | `string` | ✅ | "li" | -| LT | `string` | ✅ | "lt" | -| LU | `string` | ✅ | "lu" | -| MO | `string` | ✅ | "mo" | -| MG | `string` | ✅ | "mg" | -| MW | `string` | ✅ | "mw" | -| MY | `string` | ✅ | "my" | -| MV | `string` | ✅ | "mv" | -| ML | `string` | ✅ | "ml" | -| MT | `string` | ✅ | "mt" | -| MH | `string` | ✅ | "mh" | -| MQ | `string` | ✅ | "mq" | -| MR | `string` | ✅ | "mr" | -| MU | `string` | ✅ | "mu" | -| YT | `string` | ✅ | "yt" | -| MX | `string` | ✅ | "mx" | -| FM | `string` | ✅ | "fm" | -| MD | `string` | ✅ | "md" | -| MC | `string` | ✅ | "mc" | -| MN | `string` | ✅ | "mn" | -| ME | `string` | ✅ | "me" | -| MS | `string` | ✅ | "ms" | -| MA | `string` | ✅ | "ma" | -| MZ | `string` | ✅ | "mz" | -| MM | `string` | ✅ | "mm" | -| NA | `string` | ✅ | "na" | -| NR | `string` | ✅ | "nr" | -| NP | `string` | ✅ | "np" | -| NL | `string` | ✅ | "nl" | -| NC | `string` | ✅ | "nc" | -| NZ | `string` | ✅ | "nz" | -| NI | `string` | ✅ | "ni" | -| NE | `string` | ✅ | "ne" | -| NG | `string` | ✅ | "ng" | -| NU | `string` | ✅ | "nu" | -| NF | `string` | ✅ | "nf" | -| MP | `string` | ✅ | "mp" | -| NO | `string` | ✅ | "no" | -| OM | `string` | ✅ | "om" | -| PK | `string` | ✅ | "pk" | -| PW | `string` | ✅ | "pw" | -| PS | `string` | ✅ | "ps" | -| PA | `string` | ✅ | "pa" | -| PG | `string` | ✅ | "pg" | -| PY | `string` | ✅ | "py" | -| PE | `string` | ✅ | "pe" | -| PH | `string` | ✅ | "ph" | -| PN | `string` | ✅ | "pn" | -| PL | `string` | ✅ | "pl" | -| PT | `string` | ✅ | "pt" | -| PR | `string` | ✅ | "pr" | -| QA | `string` | ✅ | "qa" | -| MK | `string` | ✅ | "mk" | -| RO | `string` | ✅ | "ro" | -| RU | `string` | ✅ | "ru" | -| RW | `string` | ✅ | "rw" | -| RE | `string` | ✅ | "re" | -| BL | `string` | ✅ | "bl" | -| SH | `string` | ✅ | "sh" | -| KN | `string` | ✅ | "kn" | -| LC | `string` | ✅ | "lc" | -| MF | `string` | ✅ | "mf" | -| PM | `string` | ✅ | "pm" | -| VC | `string` | ✅ | "vc" | -| WS | `string` | ✅ | "ws" | -| SM | `string` | ✅ | "sm" | -| ST | `string` | ✅ | "st" | -| SA | `string` | ✅ | "sa" | -| SN | `string` | ✅ | "sn" | -| RS | `string` | ✅ | "rs" | -| SC | `string` | ✅ | "sc" | -| SL | `string` | ✅ | "sl" | -| SG | `string` | ✅ | "sg" | -| SX | `string` | ✅ | "sx" | -| SK | `string` | ✅ | "sk" | -| SI | `string` | ✅ | "si" | -| SB | `string` | ✅ | "sb" | -| SO | `string` | ✅ | "so" | -| ZA | `string` | ✅ | "za" | -| GS | `string` | ✅ | "gs" | -| SS | `string` | ✅ | "ss" | -| ES | `string` | ✅ | "es" | -| LK | `string` | ✅ | "lk" | -| SD | `string` | ✅ | "sd" | -| SR | `string` | ✅ | "sr" | -| SJ | `string` | ✅ | "sj" | -| SE | `string` | ✅ | "se" | -| CH | `string` | ✅ | "ch" | -| SY | `string` | ✅ | "sy" | -| TW | `string` | ✅ | "tw" | -| TJ | `string` | ✅ | "tj" | -| TZ | `string` | ✅ | "tz" | -| TH | `string` | ✅ | "th" | -| TL | `string` | ✅ | "tl" | -| TG | `string` | ✅ | "tg" | -| TK | `string` | ✅ | "tk" | -| TO | `string` | ✅ | "to" | -| TT | `string` | ✅ | "tt" | -| TN | `string` | ✅ | "tn" | -| TR | `string` | ✅ | "tr" | -| TM | `string` | ✅ | "tm" | -| TC | `string` | ✅ | "tc" | -| TV | `string` | ✅ | "tv" | -| UG | `string` | ✅ | "ug" | -| UA | `string` | ✅ | "ua" | -| AE | `string` | ✅ | "ae" | -| GB | `string` | ✅ | "gb" | -| UM | `string` | ✅ | "um" | -| US | `string` | ✅ | "us" | -| UY | `string` | ✅ | "uy" | -| UZ | `string` | ✅ | "uz" | -| VU | `string` | ✅ | "vu" | -| VE | `string` | ✅ | "ve" | -| VN | `string` | ✅ | "vn" | -| VG | `string` | ✅ | "vg" | -| VI | `string` | ✅ | "vi" | -| WF | `string` | ✅ | "wf" | -| EH | `string` | ✅ | "eh" | -| YE | `string` | ✅ | "ye" | -| ZM | `string` | ✅ | "zm" | -| ZW | `string` | ✅ | "zw" | -| AX | `string` | ✅ | "ax" | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| AF | string | ✅ | "af" | +| AL | string | ✅ | "al" | +| DZ | string | ✅ | "dz" | +| AS\_ | string | ✅ | "as" | +| AD | string | ✅ | "ad" | +| AO | string | ✅ | "ao" | +| AI | string | ✅ | "ai" | +| AQ | string | ✅ | "aq" | +| AG | string | ✅ | "ag" | +| AR | string | ✅ | "ar" | +| AM | string | ✅ | "am" | +| AW | string | ✅ | "aw" | +| AU | string | ✅ | "au" | +| AT | string | ✅ | "at" | +| AZ | string | ✅ | "az" | +| BS | string | ✅ | "bs" | +| BH | string | ✅ | "bh" | +| BD | string | ✅ | "bd" | +| BB | string | ✅ | "bb" | +| BY | string | ✅ | "by" | +| BE | string | ✅ | "be" | +| BZ | string | ✅ | "bz" | +| BJ | string | ✅ | "bj" | +| BM | string | ✅ | "bm" | +| BT | string | ✅ | "bt" | +| BO | string | ✅ | "bo" | +| BQ | string | ✅ | "bq" | +| BA | string | ✅ | "ba" | +| BW | string | ✅ | "bw" | +| BV | string | ✅ | "bv" | +| BR | string | ✅ | "br" | +| IO | string | ✅ | "io" | +| BN | string | ✅ | "bn" | +| BG | string | ✅ | "bg" | +| BF | string | ✅ | "bf" | +| BI | string | ✅ | "bi" | +| CV | string | ✅ | "cv" | +| KH | string | ✅ | "kh" | +| CM | string | ✅ | "cm" | +| CA | string | ✅ | "ca" | +| KY | string | ✅ | "ky" | +| CF | string | ✅ | "cf" | +| TD | string | ✅ | "td" | +| CL | string | ✅ | "cl" | +| CN | string | ✅ | "cn" | +| CX | string | ✅ | "cx" | +| CC | string | ✅ | "cc" | +| CO | string | ✅ | "co" | +| KM | string | ✅ | "km" | +| CD | string | ✅ | "cd" | +| CG | string | ✅ | "cg" | +| CK | string | ✅ | "ck" | +| CR | string | ✅ | "cr" | +| HR | string | ✅ | "hr" | +| CU | string | ✅ | "cu" | +| CW | string | ✅ | "cw" | +| CY | string | ✅ | "cy" | +| CZ | string | ✅ | "cz" | +| CI | string | ✅ | "ci" | +| DK | string | ✅ | "dk" | +| DJ | string | ✅ | "dj" | +| DM | string | ✅ | "dm" | +| DO\_ | string | ✅ | "do" | +| EC | string | ✅ | "ec" | +| EG | string | ✅ | "eg" | +| SV | string | ✅ | "sv" | +| GQ | string | ✅ | "gq" | +| ER | string | ✅ | "er" | +| EE | string | ✅ | "ee" | +| SZ | string | ✅ | "sz" | +| ET | string | ✅ | "et" | +| FK | string | ✅ | "fk" | +| FO | string | ✅ | "fo" | +| FJ | string | ✅ | "fj" | +| FI | string | ✅ | "fi" | +| FR | string | ✅ | "fr" | +| GF | string | ✅ | "gf" | +| PF | string | ✅ | "pf" | +| TF | string | ✅ | "tf" | +| GA | string | ✅ | "ga" | +| GM | string | ✅ | "gm" | +| GE | string | ✅ | "ge" | +| DE | string | ✅ | "de" | +| GH | string | ✅ | "gh" | +| GI | string | ✅ | "gi" | +| GR | string | ✅ | "gr" | +| GL | string | ✅ | "gl" | +| GD | string | ✅ | "gd" | +| GP | string | ✅ | "gp" | +| GU | string | ✅ | "gu" | +| GT | string | ✅ | "gt" | +| GG | string | ✅ | "gg" | +| GN | string | ✅ | "gn" | +| GW | string | ✅ | "gw" | +| GY | string | ✅ | "gy" | +| HT | string | ✅ | "ht" | +| HM | string | ✅ | "hm" | +| VA | string | ✅ | "va" | +| HN | string | ✅ | "hn" | +| HK | string | ✅ | "hk" | +| HU | string | ✅ | "hu" | +| IS | string | ✅ | "is" | +| IN\_ | string | ✅ | "in" | +| ID | string | ✅ | "id" | +| IR | string | ✅ | "ir" | +| IQ | string | ✅ | "iq" | +| IE | string | ✅ | "ie" | +| IM | string | ✅ | "im" | +| IL | string | ✅ | "il" | +| IT | string | ✅ | "it" | +| JM | string | ✅ | "jm" | +| JP | string | ✅ | "jp" | +| JE | string | ✅ | "je" | +| JO | string | ✅ | "jo" | +| KZ | string | ✅ | "kz" | +| KE | string | ✅ | "ke" | +| KI | string | ✅ | "ki" | +| KP | string | ✅ | "kp" | +| KR | string | ✅ | "kr" | +| KW | string | ✅ | "kw" | +| KG | string | ✅ | "kg" | +| LA | string | ✅ | "la" | +| LV | string | ✅ | "lv" | +| LB | string | ✅ | "lb" | +| LS | string | ✅ | "ls" | +| LR | string | ✅ | "lr" | +| LY | string | ✅ | "ly" | +| LI | string | ✅ | "li" | +| LT | string | ✅ | "lt" | +| LU | string | ✅ | "lu" | +| MO | string | ✅ | "mo" | +| MG | string | ✅ | "mg" | +| MW | string | ✅ | "mw" | +| MY | string | ✅ | "my" | +| MV | string | ✅ | "mv" | +| ML | string | ✅ | "ml" | +| MT | string | ✅ | "mt" | +| MH | string | ✅ | "mh" | +| MQ | string | ✅ | "mq" | +| MR | string | ✅ | "mr" | +| MU | string | ✅ | "mu" | +| YT | string | ✅ | "yt" | +| MX | string | ✅ | "mx" | +| FM | string | ✅ | "fm" | +| MD | string | ✅ | "md" | +| MC | string | ✅ | "mc" | +| MN | string | ✅ | "mn" | +| ME | string | ✅ | "me" | +| MS | string | ✅ | "ms" | +| MA | string | ✅ | "ma" | +| MZ | string | ✅ | "mz" | +| MM | string | ✅ | "mm" | +| NA | string | ✅ | "na" | +| NR | string | ✅ | "nr" | +| NP | string | ✅ | "np" | +| NL | string | ✅ | "nl" | +| NC | string | ✅ | "nc" | +| NZ | string | ✅ | "nz" | +| NI | string | ✅ | "ni" | +| NE | string | ✅ | "ne" | +| NG | string | ✅ | "ng" | +| NU | string | ✅ | "nu" | +| NF | string | ✅ | "nf" | +| MP | string | ✅ | "mp" | +| NO | string | ✅ | "no" | +| OM | string | ✅ | "om" | +| PK | string | ✅ | "pk" | +| PW | string | ✅ | "pw" | +| PS | string | ✅ | "ps" | +| PA | string | ✅ | "pa" | +| PG | string | ✅ | "pg" | +| PY | string | ✅ | "py" | +| PE | string | ✅ | "pe" | +| PH | string | ✅ | "ph" | +| PN | string | ✅ | "pn" | +| PL | string | ✅ | "pl" | +| PT | string | ✅ | "pt" | +| PR | string | ✅ | "pr" | +| QA | string | ✅ | "qa" | +| MK | string | ✅ | "mk" | +| RO | string | ✅ | "ro" | +| RU | string | ✅ | "ru" | +| RW | string | ✅ | "rw" | +| RE | string | ✅ | "re" | +| BL | string | ✅ | "bl" | +| SH | string | ✅ | "sh" | +| KN | string | ✅ | "kn" | +| LC | string | ✅ | "lc" | +| MF | string | ✅ | "mf" | +| PM | string | ✅ | "pm" | +| VC | string | ✅ | "vc" | +| WS | string | ✅ | "ws" | +| SM | string | ✅ | "sm" | +| ST | string | ✅ | "st" | +| SA | string | ✅ | "sa" | +| SN | string | ✅ | "sn" | +| RS | string | ✅ | "rs" | +| SC | string | ✅ | "sc" | +| SL | string | ✅ | "sl" | +| SG | string | ✅ | "sg" | +| SX | string | ✅ | "sx" | +| SK | string | ✅ | "sk" | +| SI | string | ✅ | "si" | +| SB | string | ✅ | "sb" | +| SO | string | ✅ | "so" | +| ZA | string | ✅ | "za" | +| GS | string | ✅ | "gs" | +| SS | string | ✅ | "ss" | +| ES | string | ✅ | "es" | +| LK | string | ✅ | "lk" | +| SD | string | ✅ | "sd" | +| SR | string | ✅ | "sr" | +| SJ | string | ✅ | "sj" | +| SE | string | ✅ | "se" | +| CH | string | ✅ | "ch" | +| SY | string | ✅ | "sy" | +| TW | string | ✅ | "tw" | +| TJ | string | ✅ | "tj" | +| TZ | string | ✅ | "tz" | +| TH | string | ✅ | "th" | +| TL | string | ✅ | "tl" | +| TG | string | ✅ | "tg" | +| TK | string | ✅ | "tk" | +| TO | string | ✅ | "to" | +| TT | string | ✅ | "tt" | +| TN | string | ✅ | "tn" | +| TR | string | ✅ | "tr" | +| TM | string | ✅ | "tm" | +| TC | string | ✅ | "tc" | +| TV | string | ✅ | "tv" | +| UG | string | ✅ | "ug" | +| UA | string | ✅ | "ua" | +| AE | string | ✅ | "ae" | +| GB | string | ✅ | "gb" | +| UM | string | ✅ | "um" | +| US | string | ✅ | "us" | +| UY | string | ✅ | "uy" | +| UZ | string | ✅ | "uz" | +| VU | string | ✅ | "vu" | +| VE | string | ✅ | "ve" | +| VN | string | ✅ | "vn" | +| VG | string | ✅ | "vg" | +| VI | string | ✅ | "vi" | +| WF | string | ✅ | "wf" | +| EH | string | ✅ | "eh" | +| YE | string | ✅ | "ye" | +| ZM | string | ✅ | "zm" | +| ZW | string | ✅ | "zw" | +| AX | string | ✅ | "ax" | diff --git a/documentation/models/CreateContainer.md b/documentation/models/CreateContainer.md index 7b0af32..0d2313e 100644 --- a/documentation/models/CreateContainer.md +++ b/documentation/models/CreateContainer.md @@ -4,178 +4,178 @@ Represents a container **Properties** -| Name | Type | Required | Description | -| :--------------------- | :-------------------------------------- | :------- | :----------------------------------------------------------------------------------------------- | -| image | `string` | ✅ | | -| resources | `ContainerResourceRequirements` | ✅ | Represents a container resource requirements | -| command | `string[]` | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | -| priority | `ContainerGroupPriority` | ❌ | | -| environmentVariables | `any` | ❌ | | -| logging | `CreateContainerLogging` | ❌ | | -| registryAuthentication | `CreateContainerRegistryAuthentication` | ❌ | | +| Name | Type | Required | Description | +| :--------------------- | :------------------------------------ | :------- | :----------------------------------------------------------------------------------------------- | +| image | string | ✅ | | +| resources | ContainerResourceRequirements | ✅ | Represents a container resource requirements | +| command | string[] | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | +| priority | ContainerGroupPriority | ❌ | | +| environmentVariables | any | ❌ | | +| logging | CreateContainerLogging | ❌ | | +| registryAuthentication | CreateContainerRegistryAuthentication | ❌ | | # CreateContainerLogging **Properties** -| Name | Type | Required | Description | -| :------- | :----------------- | :------- | :---------- | -| axiom | `LoggingAxiom2` | ❌ | | -| datadog | `LoggingDatadog2` | ❌ | | -| newRelic | `LoggingNewRelic2` | ❌ | | -| splunk | `LoggingSplunk2` | ❌ | | -| tcp | `LoggingTcp2` | ❌ | | -| http | `LoggingHttp2` | ❌ | | +| Name | Type | Required | Description | +| :------- | :--------------- | :------- | :---------- | +| axiom | LoggingAxiom2 | ❌ | | +| datadog | LoggingDatadog2 | ❌ | | +| newRelic | LoggingNewRelic2 | ❌ | | +| splunk | LoggingSplunk2 | ❌ | | +| tcp | LoggingTcp2 | ❌ | | +| http | LoggingHttp2 | ❌ | | # LoggingAxiom2 **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| apiToken | `string` | ✅ | | -| dataset | `string` | ✅ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :---------- | +| host | string | ✅ | | +| apiToken | string | ✅ | | +| dataset | string | ✅ | | # LoggingDatadog2 **Properties** -| Name | Type | Required | Description | -| :----- | :--------------- | :------- | :---------- | -| host | `string` | ✅ | | -| apiKey | `string` | ✅ | | -| tags | `DatadogTags2[]` | ❌ | | +| Name | Type | Required | Description | +| :----- | :------------- | :------- | :---------- | +| host | string | ✅ | | +| apiKey | string | ✅ | | +| tags | DatadogTags2[] | ❌ | | # DatadogTags2 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | # LoggingNewRelic2 **Properties** -| Name | Type | Required | Description | -| :----------- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| ingestionKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :----------- | :----- | :------- | :---------- | +| host | string | ✅ | | +| ingestionKey | string | ✅ | | # LoggingSplunk2 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| token | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| host | string | ✅ | | +| token | string | ✅ | | # LoggingTcp2 **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| port | `number` | ✅ | | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| host | string | ✅ | | +| port | number | ✅ | | # LoggingHttp2 **Properties** -| Name | Type | Required | Description | -| :---------- | :----------------- | :------- | :---------- | -| host | `string` | ✅ | | -| port | `number` | ✅ | | -| format | `HttpFormat2` | ✅ | | -| compression | `HttpCompression2` | ✅ | | -| user | `string` | ❌ | | -| password | `string` | ❌ | | -| path | `string` | ❌ | | -| headers | `HttpHeaders3[]` | ❌ | | +| Name | Type | Required | Description | +| :---------- | :--------------- | :------- | :---------- | +| host | string | ✅ | | +| port | number | ✅ | | +| format | HttpFormat2 | ✅ | | +| compression | HttpCompression2 | ✅ | | +| user | string | ❌ | | +| password | string | ❌ | | +| path | string | ❌ | | +| headers | HttpHeaders3[] | ❌ | | # HttpFormat2 **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :----------- | -| JSON | `string` | ✅ | "json" | -| JSONLINES | `string` | ✅ | "json_lines" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :----------- | +| JSON | string | ✅ | "json" | +| JSONLINES | string | ✅ | "json_lines" | # HttpCompression2 **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| NONE | `string` | ✅ | "none" | -| GZIP | `string` | ✅ | "gzip" | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| NONE | string | ✅ | "none" | +| GZIP | string | ✅ | "gzip" | # HttpHeaders3 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | # CreateContainerRegistryAuthentication **Properties** -| Name | Type | Required | Description | -| :-------- | :--------------------------------- | :------- | :---------- | -| basic | `RegistryAuthenticationBasic1` | ❌ | | -| gcpGcr | `RegistryAuthenticationGcpGcr1` | ❌ | | -| awsEcr | `RegistryAuthenticationAwsEcr1` | ❌ | | -| dockerHub | `RegistryAuthenticationDockerHub1` | ❌ | | -| gcpGar | `RegistryAuthenticationGcpGar1` | ❌ | | +| Name | Type | Required | Description | +| :-------- | :------------------------------- | :------- | :---------- | +| basic | RegistryAuthenticationBasic1 | ❌ | | +| gcpGcr | RegistryAuthenticationGcpGcr1 | ❌ | | +| awsEcr | RegistryAuthenticationAwsEcr1 | ❌ | | +| dockerHub | RegistryAuthenticationDockerHub1 | ❌ | | +| gcpGar | RegistryAuthenticationGcpGar1 | ❌ | | # RegistryAuthenticationBasic1 **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :---------- | -| username | `string` | ✅ | | -| password | `string` | ✅ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :---------- | +| username | string | ✅ | | +| password | string | ✅ | | # RegistryAuthenticationGcpGcr1 **Properties** -| Name | Type | Required | Description | -| :--------- | :------- | :------- | :---------- | -| serviceKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :--------- | :----- | :------- | :---------- | +| serviceKey | string | ✅ | | # RegistryAuthenticationAwsEcr1 **Properties** -| Name | Type | Required | Description | -| :-------------- | :------- | :------- | :---------- | -| accessKeyId | `string` | ✅ | | -| secretAccessKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :-------------- | :----- | :------- | :---------- | +| accessKeyId | string | ✅ | | +| secretAccessKey | string | ✅ | | # RegistryAuthenticationDockerHub1 **Properties** -| Name | Type | Required | Description | -| :------------------ | :------- | :------- | :---------- | -| username | `string` | ✅ | | -| personalAccessToken | `string` | ✅ | | +| Name | Type | Required | Description | +| :------------------ | :----- | :------- | :---------- | +| username | string | ✅ | | +| personalAccessToken | string | ✅ | | # RegistryAuthenticationGcpGar1 **Properties** -| Name | Type | Required | Description | -| :--------- | :------- | :------- | :---------- | -| serviceKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :--------- | :----- | :------- | :---------- | +| serviceKey | string | ✅ | | diff --git a/documentation/models/CreateContainerGroup.md b/documentation/models/CreateContainerGroup.md index 964adc6..35e5136 100644 --- a/documentation/models/CreateContainerGroup.md +++ b/documentation/models/CreateContainerGroup.md @@ -4,18 +4,18 @@ Represents a request to create a container group **Properties** -| Name | Type | Required | Description | -| :-------------- | :------------------------------- | :------- | :---------------------------------------------------------------------------------------------- | -| name | `string` | ✅ | | -| container | `CreateContainer` | ✅ | Represents a container | -| autostartPolicy | `boolean` | ✅ | | -| restartPolicy | `ContainerRestartPolicy` | ✅ | | -| replicas | `number` | ✅ | | -| displayName | `string` | ❌ | | -| countryCodes | `CountryCode[]` | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. | -| networking | `CreateContainerGroupNetworking` | ❌ | Represents container group networking parameters | -| livenessProbe | `ContainerGroupLivenessProbe` | ❌ | Represents the container group liveness probe | -| readinessProbe | `ContainerGroupReadinessProbe` | ❌ | Represents the container group readiness probe | -| startupProbe | `ContainerGroupStartupProbe` | ❌ | Represents the container group startup probe | -| queueConnection | `ContainerGroupQueueConnection` | ❌ | Represents container group queue connection | -| queueAutoscaler | `QueueAutoscaler` | ❌ | Represents the autoscaling rules for a queue | +| Name | Type | Required | Description | +| :-------------- | :----------------------------- | :------- | :---------------------------------------------------------------------------------------------- | +| name | string | ✅ | | +| container | CreateContainer | ✅ | Represents a container | +| autostartPolicy | boolean | ✅ | | +| restartPolicy | ContainerRestartPolicy | ✅ | | +| replicas | number | ✅ | | +| displayName | string | ❌ | | +| countryCodes | CountryCode[] | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. | +| networking | CreateContainerGroupNetworking | ❌ | Represents container group networking parameters | +| livenessProbe | ContainerGroupLivenessProbe | ❌ | Represents the container group liveness probe | +| readinessProbe | ContainerGroupReadinessProbe | ❌ | Represents the container group readiness probe | +| startupProbe | ContainerGroupStartupProbe | ❌ | Represents the container group startup probe | +| queueConnection | ContainerGroupQueueConnection | ❌ | Represents container group queue connection | +| queueAutoscaler | QueueAutoscaler | ❌ | Represents the autoscaling rules for a queue | diff --git a/documentation/models/CreateContainerGroupNetworking.md b/documentation/models/CreateContainerGroupNetworking.md index 61ce83f..8a670a8 100644 --- a/documentation/models/CreateContainerGroupNetworking.md +++ b/documentation/models/CreateContainerGroupNetworking.md @@ -4,8 +4,8 @@ Represents container group networking parameters **Properties** -| Name | Type | Required | Description | -| :------- | :---------------------------- | :------- | :---------- | -| protocol | `ContainerNetworkingProtocol` | ✅ | | -| port | `number` | ✅ | | -| auth | `boolean` | ✅ | | +| Name | Type | Required | Description | +| :------- | :-------------------------- | :------- | :---------- | +| protocol | ContainerNetworkingProtocol | ✅ | | +| port | number | ✅ | | +| auth | boolean | ✅ | | diff --git a/documentation/models/CreateInferenceEndpointJob.md b/documentation/models/CreateInferenceEndpointJob.md index 09dfe30..7ddeb9f 100644 --- a/documentation/models/CreateInferenceEndpointJob.md +++ b/documentation/models/CreateInferenceEndpointJob.md @@ -4,8 +4,8 @@ Represents a request to create a inference endpoint job **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :------------------------------------ | -| input | `any` | ✅ | The job input. May be any valid JSON. | -| metadata | `any` | ❌ | | -| webhook | `string` | ❌ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :------------------------------------ | +| input | any | ✅ | The job input. May be any valid JSON. | +| metadata | any | ❌ | | +| webhook | string | ❌ | | diff --git a/documentation/models/CreateQueue.md b/documentation/models/CreateQueue.md index 75b1d18..2727e5b 100644 --- a/documentation/models/CreateQueue.md +++ b/documentation/models/CreateQueue.md @@ -4,8 +4,8 @@ Represents a request to create a new queue. **Properties** -| Name | Type | Required | Description | -| :---------- | :------- | :------- | :------------------------------------------------------------------------------------------- | -| name | `string` | ✅ | The queue name. This must be unique within the project. | -| displayName | `string` | ❌ | The display name. This may be used as a more human-readable name. | -| description | `string` | ❌ | The description. This may be used as a space for notes or other information about the queue. | +| Name | Type | Required | Description | +| :---------- | :----- | :------- | :------------------------------------------------------------------------------------------- | +| name | string | ✅ | The queue name. This must be unique within the project. | +| displayName | string | ❌ | The display name. This may be used as a more human-readable name. | +| description | string | ❌ | The description. This may be used as a space for notes or other information about the queue. | diff --git a/documentation/models/CreateQueueJob.md b/documentation/models/CreateQueueJob.md index 0e4afec..e92d726 100644 --- a/documentation/models/CreateQueueJob.md +++ b/documentation/models/CreateQueueJob.md @@ -4,8 +4,8 @@ Represents a request to create a queue job **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :------------------------------------ | -| input | `any` | ✅ | The job input. May be any valid JSON. | -| metadata | `any` | ❌ | | -| webhook | `string` | ❌ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :------------------------------------ | +| input | any | ✅ | The job input. May be any valid JSON. | +| metadata | any | ❌ | | +| webhook | string | ❌ | | diff --git a/documentation/models/GpuClass.md b/documentation/models/GpuClass.md index 4e5c5e4..ad15fc6 100644 --- a/documentation/models/GpuClass.md +++ b/documentation/models/GpuClass.md @@ -4,9 +4,9 @@ Represents a GPU Class **Properties** -| Name | Type | Required | Description | -| :----------- | :---------------- | :------- | :--------------------------------------------------- | -| id | `string` | ✅ | The unique identifier | -| name | `string` | ✅ | The GPU class name | -| prices | `GpuClassPrice[]` | ✅ | The list of prices for each container group priority | -| isHighDemand | `boolean` | ❌ | Whether the GPU class is in high demand | +| Name | Type | Required | Description | +| :----------- | :-------------- | :------- | :--------------------------------------------------- | +| id | string | ✅ | The unique identifier | +| name | string | ✅ | The GPU class name | +| prices | GpuClassPrice[] | ✅ | The list of prices for each container group priority | +| isHighDemand | boolean | ❌ | Whether the GPU class is in high demand | diff --git a/documentation/models/GpuClassPrice.md b/documentation/models/GpuClassPrice.md index 28324ee..21965ad 100644 --- a/documentation/models/GpuClassPrice.md +++ b/documentation/models/GpuClassPrice.md @@ -4,7 +4,7 @@ Represents the price of a GPU class for a given container group priority **Properties** -| Name | Type | Required | Description | -| :------- | :----------------------- | :------- | :---------- | -| priority | `ContainerGroupPriority` | ✅ | | -| price | `string` | ✅ | The price | +| Name | Type | Required | Description | +| :------- | :--------------------- | :------- | :---------- | +| priority | ContainerGroupPriority | ✅ | | +| price | string | ✅ | The price | diff --git a/documentation/models/GpuClassesList.md b/documentation/models/GpuClassesList.md index 1fbbadb..b231c28 100644 --- a/documentation/models/GpuClassesList.md +++ b/documentation/models/GpuClassesList.md @@ -4,6 +4,6 @@ Represents a list of GPU classes **Properties** -| Name | Type | Required | Description | -| :---- | :----------- | :------- | :---------------------- | -| items | `GpuClass[]` | ✅ | The list of GPU classes | +| Name | Type | Required | Description | +| :---- | :--------- | :------- | :---------------------- | +| items | GpuClass[] | ✅ | The list of GPU classes | diff --git a/documentation/models/InferenceEndpoint.md b/documentation/models/InferenceEndpoint.md index d7912c9..a16e3b0 100644 --- a/documentation/models/InferenceEndpoint.md +++ b/documentation/models/InferenceEndpoint.md @@ -4,13 +4,13 @@ Represents an inference endpoint **Properties** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------- | -| id | `string` | ✅ | The unique identifier | -| name | `string` | ✅ | The inference endpoint name | -| displayName | `string` | ✅ | The inference endpoint display name | -| description | `string` | ✅ | a brief description of the inference endpoint | -| endpointUrl | `string` | ✅ | The URL of the inference endpoint | -| readme | `string` | ✅ | A markdown file containing a detailed description of the inference endpoint | -| priceDescription | `string` | ✅ | A description of the price | -| iconImage | `string` | ✅ | The URL of the icon image | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------- | +| id | string | ✅ | The unique identifier | +| name | string | ✅ | The inference endpoint name | +| displayName | string | ✅ | The inference endpoint display name | +| description | string | ✅ | a brief description of the inference endpoint | +| endpointUrl | string | ✅ | The URL of the inference endpoint | +| readme | string | ✅ | A markdown file containing a detailed description of the inference endpoint | +| priceDescription | string | ✅ | A description of the price | +| iconImage | string | ✅ | The URL of the icon image | diff --git a/documentation/models/InferenceEndpointJob.md b/documentation/models/InferenceEndpointJob.md index 0cf9ec0..9b8fe48 100644 --- a/documentation/models/InferenceEndpointJob.md +++ b/documentation/models/InferenceEndpointJob.md @@ -4,28 +4,28 @@ Represents a inference endpoint job **Properties** -| Name | Type | Required | Description | -| :-------------------- | :---------------------------- | :------- | :------------------------------------- | -| id | `string` | ✅ | | -| input | `any` | ✅ | The job input. May be any valid JSON. | -| inferenceEndpointName | `string` | ✅ | The inference endpoint name | -| status | `InferenceEndpointJobStatus` | ✅ | | -| events | `InferenceEndpointJobEvent[]` | ✅ | | -| organizationName | `string` | ✅ | The organization name | -| createTime | `string` | ✅ | | -| updateTime | `string` | ✅ | | -| metadata | `any` | ❌ | | -| webhook | `string` | ❌ | | -| output | `any` | ❌ | The job output. May be any valid JSON. | +| Name | Type | Required | Description | +| :-------------------- | :-------------------------- | :------- | :------------------------------------- | +| id | string | ✅ | | +| input | any | ✅ | The job input. May be any valid JSON. | +| inferenceEndpointName | string | ✅ | The inference endpoint name | +| status | InferenceEndpointJobStatus | ✅ | | +| events | InferenceEndpointJobEvent[] | ✅ | | +| organizationName | string | ✅ | The organization name | +| createTime | string | ✅ | | +| updateTime | string | ✅ | | +| metadata | any | ❌ | | +| webhook | string | ❌ | | +| output | any | ❌ | The job output. May be any valid JSON. | # InferenceEndpointJobStatus **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :---------- | -| PENDING | `string` | ✅ | "pending" | -| RUNNING | `string` | ✅ | "running" | -| SUCCEEDED | `string` | ✅ | "succeeded" | -| CANCELLED | `string` | ✅ | "cancelled" | -| FAILED | `string` | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :---------- | +| PENDING | string | ✅ | "pending" | +| RUNNING | string | ✅ | "running" | +| SUCCEEDED | string | ✅ | "succeeded" | +| CANCELLED | string | ✅ | "cancelled" | +| FAILED | string | ✅ | "failed" | diff --git a/documentation/models/InferenceEndpointJobEvent.md b/documentation/models/InferenceEndpointJobEvent.md index 869ef6c..fc2e14c 100644 --- a/documentation/models/InferenceEndpointJobEvent.md +++ b/documentation/models/InferenceEndpointJobEvent.md @@ -4,19 +4,19 @@ Represents an event for inference endpoint job **Properties** -| Name | Type | Required | Description | -| :----- | :-------------------------------- | :------- | :---------- | -| action | `InferenceEndpointJobEventAction` | ✅ | | -| time | `string` | ✅ | | +| Name | Type | Required | Description | +| :----- | :------------------------------ | :------- | :---------- | +| action | InferenceEndpointJobEventAction | ✅ | | +| time | string | ✅ | | # InferenceEndpointJobEventAction **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :---------- | -| CREATED | `string` | ✅ | "created" | -| STARTED | `string` | ✅ | "started" | -| SUCCEEDED | `string` | ✅ | "succeeded" | -| CANCELLED | `string` | ✅ | "cancelled" | -| FAILED | `string` | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :---------- | +| CREATED | string | ✅ | "created" | +| STARTED | string | ✅ | "started" | +| SUCCEEDED | string | ✅ | "succeeded" | +| CANCELLED | string | ✅ | "cancelled" | +| FAILED | string | ✅ | "failed" | diff --git a/documentation/models/InferenceEndpointJobList.md b/documentation/models/InferenceEndpointJobList.md index ef13203..d29afd4 100644 --- a/documentation/models/InferenceEndpointJobList.md +++ b/documentation/models/InferenceEndpointJobList.md @@ -4,6 +4,6 @@ Represents a list of inference endpoint jobs **Properties** -| Name | Type | Required | Description | -| :---- | :----------------------- | :------- | :---------------- | -| items | `InferenceEndpointJob[]` | ✅ | The list of items | +| Name | Type | Required | Description | +| :---- | :--------------------- | :------- | :---------------- | +| items | InferenceEndpointJob[] | ✅ | The list of items | diff --git a/documentation/models/InferenceEndpointsList.md b/documentation/models/InferenceEndpointsList.md index b4c82b5..badebb8 100644 --- a/documentation/models/InferenceEndpointsList.md +++ b/documentation/models/InferenceEndpointsList.md @@ -4,6 +4,6 @@ Represents a list of inference endpoints **Properties** -| Name | Type | Required | Description | -| :---- | :-------------------- | :------- | :---------------- | -| items | `InferenceEndpoint[]` | ✅ | The list of items | +| Name | Type | Required | Description | +| :---- | :------------------ | :------- | :---------------- | +| items | InferenceEndpoint[] | ✅ | The list of items | diff --git a/documentation/models/Queue.md b/documentation/models/Queue.md index 90a7902..ea7006e 100644 --- a/documentation/models/Queue.md +++ b/documentation/models/Queue.md @@ -4,12 +4,12 @@ Represents a queue. **Properties** -| Name | Type | Required | Description | -| :-------------- | :----------------- | :------- | :-------------------------------------------------------------------------------------------- | -| id | `string` | ✅ | The queue identifier. This is automatically generated and assigned when the queue is created. | -| name | `string` | ✅ | The queue name. This must be unique within the project. | -| displayName | `string` | ✅ | The display name. This may be used as a more human-readable name. | -| containerGroups | `ContainerGroup[]` | ✅ | | -| createTime | `string` | ✅ | The date and time the queue was created. | -| updateTime | `string` | ✅ | The date and time the queue was last updated. | -| description | `string` | ❌ | The description. This may be used as a space for notes or other information about the queue. | +| Name | Type | Required | Description | +| :-------------- | :--------------- | :------- | :-------------------------------------------------------------------------------------------- | +| id | string | ✅ | The queue identifier. This is automatically generated and assigned when the queue is created. | +| name | string | ✅ | The queue name. This must be unique within the project. | +| displayName | string | ✅ | The display name. This may be used as a more human-readable name. | +| containerGroups | ContainerGroup[] | ✅ | | +| createTime | string | ✅ | The date and time the queue was created. | +| updateTime | string | ✅ | The date and time the queue was last updated. | +| description | string | ❌ | The description. This may be used as a space for notes or other information about the queue. | diff --git a/documentation/models/QueueAutoscaler.md b/documentation/models/QueueAutoscaler.md index 3c15083..921623d 100644 --- a/documentation/models/QueueAutoscaler.md +++ b/documentation/models/QueueAutoscaler.md @@ -4,11 +4,11 @@ Represents the autoscaling rules for a queue **Properties** -| Name | Type | Required | Description | -| :-------------------- | :------- | :------- | :---------- | -| minReplicas | `number` | ✅ | | -| maxReplicas | `number` | ✅ | | -| desiredQueueLength | `number` | ✅ | | -| pollingPeriod | `number` | ❌ | | -| maxUpscalePerMinute | `number` | ❌ | | -| maxDownscalePerMinute | `number` | ❌ | | +| Name | Type | Required | Description | +| :-------------------- | :----- | :------- | :---------- | +| minReplicas | number | ✅ | | +| maxReplicas | number | ✅ | | +| desiredQueueLength | number | ✅ | | +| pollingPeriod | number | ❌ | | +| maxUpscalePerMinute | number | ❌ | | +| maxDownscalePerMinute | number | ❌ | | diff --git a/documentation/models/QueueJob.md b/documentation/models/QueueJob.md index 2cc8e59..a7ad28d 100644 --- a/documentation/models/QueueJob.md +++ b/documentation/models/QueueJob.md @@ -4,26 +4,26 @@ Represents a queue job **Properties** -| Name | Type | Required | Description | -| :--------- | :---------------- | :------- | :------------------------------------- | -| id | `string` | ✅ | | -| input | `any` | ✅ | The job input. May be any valid JSON. | -| status | `QueueJobStatus` | ✅ | | -| events | `QueueJobEvent[]` | ✅ | | -| createTime | `string` | ✅ | | -| updateTime | `string` | ✅ | | -| metadata | `any` | ❌ | | -| webhook | `string` | ❌ | | -| output | `any` | ❌ | The job output. May be any valid JSON. | +| Name | Type | Required | Description | +| :--------- | :-------------- | :------- | :------------------------------------- | +| id | string | ✅ | | +| input | any | ✅ | The job input. May be any valid JSON. | +| status | QueueJobStatus | ✅ | | +| events | QueueJobEvent[] | ✅ | | +| createTime | string | ✅ | | +| updateTime | string | ✅ | | +| metadata | any | ❌ | | +| webhook | string | ❌ | | +| output | any | ❌ | The job output. May be any valid JSON. | # QueueJobStatus **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :---------- | -| PENDING | `string` | ✅ | "pending" | -| RUNNING | `string` | ✅ | "running" | -| SUCCEEDED | `string` | ✅ | "succeeded" | -| CANCELLED | `string` | ✅ | "cancelled" | -| FAILED | `string` | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :---------- | +| PENDING | string | ✅ | "pending" | +| RUNNING | string | ✅ | "running" | +| SUCCEEDED | string | ✅ | "succeeded" | +| CANCELLED | string | ✅ | "cancelled" | +| FAILED | string | ✅ | "failed" | diff --git a/documentation/models/QueueJobEvent.md b/documentation/models/QueueJobEvent.md index 82e8c33..e09d853 100644 --- a/documentation/models/QueueJobEvent.md +++ b/documentation/models/QueueJobEvent.md @@ -4,19 +4,19 @@ Represents an event for queue job **Properties** -| Name | Type | Required | Description | -| :----- | :-------------------- | :------- | :---------- | -| action | `QueueJobEventAction` | ✅ | | -| time | `string` | ✅ | | +| Name | Type | Required | Description | +| :----- | :------------------ | :------- | :---------- | +| action | QueueJobEventAction | ✅ | | +| time | string | ✅ | | # QueueJobEventAction **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :---------- | -| CREATED | `string` | ✅ | "created" | -| STARTED | `string` | ✅ | "started" | -| SUCCEEDED | `string` | ✅ | "succeeded" | -| CANCELLED | `string` | ✅ | "cancelled" | -| FAILED | `string` | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :---------- | +| CREATED | string | ✅ | "created" | +| STARTED | string | ✅ | "started" | +| SUCCEEDED | string | ✅ | "succeeded" | +| CANCELLED | string | ✅ | "cancelled" | +| FAILED | string | ✅ | "failed" | diff --git a/documentation/models/QueueJobList.md b/documentation/models/QueueJobList.md index 9bcc9b4..7370d41 100644 --- a/documentation/models/QueueJobList.md +++ b/documentation/models/QueueJobList.md @@ -4,6 +4,6 @@ Represents a list of queue jobs **Properties** -| Name | Type | Required | Description | -| :---- | :----------- | :------- | :---------- | -| items | `QueueJob[]` | ✅ | | +| Name | Type | Required | Description | +| :---- | :--------- | :------- | :---------- | +| items | QueueJob[] | ✅ | | diff --git a/documentation/models/QueueList.md b/documentation/models/QueueList.md index dc6cbfb..a7a0212 100644 --- a/documentation/models/QueueList.md +++ b/documentation/models/QueueList.md @@ -4,6 +4,6 @@ Represents a list of queues **Properties** -| Name | Type | Required | Description | -| :---- | :-------- | :------- | :------------------ | -| items | `Queue[]` | ✅ | The list of queues. | +| Name | Type | Required | Description | +| :---- | :------ | :------- | :------------------ | +| items | Queue[] | ✅ | The list of queues. | diff --git a/documentation/models/Quotas.md b/documentation/models/Quotas.md index e10189b..67f3a37 100644 --- a/documentation/models/Quotas.md +++ b/documentation/models/Quotas.md @@ -4,9 +4,9 @@ Represents the organization quotas **Properties** -| Name | Type | Required | Description | -| :-------------------- | :---------------------- | :------- | :------------------------------------- | -| containerGroupsQuotas | `ContainerGroupsQuotas` | ✅ | | -| recipesQuotas | `RecipesQuotas` | ✅ | | -| createTime | `string` | ❌ | The time the resource was created | -| updateTime | `string` | ❌ | The time the resource was last updated | +| Name | Type | Required | Description | +| :-------------------- | :-------------------- | :------- | :------------------------------------- | +| containerGroupsQuotas | ContainerGroupsQuotas | ✅ | | +| recipesQuotas | RecipesQuotas | ✅ | | +| createTime | string | ❌ | The time the resource was created | +| updateTime | string | ❌ | The time the resource was last updated | diff --git a/documentation/models/RecipesQuotas.md b/documentation/models/RecipesQuotas.md index 0f46160..5ca4a9f 100644 --- a/documentation/models/RecipesQuotas.md +++ b/documentation/models/RecipesQuotas.md @@ -2,7 +2,7 @@ **Properties** -| Name | Type | Required | Description | -| :-------------------------- | :------- | :------- | :---------- | -| maxCreatedRecipeDeployments | `number` | ✅ | | -| recipeInstanceQuota | `number` | ✅ | | +| Name | Type | Required | Description | +| :-------------------------- | :----- | :------- | :---------- | +| maxCreatedRecipeDeployments | number | ✅ | | +| recipeInstanceQuota | number | ✅ | | diff --git a/documentation/models/UpdateContainer.md b/documentation/models/UpdateContainer.md index b5fab3c..9cfbe5b 100644 --- a/documentation/models/UpdateContainer.md +++ b/documentation/models/UpdateContainer.md @@ -4,189 +4,189 @@ Represents an update container object **Properties** -| Name | Type | Required | Description | -| :--------------------- | :-------------------------------------- | :------- | :----------------------------------------------------------------------------------------------- | -| image | `string` | ❌ | | -| resources | `Resources` | ❌ | | -| command | `string[]` | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | -| priority | `ContainerGroupPriority` | ❌ | | -| environmentVariables | `any` | ❌ | | -| logging | `UpdateContainerLogging` | ❌ | | -| registryAuthentication | `UpdateContainerRegistryAuthentication` | ❌ | | +| Name | Type | Required | Description | +| :--------------------- | :------------------------------------ | :------- | :----------------------------------------------------------------------------------------------- | +| image | string | ❌ | | +| resources | Resources | ❌ | | +| command | string[] | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | +| priority | ContainerGroupPriority | ❌ | | +| environmentVariables | any | ❌ | | +| logging | UpdateContainerLogging | ❌ | | +| registryAuthentication | UpdateContainerRegistryAuthentication | ❌ | | # Resources **Properties** -| Name | Type | Required | Description | -| :------------ | :--------- | :------- | :---------- | -| cpu | `number` | ❌ | | -| memory | `number` | ❌ | | -| gpuClasses | `string[]` | ❌ | | -| storageAmount | `number` | ❌ | | +| Name | Type | Required | Description | +| :------------ | :------- | :------- | :---------- | +| cpu | number | ❌ | | +| memory | number | ❌ | | +| gpuClasses | string[] | ❌ | | +| storageAmount | number | ❌ | | # UpdateContainerLogging **Properties** -| Name | Type | Required | Description | -| :------- | :----------------- | :------- | :---------- | -| axiom | `LoggingAxiom3` | ❌ | | -| datadog | `LoggingDatadog3` | ❌ | | -| newRelic | `LoggingNewRelic3` | ❌ | | -| splunk | `LoggingSplunk3` | ❌ | | -| tcp | `LoggingTcp3` | ❌ | | -| http | `LoggingHttp3` | ❌ | | +| Name | Type | Required | Description | +| :------- | :--------------- | :------- | :---------- | +| axiom | LoggingAxiom3 | ❌ | | +| datadog | LoggingDatadog3 | ❌ | | +| newRelic | LoggingNewRelic3 | ❌ | | +| splunk | LoggingSplunk3 | ❌ | | +| tcp | LoggingTcp3 | ❌ | | +| http | LoggingHttp3 | ❌ | | # LoggingAxiom3 **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| apiToken | `string` | ✅ | | -| dataset | `string` | ✅ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :---------- | +| host | string | ✅ | | +| apiToken | string | ✅ | | +| dataset | string | ✅ | | # LoggingDatadog3 **Properties** -| Name | Type | Required | Description | -| :----- | :--------------- | :------- | :---------- | -| host | `string` | ✅ | | -| apiKey | `string` | ✅ | | -| tags | `DatadogTags3[]` | ❌ | | +| Name | Type | Required | Description | +| :----- | :------------- | :------- | :---------- | +| host | string | ✅ | | +| apiKey | string | ✅ | | +| tags | DatadogTags3[] | ❌ | | # DatadogTags3 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | # LoggingNewRelic3 **Properties** -| Name | Type | Required | Description | -| :----------- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| ingestionKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :----------- | :----- | :------- | :---------- | +| host | string | ✅ | | +| ingestionKey | string | ✅ | | # LoggingSplunk3 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| token | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| host | string | ✅ | | +| token | string | ✅ | | # LoggingTcp3 **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| host | `string` | ✅ | | -| port | `number` | ✅ | | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| host | string | ✅ | | +| port | number | ✅ | | # LoggingHttp3 **Properties** -| Name | Type | Required | Description | -| :---------- | :----------------- | :------- | :---------- | -| host | `string` | ✅ | | -| port | `number` | ✅ | | -| format | `HttpFormat3` | ✅ | | -| compression | `HttpCompression3` | ✅ | | -| user | `string` | ❌ | | -| password | `string` | ❌ | | -| path | `string` | ❌ | | -| headers | `HttpHeaders4[]` | ❌ | | +| Name | Type | Required | Description | +| :---------- | :--------------- | :------- | :---------- | +| host | string | ✅ | | +| port | number | ✅ | | +| format | HttpFormat3 | ✅ | | +| compression | HttpCompression3 | ✅ | | +| user | string | ❌ | | +| password | string | ❌ | | +| path | string | ❌ | | +| headers | HttpHeaders4[] | ❌ | | # HttpFormat3 **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :----------- | -| JSON | `string` | ✅ | "json" | -| JSONLINES | `string` | ✅ | "json_lines" | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :----------- | +| JSON | string | ✅ | "json" | +| JSONLINES | string | ✅ | "json_lines" | # HttpCompression3 **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| NONE | `string` | ✅ | "none" | -| GZIP | `string` | ✅ | "gzip" | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| NONE | string | ✅ | "none" | +| GZIP | string | ✅ | "gzip" | # HttpHeaders4 **Properties** -| Name | Type | Required | Description | -| :---- | :------- | :------- | :---------- | -| name | `string` | ✅ | | -| value | `string` | ✅ | | +| Name | Type | Required | Description | +| :---- | :----- | :------- | :---------- | +| name | string | ✅ | | +| value | string | ✅ | | # UpdateContainerRegistryAuthentication **Properties** -| Name | Type | Required | Description | -| :-------- | :--------------------------------- | :------- | :---------- | -| basic | `RegistryAuthenticationBasic2` | ❌ | | -| gcpGcr | `RegistryAuthenticationGcpGcr2` | ❌ | | -| awsEcr | `RegistryAuthenticationAwsEcr2` | ❌ | | -| dockerHub | `RegistryAuthenticationDockerHub2` | ❌ | | -| gcpGar | `RegistryAuthenticationGcpGar2` | ❌ | | +| Name | Type | Required | Description | +| :-------- | :------------------------------- | :------- | :---------- | +| basic | RegistryAuthenticationBasic2 | ❌ | | +| gcpGcr | RegistryAuthenticationGcpGcr2 | ❌ | | +| awsEcr | RegistryAuthenticationAwsEcr2 | ❌ | | +| dockerHub | RegistryAuthenticationDockerHub2 | ❌ | | +| gcpGar | RegistryAuthenticationGcpGar2 | ❌ | | # RegistryAuthenticationBasic2 **Properties** -| Name | Type | Required | Description | -| :------- | :------- | :------- | :---------- | -| username | `string` | ✅ | | -| password | `string` | ✅ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :---------- | +| username | string | ✅ | | +| password | string | ✅ | | # RegistryAuthenticationGcpGcr2 **Properties** -| Name | Type | Required | Description | -| :--------- | :------- | :------- | :---------- | -| serviceKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :--------- | :----- | :------- | :---------- | +| serviceKey | string | ✅ | | # RegistryAuthenticationAwsEcr2 **Properties** -| Name | Type | Required | Description | -| :-------------- | :------- | :------- | :---------- | -| accessKeyId | `string` | ✅ | | -| secretAccessKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :-------------- | :----- | :------- | :---------- | +| accessKeyId | string | ✅ | | +| secretAccessKey | string | ✅ | | # RegistryAuthenticationDockerHub2 **Properties** -| Name | Type | Required | Description | -| :------------------ | :------- | :------- | :---------- | -| username | `string` | ✅ | | -| personalAccessToken | `string` | ✅ | | +| Name | Type | Required | Description | +| :------------------ | :----- | :------- | :---------- | +| username | string | ✅ | | +| personalAccessToken | string | ✅ | | # RegistryAuthenticationGcpGar2 **Properties** -| Name | Type | Required | Description | -| :--------- | :------- | :------- | :---------- | -| serviceKey | `string` | ✅ | | +| Name | Type | Required | Description | +| :--------- | :----- | :------- | :---------- | +| serviceKey | string | ✅ | | diff --git a/documentation/models/UpdateContainerGroup.md b/documentation/models/UpdateContainerGroup.md index dcf1363..97a33d0 100644 --- a/documentation/models/UpdateContainerGroup.md +++ b/documentation/models/UpdateContainerGroup.md @@ -4,13 +4,13 @@ Represents a request to update a container group **Properties** -| Name | Type | Required | Description | -| :------------- | :------------------------------- | :------- | :---------------------------------------------------------------------------------------------- | -| displayName | `string` | ❌ | | -| container | `UpdateContainer` | ❌ | Represents an update container object | -| replicas | `number` | ❌ | | -| countryCodes | `CountryCode[]` | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. | -| networking | `UpdateContainerGroupNetworking` | ❌ | Represents update container group networking parameters | -| livenessProbe | `ContainerGroupLivenessProbe` | ❌ | Represents the container group liveness probe | -| readinessProbe | `ContainerGroupReadinessProbe` | ❌ | Represents the container group readiness probe | -| startupProbe | `ContainerGroupStartupProbe` | ❌ | Represents the container group startup probe | +| Name | Type | Required | Description | +| :------------- | :----------------------------- | :------- | :---------------------------------------------------------------------------------------------- | +| displayName | string | ❌ | | +| container | UpdateContainer | ❌ | Represents an update container object | +| replicas | number | ❌ | | +| countryCodes | CountryCode[] | ❌ | List of countries nodes must be located in. Remove this field to permit nodes from any country. | +| networking | UpdateContainerGroupNetworking | ❌ | Represents update container group networking parameters | +| livenessProbe | ContainerGroupLivenessProbe | ❌ | Represents the container group liveness probe | +| readinessProbe | ContainerGroupReadinessProbe | ❌ | Represents the container group readiness probe | +| startupProbe | ContainerGroupStartupProbe | ❌ | Represents the container group startup probe | diff --git a/documentation/models/UpdateContainerGroupNetworking.md b/documentation/models/UpdateContainerGroupNetworking.md index dcffbf4..e5587a8 100644 --- a/documentation/models/UpdateContainerGroupNetworking.md +++ b/documentation/models/UpdateContainerGroupNetworking.md @@ -4,6 +4,6 @@ Represents update container group networking parameters **Properties** -| Name | Type | Required | Description | -| :--- | :------- | :------- | :---------- | -| port | `number` | ❌ | | +| Name | Type | Required | Description | +| :--- | :----- | :------- | :---------- | +| port | number | ❌ | | diff --git a/documentation/models/UpdateQueue.md b/documentation/models/UpdateQueue.md index 14284e2..5cfbe88 100644 --- a/documentation/models/UpdateQueue.md +++ b/documentation/models/UpdateQueue.md @@ -4,7 +4,7 @@ Represents a request to update an existing queue. **Properties** -| Name | Type | Required | Description | -| :---------- | :------- | :------- | :------------------------------------------------------------------------------------------- | -| displayName | `string` | ❌ | The display name. This may be used as a more human-readable name. | -| description | `string` | ❌ | The description. This may be used as a space for notes or other information about the queue. | +| Name | Type | Required | Description | +| :---------- | :----- | :------- | :------------------------------------------------------------------------------------------- | +| displayName | string | ❌ | The display name. This may be used as a more human-readable name. | +| description | string | ❌ | The description. This may be used as a space for notes or other information about the queue. | diff --git a/documentation/models/WebhookSecretKey.md b/documentation/models/WebhookSecretKey.md index c8c1d19..864d476 100644 --- a/documentation/models/WebhookSecretKey.md +++ b/documentation/models/WebhookSecretKey.md @@ -4,6 +4,6 @@ Represents a webhook secret key **Properties** -| Name | Type | Required | Description | -| :-------- | :------- | :------- | :--------------------- | -| secretKey | `string` | ✅ | The webhook secret key | +| Name | Type | Required | Description | +| :-------- | :----- | :------- | :--------------------- | +| secretKey | string | ✅ | The webhook secret key | diff --git a/documentation/models/WorkloadError.md b/documentation/models/WorkloadError.md index 69a1c21..d0b0fb2 100644 --- a/documentation/models/WorkloadError.md +++ b/documentation/models/WorkloadError.md @@ -4,12 +4,12 @@ Represents a workload error **Properties** -| Name | Type | Required | Description | -| :---------- | :------- | :------- | :---------- | -| detail | `string` | ✅ | | -| failedAt | `string` | ✅ | | -| instanceId | `string` | ✅ | | -| machineId | `string` | ✅ | | -| allocatedAt | `string` | ✅ | | -| version | `number` | ✅ | | -| startedAt | `string` | ❌ | | +| Name | Type | Required | Description | +| :---------- | :----- | :------- | :---------- | +| detail | string | ✅ | | +| failedAt | string | ✅ | | +| instanceId | string | ✅ | | +| machineId | string | ✅ | | +| allocatedAt | string | ✅ | | +| version | number | ✅ | | +| startedAt | string | ❌ | | diff --git a/documentation/models/WorkloadErrorList.md b/documentation/models/WorkloadErrorList.md index 80d5e1d..14b09f6 100644 --- a/documentation/models/WorkloadErrorList.md +++ b/documentation/models/WorkloadErrorList.md @@ -4,6 +4,6 @@ Represents a list of workload errors **Properties** -| Name | Type | Required | Description | -| :---- | :---------------- | :------- | :---------- | -| items | `WorkloadError[]` | ✅ | | +| Name | Type | Required | Description | +| :---- | :-------------- | :------- | :---------- | +| items | WorkloadError[] | ✅ | | diff --git a/documentation/services/ContainerGroupsService.md b/documentation/services/ContainerGroupsService.md index 2c195a2..2586368 100644 --- a/documentation/services/ContainerGroupsService.md +++ b/documentation/services/ContainerGroupsService.md @@ -26,10 +26,10 @@ Gets the list of container groups **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -63,11 +63,11 @@ Creates a new container group **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| body | `[CreateContainerGroup](../models/CreateContainerGroup.md)` | ✅ | The request body. | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :--------------- | :-------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| body | [CreateContainerGroup](../models/CreateContainerGroup.md) | ✅ | The request body. | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -289,7 +289,7 @@ import { const queueAutoscaler: QueueAutoscaler = { minReplicas: 57, - maxReplicas: 24, + maxReplicas: 58, desiredQueueLength: 20, pollingPeriod: 1406, maxUpscalePerMinute: 35, @@ -331,11 +331,11 @@ Gets a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -370,12 +370,12 @@ Updates a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :---------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| body | `[UpdateContainerGroup](../models/UpdateContainerGroup.md)` | ✅ | The request body. | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :-------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| body | [UpdateContainerGroup](../models/UpdateContainerGroup.md) | ✅ | The request body. | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -611,11 +611,11 @@ Deletes a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Example Usage Code Snippet** @@ -646,11 +646,11 @@ Starts a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Example Usage Code Snippet** @@ -681,11 +681,11 @@ Stops a container group **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Example Usage Code Snippet** @@ -716,11 +716,11 @@ Gets the list of container group instances **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** @@ -755,12 +755,12 @@ Gets a container group instance **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | -| containerGroupInstanceId | `string` | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Return Type** @@ -796,12 +796,12 @@ Reallocates a container group instance to run on a different Salad Node **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | -| containerGroupInstanceId | `string` | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Example Usage Code Snippet** @@ -833,12 +833,12 @@ Stops a container, destroys it, and starts a new one without requiring the image **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | -| containerGroupInstanceId | `string` | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Example Usage Code Snippet** @@ -870,12 +870,12 @@ Stops a container and restarts it on the same Salad Node **Parameters** -| Name | Type | Required | Description | -| :----------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | -| containerGroupInstanceId | `string` | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :----------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | +| containerGroupInstanceId | string | ✅ | The unique instance identifier | **Example Usage Code Snippet** diff --git a/documentation/services/InferenceEndpointsService.md b/documentation/services/InferenceEndpointsService.md index c6bdd95..28e6db2 100644 --- a/documentation/services/InferenceEndpointsService.md +++ b/documentation/services/InferenceEndpointsService.md @@ -20,11 +20,11 @@ Gets the list of inference endpoints **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| page | `number` | ❌ | The page number | -| pageSize | `number` | ❌ | The number of items per page | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| page | number | ❌ | The page number | +| pageSize | number | ❌ | The number of items per page | **Return Type** @@ -61,10 +61,10 @@ Gets an inference endpoint **Parameters** -| Name | Type | Required | Description | -| :-------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| inferenceEndpointName | `string` | ✅ | The unique inference endpoint name | +| Name | Type | Required | Description | +| :-------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | **Return Type** @@ -98,12 +98,12 @@ Retrieves a list of an inference endpoint jobs **Parameters** -| Name | Type | Required | Description | -| :-------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| inferenceEndpointName | `string` | ✅ | The unique inference endpoint name | -| page | `number` | ❌ | The page number | -| pageSize | `number` | ❌ | The number of items per page | +| Name | Type | Required | Description | +| :-------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| page | number | ❌ | The page number | +| pageSize | number | ❌ | The number of items per page | **Return Type** @@ -141,11 +141,11 @@ Creates a new job **Parameters** -| Name | Type | Required | Description | -| :-------------------- | :---------------------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| body | `[CreateInferenceEndpointJob](../models/CreateInferenceEndpointJob.md)` | ✅ | The request body. | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| inferenceEndpointName | `string` | ✅ | The unique inference endpoint name | +| Name | Type | Required | Description | +| :-------------------- | :-------------------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| body | [CreateInferenceEndpointJob](../models/CreateInferenceEndpointJob.md) | ✅ | The request body. | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | **Return Type** @@ -186,11 +186,11 @@ Retrieves a job in an inference endpoint **Parameters** -| Name | Type | Required | Description | -| :--------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| inferenceEndpointName | `string` | ✅ | The unique inference endpoint name | -| inferenceEndpointJobId | `string` | ✅ | The unique job id | +| Name | Type | Required | Description | +| :--------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| inferenceEndpointJobId | string | ✅ | The unique job id | **Return Type** @@ -225,11 +225,11 @@ Deletes an inference endpoint job **Parameters** -| Name | Type | Required | Description | -| :--------------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| inferenceEndpointName | `string` | ✅ | The unique inference endpoint name | -| inferenceEndpointJobId | `string` | ✅ | The unique job id | +| Name | Type | Required | Description | +| :--------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| inferenceEndpointName | string | ✅ | The unique inference endpoint name | +| inferenceEndpointJobId | string | ✅ | The unique job id | **Example Usage Code Snippet** diff --git a/documentation/services/OrganizationDataService.md b/documentation/services/OrganizationDataService.md index 0d303e0..a43b4d1 100644 --- a/documentation/services/OrganizationDataService.md +++ b/documentation/services/OrganizationDataService.md @@ -15,9 +15,9 @@ List the GPU Classes **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | **Return Type** diff --git a/documentation/services/QueuesService.md b/documentation/services/QueuesService.md index 268530a..aa1701c 100644 --- a/documentation/services/QueuesService.md +++ b/documentation/services/QueuesService.md @@ -23,10 +23,10 @@ Gets the list of queues in the given project. **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -60,11 +60,11 @@ Creates a new queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| body | `[CreateQueue](../models/CreateQueue.md)` | ✅ | The request body. | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :--------------- | :-------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| body | [CreateQueue](../models/CreateQueue.md) | ✅ | The request body. | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -105,11 +105,11 @@ Gets an existing queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | **Return Type** @@ -144,12 +144,12 @@ Updates an existing queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| body | `[UpdateQueue](../models/UpdateQueue.md)` | ✅ | The request body. | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | +| Name | Type | Required | Description | +| :--------------- | :-------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| body | [UpdateQueue](../models/UpdateQueue.md) | ✅ | The request body. | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | **Return Type** @@ -190,11 +190,11 @@ Deletes an existing queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | **Example Usage Code Snippet** @@ -225,13 +225,13 @@ Gets the list of jobs in a queue **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | -| page | `number` | ❌ | The page number | -| pageSize | `number` | ❌ | The number of items per page | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| page | number | ❌ | The page number | +| pageSize | number | ❌ | The number of items per page | **Return Type** @@ -270,12 +270,12 @@ Creates a new job **Parameters** -| Name | Type | Required | Description | -| :--------------- | :---------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| body | `[CreateQueueJob](../models/CreateQueueJob.md)` | ✅ | The request body. | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | +| Name | Type | Required | Description | +| :--------------- | :-------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| body | [CreateQueueJob](../models/CreateQueueJob.md) | ✅ | The request body. | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | **Return Type** @@ -317,12 +317,12 @@ Gets a job in a queue **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | -| queueJobId | `string` | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| queueJobId | string | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | **Return Type** @@ -358,12 +358,12 @@ Cancels a job in a queue **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queueName | `string` | ✅ | The queue name. | -| queueJobId | `string` | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queueName | string | ✅ | The queue name. | +| queueJobId | string | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | **Example Usage Code Snippet** diff --git a/documentation/services/QuotasService.md b/documentation/services/QuotasService.md index 2ecc4ef..0120e26 100644 --- a/documentation/services/QuotasService.md +++ b/documentation/services/QuotasService.md @@ -15,9 +15,9 @@ Gets the organization quotas **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | **Return Type** diff --git a/documentation/services/WebhookSecretKeyService.md b/documentation/services/WebhookSecretKeyService.md index f3f8b05..21ff365 100644 --- a/documentation/services/WebhookSecretKeyService.md +++ b/documentation/services/WebhookSecretKeyService.md @@ -16,9 +16,9 @@ Gets the webhook secret key **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | **Return Type** @@ -51,9 +51,9 @@ Updates the webhook secret key **Parameters** -| Name | Type | Required | Description | -| :--------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| Name | Type | Required | Description | +| :--------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | **Return Type** diff --git a/documentation/services/WorkloadErrorsService.md b/documentation/services/WorkloadErrorsService.md index 226d899..861a7a5 100644 --- a/documentation/services/WorkloadErrorsService.md +++ b/documentation/services/WorkloadErrorsService.md @@ -15,11 +15,11 @@ Gets the workload errors **Parameters** -| Name | Type | Required | Description | -| :----------------- | :------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organizationName | `string` | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | -| projectName | `string` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| containerGroupName | `string` | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :----------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organizationName | string | ✅ | Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. | +| projectName | string | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| containerGroupName | string | ✅ | The unique container group name | **Return Type** diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md index b96fd4f..3809bec 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md @@ -212,7 +212,7 @@ import { const queueAutoscaler: QueueAutoscaler = { minReplicas: 57, - maxReplicas: 24, + maxReplicas: 58, desiredQueueLength: 20, pollingPeriod: 1406, maxUpscalePerMinute: 35, diff --git a/examples/package.json b/examples/package.json index dbdacf8..d2af1b5 100644 --- a/examples/package.json +++ b/examples/package.json @@ -1,6 +1,6 @@ { "name": "salad-cloud-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "private": true, "dependencies": { "@saladtechnologies-oss/salad-cloud-sdk": "file:../", diff --git a/package-lock.json b/package-lock.json index 987dacc..c8e7333 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@saladtechnologies-oss/salad-cloud-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@saladtechnologies-oss/salad-cloud-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "license": "MIT", "dependencies": { "zod": "3.22.0" diff --git a/package.json b/package.json index 7b45906..3b7f626 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@saladtechnologies-oss/salad-cloud-sdk", - "version": "0.9.0-alpha.2", + "version": "0.9.0-alpha.3", "description": "The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.", "source": "./src/index.ts", "main": "./dist/index.js", diff --git a/src/http/client.ts b/src/http/client.ts index eed19d5..055ff2b 100644 --- a/src/http/client.ts +++ b/src/http/client.ts @@ -33,7 +33,7 @@ export class HttpClient { const response = await this.call(request as any); if (!response.data) { - throw new Error('now response data to paginate through'); + throw new Error('no response data to paginate through'); } return { diff --git a/src/http/index.ts b/src/http/index.ts index 82bf7c7..236a3cf 100644 --- a/src/http/index.ts +++ b/src/http/index.ts @@ -7,3 +7,4 @@ export type { HttpMethod, HttpResponse, } from './types.ts'; +export type { HttpError } from './error.ts'; diff --git a/src/services/common/container-group.ts b/src/services/common/container-group.ts index f927af5..a764232 100644 --- a/src/services/common/container-group.ts +++ b/src/services/common/container-group.ts @@ -59,7 +59,7 @@ export const containerGroup = z.lazy(() => { updateTime: z.string(), pendingChange: z.boolean(), version: z.number().gte(1), - queueAutoscaler: queueAutoscaler.optional(), + queueAutoscaler: queueAutoscaler.optional().nullable(), }); }); @@ -121,7 +121,7 @@ export const containerGroupResponse = z.lazy(() => { update_time: z.string(), pending_change: z.boolean(), version: z.number().gte(1), - queue_autoscaler: queueAutoscalerResponse.optional(), + queue_autoscaler: queueAutoscalerResponse.optional().nullable(), }) .transform((data) => ({ id: data['id'], diff --git a/src/services/common/queue-autoscaler.ts b/src/services/common/queue-autoscaler.ts index 07004da..1819fdf 100644 --- a/src/services/common/queue-autoscaler.ts +++ b/src/services/common/queue-autoscaler.ts @@ -6,7 +6,7 @@ import { z } from 'zod'; export const queueAutoscaler = z.lazy(() => { return z.object({ minReplicas: z.number().gte(0).lte(100), - maxReplicas: z.number().gte(1).lte(100), + maxReplicas: z.number().gte(1).lte(250), desiredQueueLength: z.number().gte(1).lte(100), pollingPeriod: z.number().gte(15).lte(1800).optional(), maxUpscalePerMinute: z.number().gte(1).lte(100).optional(), @@ -34,7 +34,7 @@ export const queueAutoscalerResponse = z.lazy(() => { return z .object({ min_replicas: z.number().gte(0).lte(100), - max_replicas: z.number().gte(1).lte(100), + max_replicas: z.number().gte(1).lte(250), desired_queue_length: z.number().gte(1).lte(100), polling_period: z.number().gte(15).lte(1800).optional(), max_upscale_per_minute: z.number().gte(1).lte(100).optional(), diff --git a/src/services/container-groups/models/create-container-group.ts b/src/services/container-groups/models/create-container-group.ts index e345c98..eb34288 100644 --- a/src/services/container-groups/models/create-container-group.ts +++ b/src/services/container-groups/models/create-container-group.ts @@ -54,7 +54,7 @@ export const createContainerGroup = z.lazy(() => { readinessProbe: containerGroupReadinessProbe.optional().nullable(), startupProbe: containerGroupStartupProbe.optional().nullable(), queueConnection: containerGroupQueueConnection.optional().nullable(), - queueAutoscaler: queueAutoscaler.optional(), + queueAutoscaler: queueAutoscaler.optional().nullable(), }); }); @@ -106,7 +106,7 @@ export const createContainerGroupResponse = z.lazy(() => { readiness_probe: containerGroupReadinessProbeResponse.optional().nullable(), startup_probe: containerGroupStartupProbeResponse.optional().nullable(), queue_connection: containerGroupQueueConnectionResponse.optional().nullable(), - queue_autoscaler: queueAutoscalerResponse.optional(), + queue_autoscaler: queueAutoscalerResponse.optional().nullable(), }) .transform((data) => ({ name: data['name'],