From 28fb30b0c9bfc52d764dff2f7e23b7820d3331f6 Mon Sep 17 00:00:00 2001 From: SaladTechnologies <415806+seniorquico@users.noreply.github.com> Date: Wed, 11 Sep 2024 04:11:09 +0000 Subject: [PATCH] liblab SDK update for version v0.9.0-alpha.2 --- .manifest.json | 41 +- README.md | 7 +- documentation/models/Container.md | 132 ++--- documentation/models/ContainerGroup.md | 41 +- .../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 | 29 +- .../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 | 14 + 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 | 271 +++++----- .../services/InferenceEndpointsService.md | 64 +-- .../services/OrganizationDataService.md | 6 +- documentation/services/QueuesService.md | 112 ++-- documentation/services/QuotasService.md | 6 +- .../services/WebhookSecretKeyService.md | 12 +- .../services/WorkloadErrorsService.md | 16 +- ...projects-{project_name}-containers-post.md | 47 +- ...ontainers-{container_group_name}-delete.md | 6 +- ...iners-{container_group_name}-errors-get.md | 6 +- ...}-containers-{container_group_name}-get.md | 6 +- ...containers-{container_group_name}-patch.md | 44 +- ...iners-{container_group_name}-start-post.md | 2 +- examples/package.json | 2 +- examples/tsconfig.json | 2 +- package-lock.json | 24 +- package.json | 12 +- src/http/client.ts | 32 ++ src/http/handlers/auth-handler.ts | 2 + src/http/hooks/hook.ts | 2 +- src/http/index.ts | 10 +- src/http/transport/request-builder.ts | 51 +- src/http/transport/request.ts | 56 +- src/http/transport/transport-hook-adapter.ts | 2 + src/http/types.ts | 2 +- src/index.ts | 1 + src/services/common/container-group.ts | 7 + src/services/common/index.ts | 1 + src/services/common/queue-autoscaler.ts | 75 +++ .../container-groups/container-groups.ts | 34 +- .../models/create-container-group.ts | 7 + .../inference-endpoints.ts | 14 +- .../organization-data/organization-data.ts | 2 +- src/services/queues/queues.ts | 24 +- src/services/quotas/quotas.ts | 2 +- .../webhook-secret-key/webhook-secret-key.ts | 4 +- .../workload-errors/workload-errors.ts | 2 +- tsconfig.json | 2 +- 94 files changed, 1474 insertions(+), 1240 deletions(-) create mode 100644 documentation/models/QueueAutoscaler.md create mode 100644 src/services/common/queue-autoscaler.ts diff --git a/.manifest.json b/.manifest.json index 74a05a0..9b6a03a 100644 --- a/.manifest.json +++ b/.manifest.json @@ -1,10 +1,10 @@ { - "liblabVersion": "2.1.30", - "date": "2024-09-01T16:26:45.727Z", + "liblabVersion": "2.2.0", + "date": "2024-09-11T04:10:26.246Z", "config": { - "apiId": 1094, + "apiId": 1143, "sdkName": "salad-cloud-sdk", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "liblabVersion": "2", "deliveryMethods": ["zip"], "languages": ["typescript"], @@ -24,17 +24,17 @@ ], "githubRepoName": "salad-cloud-sdk-dotnet", "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-dotnet", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" }, "go": { "goModuleName": "github.com/saladtechnologies/salad-cloud-sdk-go", "githubRepoName": "salad-cloud-sdk-go", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" }, "java": { @@ -56,9 +56,9 @@ ], "githubRepoName": "salad-cloud-sdk-java", "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-java", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" }, "python": { @@ -99,9 +99,9 @@ } ], "githubRepoName": "salad-cloud-sdk-python", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" }, "terraform": { @@ -112,9 +112,9 @@ "providerSchemaConfig": { "authTokenKey": "api_key" }, - "providerVersion": "0.9.0-alpha.1", + "providerVersion": "0.9.0-alpha.2", "githubRepoName": "terraform-provider-salad-cloud", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", "targetBranch": "main" }, @@ -136,9 +136,9 @@ ], "githubRepoName": "salad-cloud-sdk-javascript", "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-javascript", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "liblabVersion": "2", - "sdkVersion": "0.9.0-alpha.1", + "sdkVersion": "0.9.0-alpha.2", "targetBranch": "main" } }, @@ -232,7 +232,7 @@ } ], "apiName": "SaladCloud API", - "apiVersion": "0.9.0-alpha.1", + "apiVersion": "0.9.0-alpha.2", "authentication": { "apiKey": { "header": "Salad-Api-Key" @@ -284,14 +284,14 @@ ], "githubRepoName": "salad-cloud-sdk-javascript", "homepage": "https://github.com/saladtechnologies/salad-cloud-sdk-javascript", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "targetBranch": "main", "typescriptVersion": "5.3.3", "zodVersion": "3.22.0", "compilerOptions": { "target": "es6", "module": "Node16", - "lib": ["es2017", "dom"] + "lib": ["es2018", "dom"] }, "usesFormData": false, "environmentVariables": [], @@ -350,6 +350,7 @@ "src/services/common/container-group-readiness-probe.ts", "src/services/common/container-group-startup-probe.ts", "src/services/common/container-group-queue-connection.ts", + "src/services/common/queue-autoscaler.ts", "src/services/common/container-resource-requirements.ts", "src/services/common/container-group-priority.ts", "src/services/common/container-logging.ts", @@ -459,7 +460,6 @@ "src/http/environment.ts", "src/http/handlers/response-validation-handler.ts", "src/http/handlers/auth-handler.ts", - "./LICENSE", "documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md", "documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md", "documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-get.md", @@ -521,6 +521,7 @@ "documentation/models/ContainerGroupReadinessProbe.md", "documentation/models/ContainerGroupStartupProbe.md", "documentation/models/ContainerGroupQueueConnection.md", + "documentation/models/QueueAutoscaler.md", "documentation/models/ContainerResourceRequirements.md", "documentation/models/ContainerGroupPriority.md", "documentation/models/ContainerGroupStatus.md", diff --git a/README.md b/README.md index f3718fb..d96ece0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# SaladCloudSdk TypeScript SDK 0.9.0-alpha.1 +# SaladCloudSdk TypeScript SDK 0.9.0-alpha.2 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.1` -- SDK version: `0.9.0-alpha.1` +- API version: `0.9.0-alpha.2` +- SDK version: `0.9.0-alpha.2` ## About the API @@ -144,6 +144,7 @@ The SDK includes several models that represent the data structures used in API r | [ContainerGroupReadinessProbe](documentation/models/ContainerGroupReadinessProbe.md) | Represents the container group readiness probe | | [ContainerGroupStartupProbe](documentation/models/ContainerGroupStartupProbe.md) | Represents the container group startup probe | | [ContainerGroupQueueConnection](documentation/models/ContainerGroupQueueConnection.md) | Represents container group queue connection | +| [QueueAutoscaler](documentation/models/QueueAutoscaler.md) | Represents the autoscaling rules for a queue | | [ContainerResourceRequirements](documentation/models/ContainerResourceRequirements.md) | Represents a container resource requirements | | [ContainerGroupPriority](documentation/models/ContainerGroupPriority.md) | | | [ContainerGroupStatus](documentation/models/ContainerGroupStatus.md) | | diff --git a/documentation/models/Container.md b/documentation/models/Container.md index ef9ca45..ab49964 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 92fc36f..0c8c06c 100644 --- a/documentation/models/ContainerGroup.md +++ b/documentation/models/ContainerGroup.md @@ -4,23 +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 | +| 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 fafd3e9..a6711b8 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 b8f00c9..4fc8d1d 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 abd0293..b9cf26c 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 c9ebe4a..77526c2 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 88b9d30..1c3126f 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 e4edd7d..0dd0c01 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 76c8753..4d2b78c 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 c249b5e..d75f64e 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 adc9c52..53184d7 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 aebb7e7..e263c82 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 5637f42..7ba13dc 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 af946e7..779189a 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 c86bfbc..15dd948 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 115415d..c3f1979 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 7706dbc..189a060 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 2c7bdb2..bf7c223 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 951323d..c46576e 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 4fe27d9..0b68341 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 a8a9f17..f79398f 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 0aef268..efd6bb5 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 06341b1..a8d12e0 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 62ff6d3..b92cfa9 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 77635e4..065f8df 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 0d2313e..7b0af32 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 c14ed22..964adc6 100644 --- a/documentation/models/CreateContainerGroup.md +++ b/documentation/models/CreateContainerGroup.md @@ -4,17 +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 | +| 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 8a670a8..61ce83f 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 7ddeb9f..09dfe30 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 2727e5b..75b1d18 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 e92d726..0e4afec 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 ad15fc6..4e5c5e4 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 21965ad..28324ee 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 b231c28..1fbbadb 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 a16e3b0..d7912c9 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 9b8fe48..0cf9ec0 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 fc2e14c..869ef6c 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 d29afd4..ef13203 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 badebb8..b4c82b5 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 ea7006e..90a7902 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 new file mode 100644 index 0000000..3c15083 --- /dev/null +++ b/documentation/models/QueueAutoscaler.md @@ -0,0 +1,14 @@ +# QueueAutoscaler + +Represents the autoscaling rules for a queue + +**Properties** + +| 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 a7ad28d..2cc8e59 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 e09d853..82e8c33 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 7370d41..9bcc9b4 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 a7a0212..dc6cbfb 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 67f3a37..e10189b 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 5ca4a9f..0f46160 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 9cfbe5b..b5fab3c 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 97a33d0..dcf1363 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 e5587a8..dcffbf4 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 5cfbe88..14284e2 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 864d476..c8c1d19 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 d0b0fb2..69a1c21 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 14b09f6..80d5e1d 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 977a1e9..2c195a2 100644 --- a/documentation/services/ContainerGroupsService.md +++ b/documentation/services/ContainerGroupsService.md @@ -2,20 +2,20 @@ A list of all methods in the `ContainerGroupsService` service. Click on the method name to view detailed information about that method. -| Methods | Description | -| :-------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | -| [listContainerGroups](#listcontainergroups) | Gets the list of container groups | -| [createContainerGroup](#createcontainergroup) | Creates a new container group | -| [getContainerGroup](#getcontainergroup) | Gets a container group | -| [updateContainerGroup](#updatecontainergroup) | Updates a container group | -| [deleteContainerGroup](#deletecontainergroup) | Deletes a container group | -| [startContainerGroup](#startcontainergroup) | Starts a container group | -| [stopContainerGroup](#stopcontainergroup) | Stops a container group | -| [listContainerGroupInstances](#listcontainergroupinstances) | Retrieves a list of container group instances | -| [getContainerGroupInstance](#getcontainergroupinstance) | Retrieves the details of a single instance within a container group by instance ID | -| [reallocateContainerGroupInstance](#reallocatecontainergroupinstance) | Remove a node from a workload and reallocate the workload to a different node | -| [recreateContainerGroupInstance](#recreatecontainergroupinstance) | Stops a container, destroys it, creates a new one without requiring the image to be downloaded again on a different node | -| [restartContainerGroupInstance](#restartcontainergroupinstance) | Restarts a workload on a node without reallocating it | +| Methods | Description | +| :-------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | +| [listContainerGroups](#listcontainergroups) | Gets the list of container groups | +| [createContainerGroup](#createcontainergroup) | Creates a new container group | +| [getContainerGroup](#getcontainergroup) | Gets a container group | +| [updateContainerGroup](#updatecontainergroup) | Updates a container group | +| [deleteContainerGroup](#deletecontainergroup) | Deletes a container group | +| [startContainerGroup](#startcontainergroup) | Starts a container group | +| [stopContainerGroup](#stopcontainergroup) | Stops a container group | +| [listContainerGroupInstances](#listcontainergroupinstances) | Gets the list of container group instances | +| [getContainerGroupInstance](#getcontainergroupinstance) | Gets a container group instance | +| [reallocateContainerGroupInstance](#reallocatecontainergroupinstance) | Reallocates a container group instance to run on a different Salad Node | +| [recreateContainerGroupInstance](#recreatecontainergroupinstance) | Stops a container, destroys it, and starts a new one without requiring the image to be downloaded again on a new Salad Node | +| [restartContainerGroupInstance](#restartcontainergroupinstance) | Stops a container and restarts it on the same Salad Node | ## listContainerGroups @@ -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** @@ -86,6 +86,7 @@ import { CreateContainer, CreateContainerGroup, CreateContainerGroupNetworking, + QueueAutoscaler, SaladCloudSdk, } from '@saladtechnologies-oss/salad-cloud-sdk'; @@ -104,9 +105,9 @@ import { const containerGroupPriority = ContainerGroupPriority.HIGH; const loggingAxiom2: LoggingAxiom2 = { - host: 'in culpa aute', - apiToken: 'mollit culpa', - dataset: 'qui nulla laborum ex', + host: 'Ut con', + apiToken: 'nostrud irure dolore', + dataset: 'mollit irure et Duis dolore', }; const datadogTags2: DatadogTags2 = { @@ -115,24 +116,24 @@ import { }; const loggingDatadog2: LoggingDatadog2 = { - host: 'id fugiat cillum', - apiKey: 'nostrud', + host: 'pariatur', + apiKey: 'non ut', tags: [datadogTags2], }; const loggingNewRelic2: LoggingNewRelic2 = { - host: 'en', - ingestionKey: 'aliqua ad laboris anim', + host: 'cupidatat cillum est sit minim', + ingestionKey: 'dolore laboris fugiat Duis', }; const loggingSplunk2: LoggingSplunk2 = { - host: 'enim cupidatat eiusmod', - token: 'do', + host: 'aliquip velit culpa', + token: 'ex', }; const loggingTcp2: LoggingTcp2 = { - host: 'aliquip labore dolor id', - port: 45778, + host: 'aliqua', + port: 17249, }; const httpFormat2 = HttpFormat2.JSON; @@ -145,8 +146,8 @@ import { const httpCompression2 = HttpCompression2.NONE; const loggingHttp2: LoggingHttp2 = { - host: 'pariatur', - port: 16204, + host: 'magna', + port: 62049, user: 'user', password: 'password', path: 'path', @@ -196,7 +197,7 @@ import { }; const createContainer: CreateContainer = { - image: 'velit qui cillum veniam ullamco', + image: 'voluptate officia adipisicing', resources: containerResourceRequirements, command: ['command'], priority: containerGroupPriority, @@ -213,7 +214,7 @@ import { const createContainerGroupNetworking: CreateContainerGroupNetworking = { protocol: containerNetworkingProtocol, - port: 19760, + port: 9813, auth: true, }; @@ -286,19 +287,29 @@ import { queueName: 'nnz26lyemw7nednorlqjlsihb42092pn8d', }; + const queueAutoscaler: QueueAutoscaler = { + minReplicas: 57, + maxReplicas: 24, + desiredQueueLength: 20, + pollingPeriod: 1406, + maxUpscalePerMinute: 35, + maxDownscalePerMinute: 42, + }; + const createContainerGroup: CreateContainerGroup = { - name: 'oh2mpxyfojt-6cco', - displayName: 'HoT', + name: 'qfojt-6ccoil4t55-ccoyybgw92dermtsdfn3t2xmag', + displayName: 'O0hSlJUW', container: createContainer, autostartPolicy: true, restartPolicy: containerRestartPolicy, - replicas: 225, + replicas: 114, countryCodes: [countryCode], networking: createContainerGroupNetworking, livenessProbe: containerGroupLivenessProbe, readinessProbe: containerGroupReadinessProbe, startupProbe: containerGroupStartupProbe, queueConnection: containerGroupQueueConnection, + queueAutoscaler: queueAutoscaler, }; const { data } = await saladCloudSdk.containerGroups.createContainerGroup( @@ -320,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** @@ -341,9 +352,9 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.containerGroups.getContainerGroup( - 'ob3ca5hduqlb1uzytbhhukf1u0-ahl0b9oqfjj0q', - 'x7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lx71', - 'cif9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrm0urjjj5b9hbe2fr6f', + 'gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw', + 'xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz', + 'ojjj5b9hbe2fr6f5t7j1htjaws1zx3r', ); console.log(data); @@ -359,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** @@ -391,17 +402,17 @@ import { const resources: Resources = { cpu: 11, - memory: 1557, + memory: 21424, gpuClasses: ['gpu_classes'], - storageAmount: 40250176413, + storageAmount: 12333132242, }; const containerGroupPriority = ContainerGroupPriority.HIGH; const loggingAxiom3: LoggingAxiom3 = { - host: 'nisi et veniam', - apiToken: 'Lorem esse dolor', - dataset: 'et commodo Duis', + host: 'commodo ea exercitation pariatur consequat', + apiToken: 'ipsum', + dataset: 'id Excepteur', }; const datadogTags3: DatadogTags3 = { @@ -410,24 +421,24 @@ import { }; const loggingDatadog3: LoggingDatadog3 = { - host: 'veniam deserunt sunt dolore', - apiKey: 'ullamco occaecat nostrud irure', + host: 'exercitation aliquip', + apiKey: 'veniam', tags: [datadogTags3], }; const loggingNewRelic3: LoggingNewRelic3 = { - host: 'dolor adipisicing eu dolore incididunt', - ingestionKey: 'aliqua', + host: 'amet velit sed cillum', + ingestionKey: 'et', }; const loggingSplunk3: LoggingSplunk3 = { - host: 'enim incididunt', - token: 'Lorem Duis ipsum et', + host: 'proident', + token: 'est', }; const loggingTcp3: LoggingTcp3 = { - host: 'qui in cupidatat deserunt cillum', - port: 39897, + host: 'ut velit ea cillum', + port: 13557, }; const httpFormat3 = HttpFormat3.JSON; @@ -440,8 +451,8 @@ import { const httpCompression3 = HttpCompression3.NONE; const loggingHttp3: LoggingHttp3 = { - host: 'nostrud ea dolore', - port: 52587, + host: 'nisi fugiat cupidatat', + port: 60288, user: 'user', password: 'password', path: 'path', @@ -491,7 +502,7 @@ import { }; const updateContainer: UpdateContainer = { - image: 'culpa nulla eu non', + image: 'ex cillum dolor', resources: resources, command: ['command'], priority: containerGroupPriority, @@ -503,7 +514,7 @@ import { const countryCode = CountryCode.AF; const updateContainerGroupNetworking: UpdateContainerGroupNetworking = { - port: 60033, + port: 64823, }; const containerGroupProbeTcp: ContainerGroupProbeTcp = { @@ -570,9 +581,9 @@ import { }; const updateContainerGroup: UpdateContainerGroup = { - displayName: 'UtDi9VD ZS', + displayName: '-xzxtaW.t2I', container: updateContainer, - replicas: 183, + replicas: 110, countryCodes: [countryCode], networking: updateContainerGroupNetworking, livenessProbe: containerGroupLivenessProbe, @@ -581,9 +592,9 @@ import { }; const { data } = await saladCloudSdk.containerGroups.updateContainerGroup( - 'ob3ca5hduqlb1uzytbhhukf1u0-ahl0b9oqfjj0q', - 'x7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lx71', - 'cif9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrm0urjjj5b9hbe2fr6f', + 'gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw', + 'xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz', + 'ojjj5b9hbe2fr6f5t7j1htjaws1zx3r', input, ); @@ -600,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** @@ -617,9 +628,9 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.containerGroups.deleteContainerGroup( - 'ob3ca5hduqlb1uzytbhhukf1u0-ahl0b9oqfjj0q', - 'x7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lx71', - 'cif9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrm0urjjj5b9hbe2fr6f', + 'gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw', + 'xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz', + 'ojjj5b9hbe2fr6f5t7j1htjaws1zx3r', ); console.log(data); @@ -635,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** @@ -652,7 +663,7 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.containerGroups.startContainerGroup( - 'uh5upyur493wxwbxrj4xt9wfx07sgyz1fs97sfhtue78-54vdogp2qrcnt-8a', + 'zfx07sgyz1fs97sfhtue78-54vdogp2qrcnt-8a', 'v7jhy3jn2rdf012fi7ouno3mk9', 'a4d0ajj5ajjquzeg-z3kvqxtnoxnlzhjhjt-8naw', ); @@ -670,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** @@ -698,18 +709,18 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## listContainerGroupInstances -Retrieves a list of container group instances +Gets the list of container group instances - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/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** @@ -737,19 +748,19 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## getContainerGroupInstance -Retrieves the details of a single instance within a container group by instance ID +Gets a container group instance - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}` **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** @@ -778,19 +789,19 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## reallocateContainerGroupInstance -Remove a node from a workload and reallocate the workload to a different node +Reallocates a container group instance to run on a different Salad Node - HTTP Method: `POST` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}/reallocate` **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** @@ -815,19 +826,19 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## recreateContainerGroupInstance -Stops a container, destroys it, creates a new one without requiring the image to be downloaded again on a different node +Stops a container, destroys it, and starts a new one without requiring the image to be downloaded again on a new Salad Node - HTTP Method: `POST` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}/recreate` **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** @@ -852,19 +863,19 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## restartContainerGroupInstance -Restarts a workload on a node without reallocating it +Stops a container and restarts it on the same Salad Node - HTTP Method: `POST` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}/restart` **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 ede610e..c6bdd95 100644 --- a/documentation/services/InferenceEndpointsService.md +++ b/documentation/services/InferenceEndpointsService.md @@ -4,7 +4,7 @@ A list of all methods in the `InferenceEndpointsService` service. Click on the m | Methods | Description | | :-------------------------------------------------------- | :--------------------------------------------- | -| [listInferenceEndpoints](#listinferenceendpoints) | Gets the list of all inference endpoints | +| [listInferenceEndpoints](#listinferenceendpoints) | Gets the list of inference endpoints | | [getInferenceEndpoint](#getinferenceendpoint) | Gets an inference endpoint | | [getInferenceEndpointJobs](#getinferenceendpointjobs) | Retrieves a list of an inference endpoint jobs | | [createInferenceEndpointJob](#createinferenceendpointjob) | Creates a new job | @@ -13,18 +13,18 @@ A list of all methods in the `InferenceEndpointsService` service. Click on the m ## listInferenceEndpoints -Gets the list of all inference endpoints +Gets the list of inference endpoints - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/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 a43b4d1..0d303e0 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 f803234..268530a 100644 --- a/documentation/services/QueuesService.md +++ b/documentation/services/QueuesService.md @@ -9,10 +9,10 @@ A list of all methods in the `QueuesService` service. Click on the method name t | [getQueue](#getqueue) | Gets an existing queue in the given project. | | [updateQueue](#updatequeue) | Updates an existing queue in the given project. | | [deleteQueue](#deletequeue) | Deletes an existing queue in the given project. | -| [listQueueJobs](#listqueuejobs) | Retrieves a list of queue jobs | +| [listQueueJobs](#listqueuejobs) | Gets the list of jobs in a queue | | [createQueueJob](#createqueuejob) | Creates a new job | -| [getQueueJob](#getqueuejob) | Retrieves a job in a queue | -| [deleteQueueJob](#deletequeuejob) | Deletes a queue job | +| [getQueueJob](#getqueuejob) | Gets a job in a queue | +| [deleteQueueJob](#deletequeuejob) | Cancels a job in a queue | ## listQueues @@ -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** @@ -218,20 +218,20 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## listQueueJobs -Retrieves a list of queue jobs +Gets the list of jobs in a queue - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/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. | -| 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** @@ -310,19 +310,19 @@ import { CreateQueueJob, SaladCloudSdk } from '@saladtechnologies-oss/salad-clou ## getQueueJob -Retrieves a job in a queue +Gets a job in a queue - HTTP Method: `GET` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs/{queue_job_id}` **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** @@ -351,19 +351,19 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; ## deleteQueueJob -Deletes a queue job +Cancels a job in a queue - HTTP Method: `DELETE` - Endpoint: `/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs/{queue_job_id}` **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 0120e26..2ecc4ef 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 21ff365..f3f8b05 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 e8f2e33..226d899 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** @@ -36,9 +36,9 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.workloadErrors.getWorkloadErrors( - 'kr8pje-v4-ccp8q-329szw31h4fee237cnffybnugpd7nbngr', - 'vjne2vq5j0d2m4f21ex5ozb1-4j-you0d7uftlpfgcaqa-2oc58y844mz', - 'jpqhlkkgd', + 'u9szw31h4fee237cnffybnugpd7nbngs47jne2vq5j0d2m4f20', + 'c5ozb1-4j-you0d7uftlpfgcaqa-2oc58y844m0ne', + 'khlkkgda39h5upyur493wxwbxrj4x', ); console.log(data); 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 95b1439..b96fd4f 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 @@ -9,6 +9,7 @@ import { CreateContainer, CreateContainerGroup, CreateContainerGroupNetworking, + QueueAutoscaler, SaladCloudSdk, } from '@saladtechnologies-oss/salad-cloud-sdk'; @@ -27,9 +28,9 @@ import { const containerGroupPriority = ContainerGroupPriority.HIGH; const loggingAxiom2: LoggingAxiom2 = { - host: 'in culpa aute', - apiToken: 'mollit culpa', - dataset: 'qui nulla laborum ex', + host: 'Ut con', + apiToken: 'nostrud irure dolore', + dataset: 'mollit irure et Duis dolore', }; const datadogTags2: DatadogTags2 = { @@ -38,24 +39,24 @@ import { }; const loggingDatadog2: LoggingDatadog2 = { - host: 'id fugiat cillum', - apiKey: 'nostrud', + host: 'pariatur', + apiKey: 'non ut', tags: [datadogTags2], }; const loggingNewRelic2: LoggingNewRelic2 = { - host: 'en', - ingestionKey: 'aliqua ad laboris anim', + host: 'cupidatat cillum est sit minim', + ingestionKey: 'dolore laboris fugiat Duis', }; const loggingSplunk2: LoggingSplunk2 = { - host: 'enim cupidatat eiusmod', - token: 'do', + host: 'aliquip velit culpa', + token: 'ex', }; const loggingTcp2: LoggingTcp2 = { - host: 'aliquip labore dolor id', - port: 45778, + host: 'aliqua', + port: 17249, }; const httpFormat2 = HttpFormat2.JSON; @@ -68,8 +69,8 @@ import { const httpCompression2 = HttpCompression2.NONE; const loggingHttp2: LoggingHttp2 = { - host: 'pariatur', - port: 16204, + host: 'magna', + port: 62049, user: 'user', password: 'password', path: 'path', @@ -119,7 +120,7 @@ import { }; const createContainer: CreateContainer = { - image: 'velit qui cillum veniam ullamco', + image: 'voluptate officia adipisicing', resources: containerResourceRequirements, command: ['command'], priority: containerGroupPriority, @@ -136,7 +137,7 @@ import { const createContainerGroupNetworking: CreateContainerGroupNetworking = { protocol: containerNetworkingProtocol, - port: 19760, + port: 9813, auth: true, }; @@ -209,19 +210,29 @@ import { queueName: 'nnz26lyemw7nednorlqjlsihb42092pn8d', }; + const queueAutoscaler: QueueAutoscaler = { + minReplicas: 57, + maxReplicas: 24, + desiredQueueLength: 20, + pollingPeriod: 1406, + maxUpscalePerMinute: 35, + maxDownscalePerMinute: 42, + }; + const createContainerGroup: CreateContainerGroup = { - name: 'oh2mpxyfojt-6cco', - displayName: 'HoT', + name: 'qfojt-6ccoil4t55-ccoyybgw92dermtsdfn3t2xmag', + displayName: 'O0hSlJUW', container: createContainer, autostartPolicy: true, restartPolicy: containerRestartPolicy, - replicas: 225, + replicas: 114, countryCodes: [countryCode], networking: createContainerGroupNetworking, livenessProbe: containerGroupLivenessProbe, readinessProbe: containerGroupReadinessProbe, startupProbe: containerGroupStartupProbe, queueConnection: containerGroupQueueConnection, + queueAutoscaler: queueAutoscaler, }; const { data } = await saladCloudSdk.containerGroups.createContainerGroup( diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-delete.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-delete.md index 235c35a..3b6a344 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-delete.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-delete.md @@ -7,9 +7,9 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.containerGroups.deleteContainerGroup( - 'ob3ca5hduqlb1uzytbhhukf1u0-ahl0b9oqfjj0q', - 'x7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lx71', - 'cif9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrm0urjjj5b9hbe2fr6f', + 'gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw', + 'xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz', + 'ojjj5b9hbe2fr6f5t7j1htjaws1zx3r', ); console.log(data); diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-errors-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-errors-get.md index 8ed56cb..ff92ce3 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-errors-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-errors-get.md @@ -7,9 +7,9 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.workloadErrors.getWorkloadErrors( - 'kr8pje-v4-ccp8q-329szw31h4fee237cnffybnugpd7nbngr', - 'vjne2vq5j0d2m4f21ex5ozb1-4j-you0d7uftlpfgcaqa-2oc58y844mz', - 'jpqhlkkgd', + 'u9szw31h4fee237cnffybnugpd7nbngs47jne2vq5j0d2m4f20', + 'c5ozb1-4j-you0d7uftlpfgcaqa-2oc58y844m0ne', + 'khlkkgda39h5upyur493wxwbxrj4x', ); console.log(data); diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-get.md index 6dc84cd..9d620ab 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-get.md @@ -7,9 +7,9 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.containerGroups.getContainerGroup( - 'ob3ca5hduqlb1uzytbhhukf1u0-ahl0b9oqfjj0q', - 'x7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lx71', - 'cif9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrm0urjjj5b9hbe2fr6f', + 'gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw', + 'xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz', + 'ojjj5b9hbe2fr6f5t7j1htjaws1zx3r', ); console.log(data); diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-patch.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-patch.md index 75e90c3..9dbbe2d 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-patch.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-patch.md @@ -17,17 +17,17 @@ import { const resources: Resources = { cpu: 11, - memory: 1557, + memory: 21424, gpuClasses: ['gpu_classes'], - storageAmount: 40250176413, + storageAmount: 12333132242, }; const containerGroupPriority = ContainerGroupPriority.HIGH; const loggingAxiom3: LoggingAxiom3 = { - host: 'nisi et veniam', - apiToken: 'Lorem esse dolor', - dataset: 'et commodo Duis', + host: 'commodo ea exercitation pariatur consequat', + apiToken: 'ipsum', + dataset: 'id Excepteur', }; const datadogTags3: DatadogTags3 = { @@ -36,24 +36,24 @@ import { }; const loggingDatadog3: LoggingDatadog3 = { - host: 'veniam deserunt sunt dolore', - apiKey: 'ullamco occaecat nostrud irure', + host: 'exercitation aliquip', + apiKey: 'veniam', tags: [datadogTags3], }; const loggingNewRelic3: LoggingNewRelic3 = { - host: 'dolor adipisicing eu dolore incididunt', - ingestionKey: 'aliqua', + host: 'amet velit sed cillum', + ingestionKey: 'et', }; const loggingSplunk3: LoggingSplunk3 = { - host: 'enim incididunt', - token: 'Lorem Duis ipsum et', + host: 'proident', + token: 'est', }; const loggingTcp3: LoggingTcp3 = { - host: 'qui in cupidatat deserunt cillum', - port: 39897, + host: 'ut velit ea cillum', + port: 13557, }; const httpFormat3 = HttpFormat3.JSON; @@ -66,8 +66,8 @@ import { const httpCompression3 = HttpCompression3.NONE; const loggingHttp3: LoggingHttp3 = { - host: 'nostrud ea dolore', - port: 52587, + host: 'nisi fugiat cupidatat', + port: 60288, user: 'user', password: 'password', path: 'path', @@ -117,7 +117,7 @@ import { }; const updateContainer: UpdateContainer = { - image: 'culpa nulla eu non', + image: 'ex cillum dolor', resources: resources, command: ['command'], priority: containerGroupPriority, @@ -129,7 +129,7 @@ import { const countryCode = CountryCode.AF; const updateContainerGroupNetworking: UpdateContainerGroupNetworking = { - port: 60033, + port: 64823, }; const containerGroupProbeTcp: ContainerGroupProbeTcp = { @@ -196,9 +196,9 @@ import { }; const updateContainerGroup: UpdateContainerGroup = { - displayName: 'UtDi9VD ZS', + displayName: '-xzxtaW.t2I', container: updateContainer, - replicas: 183, + replicas: 110, countryCodes: [countryCode], networking: updateContainerGroupNetworking, livenessProbe: containerGroupLivenessProbe, @@ -207,9 +207,9 @@ import { }; const { data } = await saladCloudSdk.containerGroups.updateContainerGroup( - 'ob3ca5hduqlb1uzytbhhukf1u0-ahl0b9oqfjj0q', - 'x7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lx71', - 'cif9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrm0urjjj5b9hbe2fr6f', + 'gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw', + 'xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz', + 'ojjj5b9hbe2fr6f5t7j1htjaws1zx3r', input, ); diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-start-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-start-post.md index d061f02..23fb20b 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-start-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-start-post.md @@ -7,7 +7,7 @@ import { SaladCloudSdk } from '@saladtechnologies-oss/salad-cloud-sdk'; }); const { data } = await saladCloudSdk.containerGroups.startContainerGroup( - 'uh5upyur493wxwbxrj4xt9wfx07sgyz1fs97sfhtue78-54vdogp2qrcnt-8a', + 'zfx07sgyz1fs97sfhtue78-54vdogp2qrcnt-8a', 'v7jhy3jn2rdf012fi7ouno3mk9', 'a4d0ajj5ajjquzeg-z3kvqxtnoxnlzhjhjt-8naw', ); diff --git a/examples/package.json b/examples/package.json index 5facdfa..dbdacf8 100644 --- a/examples/package.json +++ b/examples/package.json @@ -1,6 +1,6 @@ { "name": "salad-cloud-sdk", - "version": "0.9.0-alpha.1", + "version": "0.9.0-alpha.2", "private": true, "dependencies": { "@saladtechnologies-oss/salad-cloud-sdk": "file:../", diff --git a/examples/tsconfig.json b/examples/tsconfig.json index 78eb691..7f034f1 100644 --- a/examples/tsconfig.json +++ b/examples/tsconfig.json @@ -15,7 +15,7 @@ "isolatedModules": true, "allowSyntheticDefaultImports": true, "declarationMap": true, - "lib": ["es2017", "dom"], + "lib": ["es2018", "dom"], "sourceMap": true }, "include": ["src/"] diff --git a/package-lock.json b/package-lock.json index 72a12eb..987dacc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@saladtechnologies-oss/salad-cloud-sdk", - "version": "0.9.0-alpha.1", + "version": "0.9.0-alpha.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@saladtechnologies-oss/salad-cloud-sdk", - "version": "0.9.0-alpha.1", + "version": "0.9.0-alpha.2", "license": "MIT", "dependencies": { "zod": "3.22.0" @@ -511,9 +511,9 @@ } }, "node_modules/ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", + "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", "dev": true, "license": "MIT", "engines": { @@ -707,13 +707,13 @@ } }, "node_modules/debug": { - "version": "4.3.6", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.6.tgz", - "integrity": "sha512-O/09Bd4Z1fBrU4VzkhFqVgpPzaGbw6Sm9FEkBT1A/YBXQFGuuSxa1dN2nxgxS34JmKXqYx8CZAwEVoJFImUXIg==", + "version": "4.3.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", + "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", "dev": true, "license": "MIT", "dependencies": { - "ms": "2.1.2" + "ms": "^2.1.3" }, "engines": { "node": ">=6.0" @@ -1197,9 +1197,9 @@ } }, "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "dev": true, "license": "MIT" }, diff --git a/package.json b/package.json index 3e89ca1..7b45906 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,13 @@ { "name": "@saladtechnologies-oss/salad-cloud-sdk", - "version": "0.9.0-alpha.1", + "version": "0.9.0-alpha.2", "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/commonjs/index.js", - "module": "./dist/esm/index.js", - "browser": "./dist/index.umd.js", - "unpkg": "./dist/index.umd.js", - "types": "./dist/commonjs/index.d.ts", + "main": "./dist/index.js", + "module": "./dist/index.mjs", + "browser": "./dist/index.js", + "unpkg": "./dist/index.js", + "types": "./dist/index.d.ts", "scripts": { "test": "tsc --noEmit", "build": "tsup-node src/index.ts --format cjs,esm --dts --clean", diff --git a/src/http/client.ts b/src/http/client.ts index d4b0efc..eed19d5 100644 --- a/src/http/client.ts +++ b/src/http/client.ts @@ -29,6 +29,19 @@ export class HttpClient { return this.requestHandlerChain.callChain(request); } + public async callPaginated(request: Request): Promise> { + const response = await this.call(request as any); + + if (!response.data) { + throw new Error('now response data to paginate through'); + } + + return { + ...response, + data: this.getPage(request, response.data), + }; + } + setBaseUrl(url: string): void { this.config.baseUrl = url; } @@ -36,4 +49,23 @@ export class HttpClient { setConfig(config: SdkConfig): void { this.config = config; } + + private getPage(request: Request, data: FullResponse): Page { + if (!request.pagination) { + throw new Error('getPage called for request without pagination property'); + } + + let curr: any = data; + for (const segment of request.pagination?.pagePath || []) { + curr = curr[segment]; + } + + const page = request.pagination?.pageSchema?.parse(curr); + if (!page) { + throw new Error( + `error getting page data. Curr: ${JSON.stringify(curr)}. PagePath: ${request.pagination?.pagePath}. Data: ${JSON.stringify(data)}`, + ); + } + return page; + } } diff --git a/src/http/handlers/auth-handler.ts b/src/http/handlers/auth-handler.ts index 06f6be0..8454647 100644 --- a/src/http/handlers/auth-handler.ts +++ b/src/http/handlers/auth-handler.ts @@ -28,6 +28,8 @@ export class AuthHandler implements RequestHandler { explode: false, encode: false, style: SerializationStyle.SIMPLE, + isLimit: false, + isOffset: false, }); return request; diff --git a/src/http/hooks/hook.ts b/src/http/hooks/hook.ts index 9ca2433..946832e 100644 --- a/src/http/hooks/hook.ts +++ b/src/http/hooks/hook.ts @@ -1,4 +1,4 @@ -type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD'; export interface HttpRequest { baseUrl: string; diff --git a/src/http/index.ts b/src/http/index.ts index 84ea249..82bf7c7 100644 --- a/src/http/index.ts +++ b/src/http/index.ts @@ -1 +1,9 @@ -export type { SdkConfig, RequestConfig, RetryOptions, ValidationOptions } from './types.ts'; +export type { + SdkConfig, + RequestConfig, + RetryOptions, + ValidationOptions, + HttpMetadata, + HttpMethod, + HttpResponse, +} from './types.ts'; diff --git a/src/http/transport/request-builder.ts b/src/http/transport/request-builder.ts index a860fdd..3d49a5a 100644 --- a/src/http/transport/request-builder.ts +++ b/src/http/transport/request-builder.ts @@ -1,11 +1,11 @@ import z, { ZodType } from 'zod'; -import { Request, CreateRequestParameters, RequestParameter } from './request'; +import { Request, CreateRequestParameters, RequestParameter, RequestPagination } from './request'; import { ContentType, HttpMethod, SdkConfig, RequestConfig, RetryOptions, ValidationOptions } from '../types'; import { Environment } from '../environment'; import { SerializationStyle } from '../serialization/base-serializer'; -export class RequestBuilder { - private params: CreateRequestParameters; +export class RequestBuilder { + private params: CreateRequestParameters; constructor() { this.params = { @@ -30,7 +30,7 @@ export class RequestBuilder { }; } - setRetryAttempts(sdkConfig?: SdkConfig, requestConfig?: RequestConfig): RequestBuilder { + setRetryAttempts(sdkConfig?: SdkConfig, requestConfig?: RequestConfig): RequestBuilder { if (requestConfig?.retry?.attempts !== undefined) { this.params.retry.attempts = requestConfig.retry.attempts; } else if (sdkConfig?.retry?.attempts !== undefined) { @@ -40,7 +40,7 @@ export class RequestBuilder { return this; } - setRetryDelayMs(sdkConfig?: SdkConfig, requestConfig?: RequestConfig): RequestBuilder { + setRetryDelayMs(sdkConfig?: SdkConfig, requestConfig?: RequestConfig): RequestBuilder { if (requestConfig?.retry?.delayMs !== undefined) { this.params.retry.delayMs = requestConfig.retry.delayMs; } else if (sdkConfig?.retry?.delayMs !== undefined) { @@ -50,7 +50,7 @@ export class RequestBuilder { return this; } - setResponseValidation(sdkConfig: SdkConfig, requestConfig?: RequestConfig): RequestBuilder { + setResponseValidation(sdkConfig: SdkConfig, requestConfig?: RequestConfig): RequestBuilder { if (requestConfig?.validation?.responseValidation !== undefined) { this.params.validation.responseValidation = requestConfig.validation.responseValidation; } else if (sdkConfig?.validation?.responseValidation !== undefined) { @@ -60,7 +60,7 @@ export class RequestBuilder { return this; } - setBaseUrl(sdkConfig: SdkConfig): RequestBuilder { + setBaseUrl(sdkConfig: SdkConfig): RequestBuilder { if (sdkConfig?.baseUrl !== undefined) { this.params.baseUrl = sdkConfig.baseUrl; } @@ -68,49 +68,54 @@ export class RequestBuilder { return this; } - setMethod(method: HttpMethod): RequestBuilder { + setMethod(method: HttpMethod): RequestBuilder { this.params.method = method; return this; } - setPath(path: string): RequestBuilder { + setPath(path: string): RequestBuilder { this.params.path = path; return this; } - setConfig(config: SdkConfig): RequestBuilder { + setConfig(config: SdkConfig): RequestBuilder { this.params.config = config; return this; } - setRequestContentType(contentType: ContentType): RequestBuilder { + setRequestContentType(contentType: ContentType): RequestBuilder { this.params.requestContentType = contentType; return this; } - setResponseContentType(contentType: ContentType): RequestBuilder { + setResponseContentType(contentType: ContentType): RequestBuilder { this.params.responseContentType = contentType; return this; } - setRequestSchema(requestSchema: ZodType): RequestBuilder { + setRequestSchema(requestSchema: ZodType): RequestBuilder { this.params.requestSchema = requestSchema; return this; } - setResponseSchema(responseSchema: ZodType): RequestBuilder { + setResponseSchema(responseSchema: ZodType): RequestBuilder { this.params.responseSchema = responseSchema; return this; } - addBody(body?: any): RequestBuilder { + setPagination(pagination: RequestPagination): RequestBuilder { + this.params.pagination = pagination; + return this; + } + + addBody(body?: any): RequestBuilder { if (body !== undefined) { this.params.body = body; } return this; } - addPathParam(param: Partial): RequestBuilder { + addPathParam(param: Partial): RequestBuilder { if (param.value === undefined || param.key === undefined) { return this; } @@ -121,12 +126,14 @@ export class RequestBuilder { explode: param.explode ?? true, style: param.style ?? SerializationStyle.SIMPLE, encode: param.encode ?? true, + isLimit: !!param.isLimit, + isOffset: !!param.isOffset, }); return this; } - addQueryParam(param: Partial): RequestBuilder { + addQueryParam(param: Partial): RequestBuilder { if (param.value === undefined || param.key === undefined) { return this; } @@ -137,12 +144,14 @@ export class RequestBuilder { explode: param.explode ?? true, style: param.style ?? SerializationStyle.FORM, encode: param.encode ?? true, + isLimit: !!param.isLimit, + isOffset: !!param.isOffset, }); return this; } - addHeaderParam(param: Partial): RequestBuilder { + addHeaderParam(param: Partial): RequestBuilder { if (param.value === undefined || param.key === undefined) { return this; } @@ -153,12 +162,14 @@ export class RequestBuilder { explode: param.explode ?? true, style: param.style ?? SerializationStyle.SIMPLE, encode: param.encode ?? false, + isLimit: !!param.isLimit, + isOffset: !!param.isOffset, }); return this; } - public build(): Request { - return new Request(this.params); + public build(): Request { + return new Request(this.params); } } diff --git a/src/http/transport/request.ts b/src/http/transport/request.ts index 92d5648..7d0e10b 100644 --- a/src/http/transport/request.ts +++ b/src/http/transport/request.ts @@ -6,7 +6,7 @@ import { HeaderSerializer } from '../serialization/header-serializer'; import { HttpRequest } from '../hooks/hook'; import { SerializationStyle } from '../serialization/base-serializer'; -export interface CreateRequestParameters { +export interface CreateRequestParameters { baseUrl: string; method: HttpMethod; body?: any; @@ -15,12 +15,13 @@ export interface CreateRequestParameters { pathParams: Map; path: string; config: SdkConfig; - responseSchema: ZodType; + responseSchema: ZodType; requestSchema: ZodType; requestContentType: ContentType; responseContentType: ContentType; validation: ValidationOptions; retry: RetryOptions; + pagination?: RequestPagination; } export interface RequestParameter { @@ -29,9 +30,17 @@ export interface RequestParameter { explode: boolean; encode: boolean; style: SerializationStyle; + isLimit: boolean; + isOffset: boolean; } -export class Request { +export interface RequestPagination { + pageSize: number; + pagePath: string[]; + pageSchema?: ZodType; +} + +export class Request { public baseUrl: string = ''; public headers: Map = new Map(); @@ -60,9 +69,11 @@ export class Request { public retry: RetryOptions = {} as any; + public pagination?: RequestPagination; + private readonly pathPattern: string; - constructor(params: CreateRequestParameters) { + constructor(params: CreateRequestParameters) { this.baseUrl = params.baseUrl; this.method = params.method; this.pathPattern = params.path; @@ -78,6 +89,7 @@ export class Request { this.responseContentType = params.responseContentType; this.retry = params.retry; this.validation = params.validation; + this.pagination = params.pagination; } addHeaderParam(key: string, param: RequestParameter): void { @@ -203,7 +215,43 @@ export class Request { return new HeaderSerializer().serialize(this.headers); } + public nextPage() { + if (!this.pagination) { + return; + } + + const offsetParam = this.getOffsetParam(); + if (!offsetParam) { + return; + } + + offsetParam.value = Number(offsetParam.value) + this.pagination.pageSize; + } + private constructPath(): string { return new PathSerializer().serialize(this.pathPattern, this.pathParams); } + + private getOffsetParam(): RequestParameter | undefined { + const offsetParam = this.getAllParams().find((param) => param.isOffset); + return offsetParam; + } + + private getAllParams(): RequestParameter[] { + const allParams: RequestParameter[] = []; + + this.headers.forEach((val, key) => { + allParams.push(val); + }); + + this.queryParams.forEach((val, key) => { + allParams.push(val); + }); + + this.pathParams.forEach((val, key) => { + allParams.push(val); + }); + + return allParams; + } } diff --git a/src/http/transport/transport-hook-adapter.ts b/src/http/transport/transport-hook-adapter.ts index 82f30d3..7634368 100644 --- a/src/http/transport/transport-hook-adapter.ts +++ b/src/http/transport/transport-hook-adapter.ts @@ -78,6 +78,8 @@ export class TransportHookAdapter { encode: requestParam?.encode ?? false, style: requestParam?.style || SerializationStyle.NONE, explode: requestParam?.explode ?? false, + isLimit: requestParam?.isLimit ?? false, + isOffset: requestParam?.isOffset ?? false, }); }); return transportParams; diff --git a/src/http/types.ts b/src/http/types.ts index 68d6776..21dcb18 100644 --- a/src/http/types.ts +++ b/src/http/types.ts @@ -2,7 +2,7 @@ import { ZodType } from 'zod'; import { Environment } from './environment'; import { Request } from './transport/request'; -export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD'; export interface SdkConfig { baseUrl?: string; diff --git a/src/index.ts b/src/index.ts index 62b4644..b2b28b1 100644 --- a/src/index.ts +++ b/src/index.ts @@ -15,6 +15,7 @@ export * from './services/quotas'; export * from './services/inference-endpoints'; export * from './services/organization-data'; export * from './services/webhook-secret-key'; +export * from './services/common'; export type * from './http'; diff --git a/src/services/common/container-group.ts b/src/services/common/container-group.ts index dd47bfc..f927af5 100644 --- a/src/services/common/container-group.ts +++ b/src/services/common/container-group.ts @@ -26,6 +26,7 @@ import { containerGroupQueueConnectionRequest, containerGroupQueueConnectionResponse, } from './container-group-queue-connection'; +import { queueAutoscaler, queueAutoscalerRequest, queueAutoscalerResponse } from './queue-autoscaler'; /** * The shape of the model inside the application code - what the users use @@ -58,6 +59,7 @@ export const containerGroup = z.lazy(() => { updateTime: z.string(), pendingChange: z.boolean(), version: z.number().gte(1), + queueAutoscaler: queueAutoscaler.optional(), }); }); @@ -82,6 +84,7 @@ export const containerGroup = z.lazy(() => { * @property {string} * @property {boolean} * @property {number} + * @property {QueueAutoscaler} - Represents the autoscaling rules for a queue */ export type ContainerGroup = z.infer; @@ -118,6 +121,7 @@ export const containerGroupResponse = z.lazy(() => { update_time: z.string(), pending_change: z.boolean(), version: z.number().gte(1), + queue_autoscaler: queueAutoscalerResponse.optional(), }) .transform((data) => ({ id: data['id'], @@ -138,6 +142,7 @@ export const containerGroupResponse = z.lazy(() => { updateTime: data['update_time'], pendingChange: data['pending_change'], version: data['version'], + queueAutoscaler: data['queue_autoscaler'], })); }); @@ -166,6 +171,7 @@ export const containerGroupRequest = z.lazy(() => { updateTime: z.string().nullish(), pendingChange: z.boolean().nullish(), version: z.number().nullish(), + queueAutoscaler: queueAutoscalerRequest.nullish(), }) .transform((data) => ({ id: data['id'], @@ -186,5 +192,6 @@ export const containerGroupRequest = z.lazy(() => { update_time: data['updateTime'], pending_change: data['pendingChange'], version: data['version'], + queue_autoscaler: data['queueAutoscaler'], })); }); diff --git a/src/services/common/index.ts b/src/services/common/index.ts index 5cf66da..8bb0c55 100644 --- a/src/services/common/index.ts +++ b/src/services/common/index.ts @@ -8,6 +8,7 @@ export type { ContainerGroupLivenessProbe } from './container-group-liveness-pro export type { ContainerGroupReadinessProbe } from './container-group-readiness-probe'; export type { ContainerGroupStartupProbe } from './container-group-startup-probe'; export type { ContainerGroupQueueConnection } from './container-group-queue-connection'; +export type { QueueAutoscaler } from './queue-autoscaler'; export type { ContainerResourceRequirements } from './container-resource-requirements'; export { ContainerGroupPriority } from './container-group-priority'; export type { ContainerLogging } from './container-logging'; diff --git a/src/services/common/queue-autoscaler.ts b/src/services/common/queue-autoscaler.ts new file mode 100644 index 0000000..07004da --- /dev/null +++ b/src/services/common/queue-autoscaler.ts @@ -0,0 +1,75 @@ +import { z } from 'zod'; + +/** + * The shape of the model inside the application code - what the users use + */ +export const queueAutoscaler = z.lazy(() => { + return z.object({ + minReplicas: z.number().gte(0).lte(100), + maxReplicas: z.number().gte(1).lte(100), + desiredQueueLength: z.number().gte(1).lte(100), + pollingPeriod: z.number().gte(15).lte(1800).optional(), + maxUpscalePerMinute: z.number().gte(1).lte(100).optional(), + maxDownscalePerMinute: z.number().gte(1).lte(100).optional(), + }); +}); + +/** + * Represents the autoscaling rules for a queue + * @typedef {QueueAutoscaler} queueAutoscaler - Represents the autoscaling rules for a queue - Represents the autoscaling rules for a queue + * @property {number} + * @property {number} + * @property {number} + * @property {number} + * @property {number} + * @property {number} + */ +export type QueueAutoscaler = z.infer; + +/** + * The shape of the model mapping from the api schema into the application shape. + * Is equal to application shape if all property names match the api schema + */ +export const queueAutoscalerResponse = z.lazy(() => { + return z + .object({ + min_replicas: z.number().gte(0).lte(100), + max_replicas: z.number().gte(1).lte(100), + 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(), + max_downscale_per_minute: z.number().gte(1).lte(100).optional(), + }) + .transform((data) => ({ + minReplicas: data['min_replicas'], + maxReplicas: data['max_replicas'], + desiredQueueLength: data['desired_queue_length'], + pollingPeriod: data['polling_period'], + maxUpscalePerMinute: data['max_upscale_per_minute'], + maxDownscalePerMinute: data['max_downscale_per_minute'], + })); +}); + +/** + * The shape of the model mapping from the application shape into the api schema. + * Is equal to application shape if all property names match the api schema + */ +export const queueAutoscalerRequest = z.lazy(() => { + return z + .object({ + minReplicas: z.number().nullish(), + maxReplicas: z.number().nullish(), + desiredQueueLength: z.number().nullish(), + pollingPeriod: z.number().nullish(), + maxUpscalePerMinute: z.number().nullish(), + maxDownscalePerMinute: z.number().nullish(), + }) + .transform((data) => ({ + min_replicas: data['minReplicas'], + max_replicas: data['maxReplicas'], + desired_queue_length: data['desiredQueueLength'], + polling_period: data['pollingPeriod'], + max_upscale_per_minute: data['maxUpscalePerMinute'], + max_downscale_per_minute: data['maxDownscalePerMinute'], + })); +}); diff --git a/src/services/container-groups/container-groups.ts b/src/services/container-groups/container-groups.ts index 6cea4f0..78daa68 100644 --- a/src/services/container-groups/container-groups.ts +++ b/src/services/container-groups/container-groups.ts @@ -23,8 +23,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/containers') .setRequestSchema(z.any()) @@ -59,8 +59,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/projects/{project_name}/containers') .setRequestSchema(createContainerGroupRequest) @@ -98,8 +98,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}') .setRequestSchema(z.any()) @@ -140,8 +140,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('PATCH') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}') .setRequestSchema(updateContainerGroupRequest) @@ -183,8 +183,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('DELETE') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}') .setRequestSchema(z.any()) @@ -224,8 +224,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/start') .setRequestSchema(z.any()) @@ -265,8 +265,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/stop') .setRequestSchema(z.any()) @@ -293,7 +293,7 @@ export class ContainerGroupsService extends BaseService { } /** - * Retrieves a list of container group instances + * Gets the list of container group instances * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} containerGroupName - The unique container group name @@ -306,8 +306,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances') .setRequestSchema(z.any()) @@ -334,7 +334,7 @@ export class ContainerGroupsService extends BaseService { } /** - * Retrieves the details of a single instance within a container group by instance ID + * Gets a container group instance * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} containerGroupName - The unique container group name @@ -349,8 +349,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath( '/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}', @@ -383,7 +383,7 @@ export class ContainerGroupsService extends BaseService { } /** - * Remove a node from a workload and reallocate the workload to a different node + * Reallocates a container group instance to run on a different Salad Node * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} containerGroupName - The unique container group name @@ -398,8 +398,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath( '/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}/reallocate', @@ -432,7 +432,7 @@ export class ContainerGroupsService extends BaseService { } /** - * Stops a container, destroys it, creates a new one without requiring the image to be downloaded again on a different node + * Stops a container, destroys it, and starts a new one without requiring the image to be downloaded again on a new Salad Node * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} containerGroupName - The unique container group name @@ -447,8 +447,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath( '/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}/recreate', @@ -481,7 +481,7 @@ export class ContainerGroupsService extends BaseService { } /** - * Restarts a workload on a node without reallocating it + * Stops a container and restarts it on the same Salad Node * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} containerGroupName - The unique container group name @@ -496,8 +496,8 @@ export class ContainerGroupsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath( '/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}/restart', diff --git a/src/services/container-groups/models/create-container-group.ts b/src/services/container-groups/models/create-container-group.ts index 3912f45..e345c98 100644 --- a/src/services/container-groups/models/create-container-group.ts +++ b/src/services/container-groups/models/create-container-group.ts @@ -25,6 +25,7 @@ import { containerGroupQueueConnectionRequest, containerGroupQueueConnectionResponse, } from '../../common/container-group-queue-connection'; +import { queueAutoscaler, queueAutoscalerRequest, queueAutoscalerResponse } from '../../common/queue-autoscaler'; /** * The shape of the model inside the application code - what the users use @@ -53,6 +54,7 @@ export const createContainerGroup = z.lazy(() => { readinessProbe: containerGroupReadinessProbe.optional().nullable(), startupProbe: containerGroupStartupProbe.optional().nullable(), queueConnection: containerGroupQueueConnection.optional().nullable(), + queueAutoscaler: queueAutoscaler.optional(), }); }); @@ -71,6 +73,7 @@ export const createContainerGroup = z.lazy(() => { * @property {ContainerGroupReadinessProbe} - Represents the container group readiness probe * @property {ContainerGroupStartupProbe} - Represents the container group startup probe * @property {ContainerGroupQueueConnection} - Represents container group queue connection + * @property {QueueAutoscaler} - Represents the autoscaling rules for a queue */ export type CreateContainerGroup = z.infer; @@ -103,6 +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(), }) .transform((data) => ({ name: data['name'], @@ -117,6 +121,7 @@ export const createContainerGroupResponse = z.lazy(() => { readinessProbe: data['readiness_probe'], startupProbe: data['startup_probe'], queueConnection: data['queue_connection'], + queueAutoscaler: data['queue_autoscaler'], })); }); @@ -139,6 +144,7 @@ export const createContainerGroupRequest = z.lazy(() => { readinessProbe: containerGroupReadinessProbeRequest.nullish(), startupProbe: containerGroupStartupProbeRequest.nullish(), queueConnection: containerGroupQueueConnectionRequest.nullish(), + queueAutoscaler: queueAutoscalerRequest.nullish(), }) .transform((data) => ({ name: data['name'], @@ -153,5 +159,6 @@ export const createContainerGroupRequest = z.lazy(() => { readiness_probe: data['readinessProbe'], startup_probe: data['startupProbe'], queue_connection: data['queueConnection'], + queue_autoscaler: data['queueAutoscaler'], })); }); diff --git a/src/services/inference-endpoints/inference-endpoints.ts b/src/services/inference-endpoints/inference-endpoints.ts index b46317e..84cc0e4 100644 --- a/src/services/inference-endpoints/inference-endpoints.ts +++ b/src/services/inference-endpoints/inference-endpoints.ts @@ -12,7 +12,7 @@ import { InferenceEndpointJob, inferenceEndpointJobResponse } from './models/inf export class InferenceEndpointsService extends BaseService { /** - * Gets the list of all inference endpoints + * Gets the list of inference endpoints * @param {string} organizationName - 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. * @param {number} [page] - The page number * @param {number} [pageSize] - The number of items per page @@ -24,8 +24,8 @@ export class InferenceEndpointsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/inference-endpoints') .setRequestSchema(z.any()) @@ -63,8 +63,8 @@ export class InferenceEndpointsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}') .setRequestSchema(z.any()) @@ -101,8 +101,8 @@ export class InferenceEndpointsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs') .setRequestSchema(z.any()) @@ -145,8 +145,8 @@ export class InferenceEndpointsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs') .setRequestSchema(createInferenceEndpointJobRequest) @@ -184,8 +184,8 @@ export class InferenceEndpointsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath( '/organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs/{inference_endpoint_job_id}', @@ -227,8 +227,8 @@ export class InferenceEndpointsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('DELETE') .setPath( '/organizations/{organization_name}/inference-endpoints/{inference_endpoint_name}/jobs/{inference_endpoint_job_id}', diff --git a/src/services/organization-data/organization-data.ts b/src/services/organization-data/organization-data.ts index f3580a9..6366d28 100644 --- a/src/services/organization-data/organization-data.ts +++ b/src/services/organization-data/organization-data.ts @@ -13,8 +13,8 @@ export class OrganizationDataService extends BaseService { */ async listGpuClasses(organizationName: string, requestConfig?: RequestConfig): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/gpu-classes') .setRequestSchema(z.any()) diff --git a/src/services/queues/queues.ts b/src/services/queues/queues.ts index c5dc527..a8dde88 100644 --- a/src/services/queues/queues.ts +++ b/src/services/queues/queues.ts @@ -25,8 +25,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/queues') .setRequestSchema(z.any()) @@ -61,8 +61,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/projects/{project_name}/queues') .setRequestSchema(createQueueRequest) @@ -100,8 +100,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}') .setRequestSchema(z.any()) @@ -142,8 +142,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('PATCH') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}') .setRequestSchema(updateQueueRequest) @@ -185,8 +185,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('DELETE') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}') .setRequestSchema(z.any()) @@ -213,7 +213,7 @@ export class QueuesService extends BaseService { } /** - * Retrieves a list of queue jobs + * Gets the list of jobs in a queue * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} queueName - The queue name. @@ -229,8 +229,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs') .setRequestSchema(z.any()) @@ -279,8 +279,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs') .setRequestSchema(createQueueJobRequest) @@ -309,7 +309,7 @@ export class QueuesService extends BaseService { } /** - * Retrieves a job in a queue + * Gets a job in a queue * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} queueName - The queue name. @@ -324,8 +324,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs/{queue_job_id}') .setRequestSchema(z.any()) @@ -356,7 +356,7 @@ export class QueuesService extends BaseService { } /** - * Deletes a queue job + * Cancels a job in a queue * @param {string} organizationName - 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. * @param {string} projectName - Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. * @param {string} queueName - The queue name. @@ -371,8 +371,8 @@ export class QueuesService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('DELETE') .setPath('/organizations/{organization_name}/projects/{project_name}/queues/{queue_name}/jobs/{queue_job_id}') .setRequestSchema(z.any()) diff --git a/src/services/quotas/quotas.ts b/src/services/quotas/quotas.ts index 5bea215..ec65785 100644 --- a/src/services/quotas/quotas.ts +++ b/src/services/quotas/quotas.ts @@ -13,8 +13,8 @@ export class QuotasService extends BaseService { */ async getQuotas(organizationName: string, requestConfig?: RequestConfig): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/quotas') .setRequestSchema(z.any()) diff --git a/src/services/webhook-secret-key/webhook-secret-key.ts b/src/services/webhook-secret-key/webhook-secret-key.ts index 5f5f4a0..c99b60c 100644 --- a/src/services/webhook-secret-key/webhook-secret-key.ts +++ b/src/services/webhook-secret-key/webhook-secret-key.ts @@ -16,8 +16,8 @@ export class WebhookSecretKeyService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/webhook-secret-key') .setRequestSchema(z.any()) @@ -45,8 +45,8 @@ export class WebhookSecretKeyService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('POST') .setPath('/organizations/{organization_name}/webhook-secret-key') .setRequestSchema(z.any()) diff --git a/src/services/workload-errors/workload-errors.ts b/src/services/workload-errors/workload-errors.ts index 5e989c9..d4e60b3 100644 --- a/src/services/workload-errors/workload-errors.ts +++ b/src/services/workload-errors/workload-errors.ts @@ -20,8 +20,8 @@ export class WorkloadErrorsService extends BaseService { requestConfig?: RequestConfig, ): Promise> { const request = new RequestBuilder() - .setConfig(this.config) .setBaseUrl(this.config) + .setConfig(this.config) .setMethod('GET') .setPath('/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/errors') .setRequestSchema(z.any()) diff --git a/tsconfig.json b/tsconfig.json index 78eb691..7f034f1 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -15,7 +15,7 @@ "isolatedModules": true, "allowSyntheticDefaultImports": true, "declarationMap": true, - "lib": ["es2017", "dom"], + "lib": ["es2018", "dom"], "sourceMap": true }, "include": ["src/"]