diff --git a/.manifest.json b/.manifest.json index 49303cb..ba4e0f8 100644 --- a/.manifest.json +++ b/.manifest.json @@ -1,10 +1,10 @@ { - "liblabVersion": "2.1.30", - "date": "2024-09-01T16:26:41.730Z", + "liblabVersion": "2.2.0", + "date": "2024-09-11T04:10:25.858Z", "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": ["python"], @@ -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" @@ -298,7 +298,7 @@ } ], "githubRepoName": "salad-cloud-sdk-python", - "ignoreFiles": [".gitignore", "LICENSE"], + "ignoreFiles": [".gitignore", "./LICENSE"], "targetBranch": "main", "language": "python", "deliveryMethod": "zip", @@ -364,7 +364,6 @@ ".env.example", "/examples/.env.example", "src/salad_cloud_sdk/services/utils/default_headers.py", - "./LICENSE", ".devcontainer/devcontainer.json", "documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md", "documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-post.md", @@ -425,6 +424,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", @@ -486,6 +486,7 @@ "src/salad_cloud_sdk/models/container_group_readiness_probe.py", "src/salad_cloud_sdk/models/container_group_startup_probe.py", "src/salad_cloud_sdk/models/container_group_queue_connection.py", + "src/salad_cloud_sdk/models/queue_autoscaler.py", "src/salad_cloud_sdk/models/container_resource_requirements.py", "src/salad_cloud_sdk/models/container_group_instance_status_count.py", "src/salad_cloud_sdk/models/container_group_probe_tcp.py", @@ -510,6 +511,7 @@ "documentation/services/InferenceEndpointsService.md", "README.md", "documentation/services/QueuesService.md", + "PyPI_README.md", "src/salad_cloud_sdk/services/inference_endpoints.py", "documentation/models/Container.md", "documentation/services/ContainerGroupsService.md", diff --git a/PyPI_README.md b/PyPI_README.md new file mode 100644 index 0000000..33813dd --- /dev/null +++ b/PyPI_README.md @@ -0,0 +1,184 @@ +# SaladCloudSdk Python 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.2` +- SDK version: `0.9.0-alpha.2` + +## About the API + +The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details. + +## Table of Contents + +- [Setup & Configuration](#setup--configuration) + - [Supported Language Versions](#supported-language-versions) + - [Installation](#installation) +- [Authentication](#authentication) + - [API Key Authentication](#api-key-authentication) +- [Setting a Custom Timeout](#setting-a-custom-timeout) +- [Sample Usage](#sample-usage) +- [Services](#services) +- [Models](#models) +- [License](#license) + +## Setup & Configuration + +### Supported Language Versions + +This SDK is compatible with the following versions: `Python >= 3.7` + +### Installation + +To get started with the SDK, we recommend installing using `pip`: + +```bash +pip install salad-cloud-sdk +``` + +## Authentication + +### API Key Authentication + +The SaladCloudSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API. + +#### Setting the API key + +When you initialize the SDK, you can set the API key as follows: + +```py +SaladCloudSdk( + api_key="YOUR_API_KEY", + api_key_header="YOUR_API_KEY_HEADER", + timeout=10000 +) +``` + +If you need to set or update the API key after initializing the SDK, you can use: + +```py +sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER") +``` + +## Setting a Custom Timeout + +You can set a custom timeout for the SDK's HTTP requests as follows: + +```py +from salad_cloud_sdk import SaladCloudSdk + +sdk = SaladCloudSdk(timeout=10000) +``` + +# Sample Usage + +Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint: + +```py +from salad_cloud_sdk import SaladCloudSdk, Environment + +sdk = SaladCloudSdk( + api_key="YOUR_API_KEY", + api_key_header="YOUR_API_KEY_HEADER", + base_url=Environment.DEFAULT.value, + timeout=10000 +) + +result = sdk.quotas.get_quotas(organization_name="o110sou") + +print(result) + +``` + +## Services + +The SDK provides various services to interact with the API. + +
+Below is a list of all available services: + +| Name | +| :------------------ | +| container_groups | +| workload_errors | +| queues | +| quotas | +| inference_endpoints | +| organization_data | +| webhook_secret_key | + +
+ +## Models + +The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently. + +
+Below is a list of all available models: + +| Name | Description | +| :-------------------------------- | :----------------------------------------------------------------------- | +| ContainerGroupList | Represents a list of container groups | +| CreateContainerGroup | Represents a request to create a container group | +| ContainerGroup | Represents a container group | +| UpdateContainerGroup | Represents a request to update a container group | +| ContainerGroupInstances | Represents a list of container group instances | +| ContainerGroupInstance | Represents the details of a single container group instance | +| WorkloadErrorList | Represents a list of workload errors | +| QueueList | Represents a list of queues | +| CreateQueue | Represents a request to create a new queue. | +| Queue | Represents a queue. | +| UpdateQueue | Represents a request to update an existing queue. | +| QueueJobList | Represents a list of queue jobs | +| CreateQueueJob | Represents a request to create a queue job | +| QueueJob | Represents a queue job | +| Quotas | Represents the organization quotas | +| InferenceEndpointsList | Represents a list of inference endpoints | +| InferenceEndpoint | Represents an inference endpoint | +| InferenceEndpointJobList | Represents a list of inference endpoint jobs | +| CreateInferenceEndpointJob | Represents a request to create a inference endpoint job | +| InferenceEndpointJob | Represents a inference endpoint job | +| GpuClassesList | Represents a list of GPU classes | +| WebhookSecretKey | Represents a webhook secret key | +| Container | Represents a container | +| ContainerRestartPolicy | | +| ContainerGroupState | Represents a container group state | +| CountryCode | | +| ContainerGroupNetworking | Represents container group networking parameters | +| ContainerGroupLivenessProbe | Represents the container group liveness probe | +| ContainerGroupReadinessProbe | Represents the container group readiness probe | +| ContainerGroupStartupProbe | Represents the container group startup probe | +| ContainerGroupQueueConnection | Represents container group queue connection | +| QueueAutoscaler | Represents the autoscaling rules for a queue | +| ContainerResourceRequirements | Represents a container resource requirements | +| ContainerGroupPriority | | +| ContainerGroupStatus | | +| ContainerGroupInstanceStatusCount | Represents a container group instance status count | +| ContainerNetworkingProtocol | | +| ContainerGroupProbeTcp | | +| ContainerGroupProbeHttp | | +| ContainerGroupProbeGrpc | | +| ContainerGroupProbeExec | | +| ContainerProbeHttpScheme | | +| ContainerGroupProbeHttpHeaders2 | | +| CreateContainer | Represents a container | +| CreateContainerGroupNetworking | Represents container group networking parameters | +| UpdateContainer | Represents an update container object | +| UpdateContainerGroupNetworking | Represents update container group networking parameters | +| WorkloadError | Represents a workload error | +| QueueJobEvent | Represents an event for queue job | +| ContainerGroupsQuotas | | +| RecipesQuotas | | +| InferenceEndpointJobEvent | Represents an event for inference endpoint job | +| GpuClass | Represents a GPU Class | +| GpuClassPrice | Represents the price of a GPU class for a given container group priority | + +
+ +## License + +This SDK is licensed under the MIT License. + +See the [LICENSE](LICENSE) file for more details. diff --git a/README.md b/README.md index eee860a..6036a85 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# SaladCloudSdk Python SDK 0.9.0-alpha.1 +# SaladCloudSdk Python 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 @@ -86,7 +86,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.quotas.get_quotas(organization_name="fl1mcxorfzr4rx2m8p8o1avm0cpka2159") +result = sdk.quotas.get_quotas(organization_name="o110sou") print(result) @@ -151,6 +151,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 8a7824c..1ed01e3 100644 --- a/documentation/models/Container.md +++ b/documentation/models/Container.md @@ -4,124 +4,124 @@ Represents a container **Properties** -| Name | Type | Required | Description | -| :-------------------- | :---------------------------- | :------- | :------------------------------------------- | -| image | str | ✅ | | -| resources | ContainerResourceRequirements | ✅ | Represents a container resource requirements | -| command | List[str] | ✅ | | -| priority | ContainerGroupPriority | ❌ | | -| size | int | ❌ | | -| hash | str | ❌ | | -| environment_variables | dict | ❌ | | -| logging | ContainerLogging | ❌ | | +| Name | Type | Required | Description | +| :-------------------- | :------------------------------ | :------- | :------------------------------------------- | +| image | `str` | ✅ | | +| resources | `ContainerResourceRequirements` | ✅ | Represents a container resource requirements | +| command | `List[str]` | ✅ | | +| priority | `ContainerGroupPriority` | ❌ | | +| size | `int` | ❌ | | +| hash | `str` | ❌ | | +| environment_variables | `dict` | ❌ | | +| logging | `ContainerLogging` | ❌ | | # ContainerLogging **Properties** -| Name | Type | Required | Description | -| :-------- | :--------------- | :------- | :---------- | -| axiom | LoggingAxiom1 | ❌ | | -| datadog | LoggingDatadog1 | ❌ | | -| new_relic | LoggingNewRelic1 | ❌ | | -| splunk | LoggingSplunk1 | ❌ | | -| tcp | LoggingTcp1 | ❌ | | -| http | LoggingHttp1 | ❌ | | +| Name | Type | Required | Description | +| :-------- | :----------------- | :------- | :---------- | +| axiom | `LoggingAxiom1` | ❌ | | +| datadog | `LoggingDatadog1` | ❌ | | +| new_relic | `LoggingNewRelic1` | ❌ | | +| splunk | `LoggingSplunk1` | ❌ | | +| tcp | `LoggingTcp1` | ❌ | | +| http | `LoggingHttp1` | ❌ | | # LoggingAxiom_1 **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| host | str | ✅ | | -| api_token | str | ✅ | | -| dataset | str | ✅ | | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| api_token | `str` | ✅ | | +| dataset | `str` | ✅ | | # LoggingDatadog_1 **Properties** -| Name | Type | Required | Description | -| :------ | :----------------- | :------- | :---------- | -| host | str | ✅ | | -| api_key | str | ✅ | | -| tags | List[DatadogTags1] | ❌ | | +| Name | Type | Required | Description | +| :------ | :------------------- | :------- | :---------- | +| host | `str` | ✅ | | +| api_key | `str` | ✅ | | +| tags | `List[DatadogTags1]` | ❌ | | # DatadogTags_1 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | # LoggingNewRelic_1 **Properties** -| Name | Type | Required | Description | -| :------------ | :--- | :------- | :---------- | -| host | str | ✅ | | -| ingestion_key | str | ✅ | | +| Name | Type | Required | Description | +| :------------ | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| ingestion_key | `str` | ✅ | | # LoggingSplunk_1 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| host | str | ✅ | | -| token | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| token | `str` | ✅ | | # LoggingTcp_1 **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| host | str | ✅ | | -| port | int | ✅ | | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| port | `int` | ✅ | | # LoggingHttp_1 **Properties** -| Name | Type | Required | Description | -| :---------- | :----------------- | :------- | :---------- | -| host | str | ✅ | | -| port | int | ✅ | | -| format | HttpFormat1 | ✅ | | -| compression | HttpCompression1 | ✅ | | -| user | str | ❌ | | -| password | str | ❌ | | -| path | str | ❌ | | -| headers | List[HttpHeaders1] | ❌ | | +| Name | Type | Required | Description | +| :---------- | :------------------- | :------- | :---------- | +| host | `str` | ✅ | | +| port | `int` | ✅ | | +| format | `HttpFormat1` | ✅ | | +| compression | `HttpCompression1` | ✅ | | +| user | `str` | ❌ | | +| password | `str` | ❌ | | +| path | `str` | ❌ | | +| headers | `List[HttpHeaders1]` | ❌ | | # HttpFormat_1 **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :----------- | -| JSON | str | ✅ | "json" | -| JSONLINES | str | ✅ | "json_lines" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :----------- | +| JSON | `str` | ✅ | "json" | +| JSONLINES | `str` | ✅ | "json_lines" | # HttpHeaders_1 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | # HttpCompression_1 **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| NONE | str | ✅ | "none" | -| GZIP | str | ✅ | "gzip" | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| NONE | `str` | ✅ | "none" | +| GZIP | `str` | ✅ | "gzip" | diff --git a/documentation/models/ContainerGroup.md b/documentation/models/ContainerGroup.md index f380971..34c3b78 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\_ | str | ✅ | | -| name | str | ✅ | | -| display_name | str | ✅ | | -| container | Container | ✅ | Represents a container | -| autostart_policy | bool | ✅ | | -| restart_policy | ContainerRestartPolicy | ✅ | | -| replicas | int | ✅ | | -| current_state | ContainerGroupState | ✅ | Represents a container group state | -| create_time | str | ✅ | | -| update_time | str | ✅ | | -| pending_change | bool | ✅ | | -| version | int | ✅ | | -| country_codes | List[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 | -| liveness_probe | ContainerGroupLivenessProbe | ❌ | Represents the container group liveness probe | -| readiness_probe | ContainerGroupReadinessProbe | ❌ | Represents the container group readiness probe | -| startup_probe | ContainerGroupStartupProbe | ❌ | Represents the container group startup probe | -| queue_connection | ContainerGroupQueueConnection | ❌ | Represents container group queue connection | +| Name | Type | Required | Description | +| :--------------- | :------------------------------ | :------- | :---------------------------------------------------------------------------------------------- | +| id\_ | `str` | ✅ | | +| name | `str` | ✅ | | +| display_name | `str` | ✅ | | +| container | `Container` | ✅ | Represents a container | +| autostart_policy | `bool` | ✅ | | +| restart_policy | `ContainerRestartPolicy` | ✅ | | +| replicas | `int` | ✅ | | +| current_state | `ContainerGroupState` | ✅ | Represents a container group state | +| create_time | `str` | ✅ | | +| update_time | `str` | ✅ | | +| pending_change | `bool` | ✅ | | +| version | `int` | ✅ | | +| country_codes | `List[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 | +| liveness_probe | `ContainerGroupLivenessProbe` | ❌ | Represents the container group liveness probe | +| readiness_probe | `ContainerGroupReadinessProbe` | ❌ | Represents the container group readiness probe | +| startup_probe | `ContainerGroupStartupProbe` | ❌ | Represents the container group startup probe | +| queue_connection | `ContainerGroupQueueConnection` | ❌ | Represents container group queue connection | +| queue_autoscaler | `QueueAutoscaler` | ❌ | Represents the autoscaling rules for a queue | diff --git a/documentation/models/ContainerGroupInstance.md b/documentation/models/ContainerGroupInstance.md index 324c22d..0e83236 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 | -| :---------- | :---- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | -| instance_id | str | ✅ | The unique instance ID | -| machine_id | str | ✅ | The machine ID | -| state | State | ✅ | The state of the container group instance | -| update_time | str | ✅ | The UTC date & time when the workload on this machine transitioned to the current state | -| version | int | ✅ | The version of the running container group | -| ready | bool | ❌ | Specifies whether the container group instance is currently passing its readiness check. If no readiness probe is defined, is true once fully started. | -| started | bool | ❌ | Specifies whether the container group instance passed its startup probe. Is always true when no startup probe is defined. | +| Name | Type | Required | Description | +| :---------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| instance_id | `str` | ✅ | The unique instance ID | +| machine_id | `str` | ✅ | The machine ID | +| state | `State` | ✅ | The state of the container group instance | +| update_time | `str` | ✅ | The UTC date & time when the workload on this machine transitioned to the current state | +| version | `int` | ✅ | The version of the running container group | +| ready | `bool` | ❌ | Specifies whether the container group instance is currently passing its readiness check. If no readiness probe is defined, is true once fully started. | +| started | `bool` | ❌ | 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 | str | ✅ | "allocating" | -| DOWNLOADING | str | ✅ | "downloading" | -| CREATING | str | ✅ | "creating" | -| RUNNING | str | ✅ | "running" | -| STOPPING | str | ✅ | "stopping" | +| Name | Type | Required | Description | +| :---------- | :---- | :------- | :------------ | +| ALLOCATING | `str` | ✅ | "allocating" | +| DOWNLOADING | `str` | ✅ | "downloading" | +| CREATING | `str` | ✅ | "creating" | +| RUNNING | `str` | ✅ | "running" | +| STOPPING | `str` | ✅ | "stopping" | diff --git a/documentation/models/ContainerGroupInstanceStatusCount.md b/documentation/models/ContainerGroupInstanceStatusCount.md index a8a6ad8..ecc1e61 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 | -| :--------------- | :--- | :------- | :---------- | -| allocating_count | int | ✅ | | -| creating_count | int | ✅ | | -| running_count | int | ✅ | | -| stopping_count | int | ✅ | | +| Name | Type | Required | Description | +| :--------------- | :---- | :------- | :---------- | +| allocating_count | `int` | ✅ | | +| creating_count | `int` | ✅ | | +| running_count | `int` | ✅ | | +| stopping_count | `int` | ✅ | | diff --git a/documentation/models/ContainerGroupInstances.md b/documentation/models/ContainerGroupInstances.md index 723e51b..9b99b79 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 | List[ContainerGroupInstance] | ✅ | | +| Name | Type | Required | Description | +| :-------- | :----------------------------- | :------- | :---------- | +| instances | `List[ContainerGroupInstance]` | ✅ | | diff --git a/documentation/models/ContainerGroupList.md b/documentation/models/ContainerGroupList.md index 4654d56..b7a0f79 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 | List[ContainerGroup] | ✅ | | +| Name | Type | Required | Description | +| :---- | :--------------------- | :------- | :---------- | +| items | `List[ContainerGroup]` | ✅ | | diff --git a/documentation/models/ContainerGroupLivenessProbe.md b/documentation/models/ContainerGroupLivenessProbe.md index 8f5cb1b..0a25ac8 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 | -| :-------------------- | :---------------------- | :------- | :---------- | -| initial_delay_seconds | int | ✅ | | -| period_seconds | int | ✅ | | -| timeout_seconds | int | ✅ | | -| success_threshold | int | ✅ | | -| failure_threshold | int | ✅ | | -| tcp | ContainerGroupProbeTcp | ❌ | | -| http | ContainerGroupProbeHttp | ❌ | | -| grpc | ContainerGroupProbeGrpc | ❌ | | -| exec\_ | ContainerGroupProbeExec | ❌ | | +| Name | Type | Required | Description | +| :-------------------- | :------------------------ | :------- | :---------- | +| initial_delay_seconds | `int` | ✅ | | +| period_seconds | `int` | ✅ | | +| timeout_seconds | `int` | ✅ | | +| success_threshold | `int` | ✅ | | +| failure_threshold | `int` | ✅ | | +| tcp | `ContainerGroupProbeTcp` | ❌ | | +| http | `ContainerGroupProbeHttp` | ❌ | | +| grpc | `ContainerGroupProbeGrpc` | ❌ | | +| exec\_ | `ContainerGroupProbeExec` | ❌ | | diff --git a/documentation/models/ContainerGroupNetworking.md b/documentation/models/ContainerGroupNetworking.md index 9804209..7642e51 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 | int | ✅ | | -| auth | bool | ✅ | | -| dns | str | ✅ | | +| Name | Type | Required | Description | +| :------- | :---------------------------- | :------- | :---------- | +| protocol | `ContainerNetworkingProtocol` | ✅ | | +| port | `int` | ✅ | | +| auth | `bool` | ✅ | | +| dns | `str` | ✅ | | diff --git a/documentation/models/ContainerGroupPriority.md b/documentation/models/ContainerGroupPriority.md index 0d7f902..8d2b3a2 100644 --- a/documentation/models/ContainerGroupPriority.md +++ b/documentation/models/ContainerGroupPriority.md @@ -2,9 +2,9 @@ **Properties** -| Name | Type | Required | Description | -| :----- | :--- | :------- | :---------- | -| HIGH | str | ✅ | "high" | -| MEDIUM | str | ✅ | "medium" | -| LOW | str | ✅ | "low" | -| BATCH | str | ✅ | "batch" | +| Name | Type | Required | Description | +| :----- | :---- | :------- | :---------- | +| HIGH | `str` | ✅ | "high" | +| MEDIUM | `str` | ✅ | "medium" | +| LOW | `str` | ✅ | "low" | +| BATCH | `str` | ✅ | "batch" | diff --git a/documentation/models/ContainerGroupProbeExec.md b/documentation/models/ContainerGroupProbeExec.md index 86489bd..2135daa 100644 --- a/documentation/models/ContainerGroupProbeExec.md +++ b/documentation/models/ContainerGroupProbeExec.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :------ | :-------- | :------- | :---------- | -| command | List[str] | ✅ | | +| Name | Type | Required | Description | +| :------ | :---------- | :------- | :---------- | +| command | `List[str]` | ✅ | | diff --git a/documentation/models/ContainerGroupProbeGrpc.md b/documentation/models/ContainerGroupProbeGrpc.md index 8b1b41e..0c96dbb 100644 --- a/documentation/models/ContainerGroupProbeGrpc.md +++ b/documentation/models/ContainerGroupProbeGrpc.md @@ -2,7 +2,7 @@ **Properties** -| Name | Type | Required | Description | -| :------ | :--- | :------- | :---------- | -| service | str | ✅ | | -| port | int | ✅ | | +| Name | Type | Required | Description | +| :------ | :---- | :------- | :---------- | +| service | `str` | ✅ | | +| port | `int` | ✅ | | diff --git a/documentation/models/ContainerGroupProbeHttp.md b/documentation/models/ContainerGroupProbeHttp.md index 4edae87..8e2be15 100644 --- a/documentation/models/ContainerGroupProbeHttp.md +++ b/documentation/models/ContainerGroupProbeHttp.md @@ -2,9 +2,9 @@ **Properties** -| Name | Type | Required | Description | -| :------ | :------------------------------------ | :------- | :---------- | -| path | str | ✅ | | -| port | int | ✅ | | -| scheme | ContainerProbeHttpScheme | ❌ | | -| headers | List[ContainerGroupProbeHttpHeaders2] | ❌ | | +| Name | Type | Required | Description | +| :------ | :-------------------------------------- | :------- | :---------- | +| path | `str` | ✅ | | +| port | `int` | ✅ | | +| scheme | `ContainerProbeHttpScheme` | ❌ | | +| headers | `List[ContainerGroupProbeHttpHeaders2]` | ❌ | | diff --git a/documentation/models/ContainerGroupProbeHttpHeaders2.md b/documentation/models/ContainerGroupProbeHttpHeaders2.md index 78556c3..b10b5e5 100644 --- a/documentation/models/ContainerGroupProbeHttpHeaders2.md +++ b/documentation/models/ContainerGroupProbeHttpHeaders2.md @@ -2,7 +2,7 @@ **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | diff --git a/documentation/models/ContainerGroupProbeTcp.md b/documentation/models/ContainerGroupProbeTcp.md index 138b09b..27f5434 100644 --- a/documentation/models/ContainerGroupProbeTcp.md +++ b/documentation/models/ContainerGroupProbeTcp.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| port | int | ✅ | | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| port | `int` | ✅ | | diff --git a/documentation/models/ContainerGroupQueueConnection.md b/documentation/models/ContainerGroupQueueConnection.md index e3648d2..b16fa0b 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 | str | ✅ | | -| port | int | ✅ | | -| queue_name | str | ✅ | | +| Name | Type | Required | Description | +| :--------- | :---- | :------- | :---------- | +| path | `str` | ✅ | | +| port | `int` | ✅ | | +| queue_name | `str` | ✅ | | diff --git a/documentation/models/ContainerGroupReadinessProbe.md b/documentation/models/ContainerGroupReadinessProbe.md index b68b5c7..6b8aff5 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 | -| :-------------------- | :---------------------- | :------- | :---------- | -| initial_delay_seconds | int | ✅ | | -| period_seconds | int | ✅ | | -| timeout_seconds | int | ✅ | | -| success_threshold | int | ✅ | | -| failure_threshold | int | ✅ | | -| tcp | ContainerGroupProbeTcp | ❌ | | -| http | ContainerGroupProbeHttp | ❌ | | -| grpc | ContainerGroupProbeGrpc | ❌ | | -| exec\_ | ContainerGroupProbeExec | ❌ | | +| Name | Type | Required | Description | +| :-------------------- | :------------------------ | :------- | :---------- | +| initial_delay_seconds | `int` | ✅ | | +| period_seconds | `int` | ✅ | | +| timeout_seconds | `int` | ✅ | | +| success_threshold | `int` | ✅ | | +| failure_threshold | `int` | ✅ | | +| tcp | `ContainerGroupProbeTcp` | ❌ | | +| http | `ContainerGroupProbeHttp` | ❌ | | +| grpc | `ContainerGroupProbeGrpc` | ❌ | | +| exec\_ | `ContainerGroupProbeExec` | ❌ | | diff --git a/documentation/models/ContainerGroupStartupProbe.md b/documentation/models/ContainerGroupStartupProbe.md index 17eb7e7..18fccef 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 | -| :-------------------- | :---------------------- | :------- | :---------- | -| initial_delay_seconds | int | ✅ | | -| period_seconds | int | ✅ | | -| timeout_seconds | int | ✅ | | -| success_threshold | int | ✅ | | -| failure_threshold | int | ✅ | | -| tcp | ContainerGroupProbeTcp | ❌ | | -| http | ContainerGroupProbeHttp | ❌ | | -| grpc | ContainerGroupProbeGrpc | ❌ | | -| exec\_ | ContainerGroupProbeExec | ❌ | | +| Name | Type | Required | Description | +| :-------------------- | :------------------------ | :------- | :---------- | +| initial_delay_seconds | `int` | ✅ | | +| period_seconds | `int` | ✅ | | +| timeout_seconds | `int` | ✅ | | +| success_threshold | `int` | ✅ | | +| failure_threshold | `int` | ✅ | | +| tcp | `ContainerGroupProbeTcp` | ❌ | | +| http | `ContainerGroupProbeHttp` | ❌ | | +| grpc | `ContainerGroupProbeGrpc` | ❌ | | +| exec\_ | `ContainerGroupProbeExec` | ❌ | | diff --git a/documentation/models/ContainerGroupState.md b/documentation/models/ContainerGroupState.md index d54ff6b..6a16b51 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 | ✅ | | -| start_time | str | ✅ | | -| finish_time | str | ✅ | | -| instance_status_counts | ContainerGroupInstanceStatusCount | ✅ | Represents a container group instance status count | -| description | str | ❌ | | +| Name | Type | Required | Description | +| :--------------------- | :---------------------------------- | :------- | :------------------------------------------------- | +| status | `ContainerGroupStatus` | ✅ | | +| start_time | `str` | ✅ | | +| finish_time | `str` | ✅ | | +| instance_status_counts | `ContainerGroupInstanceStatusCount` | ✅ | Represents a container group instance status count | +| description | `str` | ❌ | | diff --git a/documentation/models/ContainerGroupStatus.md b/documentation/models/ContainerGroupStatus.md index 8587786..e815dc3 100644 --- a/documentation/models/ContainerGroupStatus.md +++ b/documentation/models/ContainerGroupStatus.md @@ -2,11 +2,11 @@ **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| PENDING | str | ✅ | "pending" | -| RUNNING | str | ✅ | "running" | -| STOPPED | str | ✅ | "stopped" | -| SUCCEEDED | str | ✅ | "succeeded" | -| FAILED | str | ✅ | "failed" | -| DEPLOYING | str | ✅ | "deploying" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| PENDING | `str` | ✅ | "pending" | +| RUNNING | `str` | ✅ | "running" | +| STOPPED | `str` | ✅ | "stopped" | +| SUCCEEDED | `str` | ✅ | "succeeded" | +| FAILED | `str` | ✅ | "failed" | +| DEPLOYING | `str` | ✅ | "deploying" | diff --git a/documentation/models/ContainerGroupsQuotas.md b/documentation/models/ContainerGroupsQuotas.md index eee1209..acc3207 100644 --- a/documentation/models/ContainerGroupsQuotas.md +++ b/documentation/models/ContainerGroupsQuotas.md @@ -2,10 +2,10 @@ **Properties** -| Name | Type | Required | Description | -| :------------------------------------------- | :--- | :------- | :---------- | -| max_created_container_groups | int | ✅ | | -| container_instance_quota | int | ✅ | | -| max_container_group_reallocations_per_minute | int | ❌ | | -| max_container_group_recreates_per_minute | int | ❌ | | -| max_container_group_restarts_per_minute | int | ❌ | | +| Name | Type | Required | Description | +| :------------------------------------------- | :---- | :------- | :---------- | +| max_created_container_groups | `int` | ✅ | | +| container_instance_quota | `int` | ✅ | | +| max_container_group_reallocations_per_minute | `int` | ❌ | | +| max_container_group_recreates_per_minute | `int` | ❌ | | +| max_container_group_restarts_per_minute | `int` | ❌ | | diff --git a/documentation/models/ContainerNetworkingProtocol.md b/documentation/models/ContainerNetworkingProtocol.md index a4fecfd..5495f57 100644 --- a/documentation/models/ContainerNetworkingProtocol.md +++ b/documentation/models/ContainerNetworkingProtocol.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| HTTP | str | ✅ | "http" | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| HTTP | `str` | ✅ | "http" | diff --git a/documentation/models/ContainerProbeHttpScheme.md b/documentation/models/ContainerProbeHttpScheme.md index 3421f0e..80f8335 100644 --- a/documentation/models/ContainerProbeHttpScheme.md +++ b/documentation/models/ContainerProbeHttpScheme.md @@ -2,6 +2,6 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| HTTP | str | ✅ | "http" | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| HTTP | `str` | ✅ | "http" | diff --git a/documentation/models/ContainerResourceRequirements.md b/documentation/models/ContainerResourceRequirements.md index ca4c5d9..ec6415d 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 | int | ✅ | | -| memory | int | ✅ | | -| gpu_classes | List[str] | ❌ | | -| storage_amount | int | ❌ | | +| Name | Type | Required | Description | +| :------------- | :---------- | :------- | :---------- | +| cpu | `int` | ✅ | | +| memory | `int` | ✅ | | +| gpu_classes | `List[str]` | ❌ | | +| storage_amount | `int` | ❌ | | diff --git a/documentation/models/ContainerRestartPolicy.md b/documentation/models/ContainerRestartPolicy.md index c7fe54f..d46665f 100644 --- a/documentation/models/ContainerRestartPolicy.md +++ b/documentation/models/ContainerRestartPolicy.md @@ -2,8 +2,8 @@ **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :----------- | -| ALWAYS | str | ✅ | "always" | -| ONFAILURE | str | ✅ | "on_failure" | -| NEVER | str | ✅ | "never" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :----------- | +| ALWAYS | `str` | ✅ | "always" | +| ONFAILURE | `str` | ✅ | "on_failure" | +| NEVER | `str` | ✅ | "never" | diff --git a/documentation/models/CountryCode.md b/documentation/models/CountryCode.md index 9cfd346..7c7aae8 100644 --- a/documentation/models/CountryCode.md +++ b/documentation/models/CountryCode.md @@ -2,254 +2,254 @@ **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| AF | str | ✅ | "af" | -| AL | str | ✅ | "al" | -| DZ | str | ✅ | "dz" | -| AS | str | ✅ | "as" | -| AD | str | ✅ | "ad" | -| AO | str | ✅ | "ao" | -| AI | str | ✅ | "ai" | -| AQ | str | ✅ | "aq" | -| AG | str | ✅ | "ag" | -| AR | str | ✅ | "ar" | -| AM | str | ✅ | "am" | -| AW | str | ✅ | "aw" | -| AU | str | ✅ | "au" | -| AT | str | ✅ | "at" | -| AZ | str | ✅ | "az" | -| BS | str | ✅ | "bs" | -| BH | str | ✅ | "bh" | -| BD | str | ✅ | "bd" | -| BB | str | ✅ | "bb" | -| BY | str | ✅ | "by" | -| BE | str | ✅ | "be" | -| BZ | str | ✅ | "bz" | -| BJ | str | ✅ | "bj" | -| BM | str | ✅ | "bm" | -| BT | str | ✅ | "bt" | -| BO | str | ✅ | "bo" | -| BQ | str | ✅ | "bq" | -| BA | str | ✅ | "ba" | -| BW | str | ✅ | "bw" | -| BV | str | ✅ | "bv" | -| BR | str | ✅ | "br" | -| IO | str | ✅ | "io" | -| BN | str | ✅ | "bn" | -| BG | str | ✅ | "bg" | -| BF | str | ✅ | "bf" | -| BI | str | ✅ | "bi" | -| CV | str | ✅ | "cv" | -| KH | str | ✅ | "kh" | -| CM | str | ✅ | "cm" | -| CA | str | ✅ | "ca" | -| KY | str | ✅ | "ky" | -| CF | str | ✅ | "cf" | -| TD | str | ✅ | "td" | -| CL | str | ✅ | "cl" | -| CN | str | ✅ | "cn" | -| CX | str | ✅ | "cx" | -| CC | str | ✅ | "cc" | -| CO | str | ✅ | "co" | -| KM | str | ✅ | "km" | -| CD | str | ✅ | "cd" | -| CG | str | ✅ | "cg" | -| CK | str | ✅ | "ck" | -| CR | str | ✅ | "cr" | -| HR | str | ✅ | "hr" | -| CU | str | ✅ | "cu" | -| CW | str | ✅ | "cw" | -| CY | str | ✅ | "cy" | -| CZ | str | ✅ | "cz" | -| CI | str | ✅ | "ci" | -| DK | str | ✅ | "dk" | -| DJ | str | ✅ | "dj" | -| DM | str | ✅ | "dm" | -| DO | str | ✅ | "do" | -| EC | str | ✅ | "ec" | -| EG | str | ✅ | "eg" | -| SV | str | ✅ | "sv" | -| GQ | str | ✅ | "gq" | -| ER | str | ✅ | "er" | -| EE | str | ✅ | "ee" | -| SZ | str | ✅ | "sz" | -| ET | str | ✅ | "et" | -| FK | str | ✅ | "fk" | -| FO | str | ✅ | "fo" | -| FJ | str | ✅ | "fj" | -| FI | str | ✅ | "fi" | -| FR | str | ✅ | "fr" | -| GF | str | ✅ | "gf" | -| PF | str | ✅ | "pf" | -| TF | str | ✅ | "tf" | -| GA | str | ✅ | "ga" | -| GM | str | ✅ | "gm" | -| GE | str | ✅ | "ge" | -| DE | str | ✅ | "de" | -| GH | str | ✅ | "gh" | -| GI | str | ✅ | "gi" | -| GR | str | ✅ | "gr" | -| GL | str | ✅ | "gl" | -| GD | str | ✅ | "gd" | -| GP | str | ✅ | "gp" | -| GU | str | ✅ | "gu" | -| GT | str | ✅ | "gt" | -| GG | str | ✅ | "gg" | -| GN | str | ✅ | "gn" | -| GW | str | ✅ | "gw" | -| GY | str | ✅ | "gy" | -| HT | str | ✅ | "ht" | -| HM | str | ✅ | "hm" | -| VA | str | ✅ | "va" | -| HN | str | ✅ | "hn" | -| HK | str | ✅ | "hk" | -| HU | str | ✅ | "hu" | -| IS | str | ✅ | "is" | -| IN | str | ✅ | "in" | -| ID | str | ✅ | "id" | -| IR | str | ✅ | "ir" | -| IQ | str | ✅ | "iq" | -| IE | str | ✅ | "ie" | -| IM | str | ✅ | "im" | -| IL | str | ✅ | "il" | -| IT | str | ✅ | "it" | -| JM | str | ✅ | "jm" | -| JP | str | ✅ | "jp" | -| JE | str | ✅ | "je" | -| JO | str | ✅ | "jo" | -| KZ | str | ✅ | "kz" | -| KE | str | ✅ | "ke" | -| KI | str | ✅ | "ki" | -| KP | str | ✅ | "kp" | -| KR | str | ✅ | "kr" | -| KW | str | ✅ | "kw" | -| KG | str | ✅ | "kg" | -| LA | str | ✅ | "la" | -| LV | str | ✅ | "lv" | -| LB | str | ✅ | "lb" | -| LS | str | ✅ | "ls" | -| LR | str | ✅ | "lr" | -| LY | str | ✅ | "ly" | -| LI | str | ✅ | "li" | -| LT | str | ✅ | "lt" | -| LU | str | ✅ | "lu" | -| MO | str | ✅ | "mo" | -| MG | str | ✅ | "mg" | -| MW | str | ✅ | "mw" | -| MY | str | ✅ | "my" | -| MV | str | ✅ | "mv" | -| ML | str | ✅ | "ml" | -| MT | str | ✅ | "mt" | -| MH | str | ✅ | "mh" | -| MQ | str | ✅ | "mq" | -| MR | str | ✅ | "mr" | -| MU | str | ✅ | "mu" | -| YT | str | ✅ | "yt" | -| MX | str | ✅ | "mx" | -| FM | str | ✅ | "fm" | -| MD | str | ✅ | "md" | -| MC | str | ✅ | "mc" | -| MN | str | ✅ | "mn" | -| ME | str | ✅ | "me" | -| MS | str | ✅ | "ms" | -| MA | str | ✅ | "ma" | -| MZ | str | ✅ | "mz" | -| MM | str | ✅ | "mm" | -| NA | str | ✅ | "na" | -| NR | str | ✅ | "nr" | -| NP | str | ✅ | "np" | -| NL | str | ✅ | "nl" | -| NC | str | ✅ | "nc" | -| NZ | str | ✅ | "nz" | -| NI | str | ✅ | "ni" | -| NE | str | ✅ | "ne" | -| NG | str | ✅ | "ng" | -| NU | str | ✅ | "nu" | -| NF | str | ✅ | "nf" | -| MP | str | ✅ | "mp" | -| NO | str | ✅ | "no" | -| OM | str | ✅ | "om" | -| PK | str | ✅ | "pk" | -| PW | str | ✅ | "pw" | -| PS | str | ✅ | "ps" | -| PA | str | ✅ | "pa" | -| PG | str | ✅ | "pg" | -| PY | str | ✅ | "py" | -| PE | str | ✅ | "pe" | -| PH | str | ✅ | "ph" | -| PN | str | ✅ | "pn" | -| PL | str | ✅ | "pl" | -| PT | str | ✅ | "pt" | -| PR | str | ✅ | "pr" | -| QA | str | ✅ | "qa" | -| MK | str | ✅ | "mk" | -| RO | str | ✅ | "ro" | -| RU | str | ✅ | "ru" | -| RW | str | ✅ | "rw" | -| RE | str | ✅ | "re" | -| BL | str | ✅ | "bl" | -| SH | str | ✅ | "sh" | -| KN | str | ✅ | "kn" | -| LC | str | ✅ | "lc" | -| MF | str | ✅ | "mf" | -| PM | str | ✅ | "pm" | -| VC | str | ✅ | "vc" | -| WS | str | ✅ | "ws" | -| SM | str | ✅ | "sm" | -| ST | str | ✅ | "st" | -| SA | str | ✅ | "sa" | -| SN | str | ✅ | "sn" | -| RS | str | ✅ | "rs" | -| SC | str | ✅ | "sc" | -| SL | str | ✅ | "sl" | -| SG | str | ✅ | "sg" | -| SX | str | ✅ | "sx" | -| SK | str | ✅ | "sk" | -| SI | str | ✅ | "si" | -| SB | str | ✅ | "sb" | -| SO | str | ✅ | "so" | -| ZA | str | ✅ | "za" | -| GS | str | ✅ | "gs" | -| SS | str | ✅ | "ss" | -| ES | str | ✅ | "es" | -| LK | str | ✅ | "lk" | -| SD | str | ✅ | "sd" | -| SR | str | ✅ | "sr" | -| SJ | str | ✅ | "sj" | -| SE | str | ✅ | "se" | -| CH | str | ✅ | "ch" | -| SY | str | ✅ | "sy" | -| TW | str | ✅ | "tw" | -| TJ | str | ✅ | "tj" | -| TZ | str | ✅ | "tz" | -| TH | str | ✅ | "th" | -| TL | str | ✅ | "tl" | -| TG | str | ✅ | "tg" | -| TK | str | ✅ | "tk" | -| TO | str | ✅ | "to" | -| TT | str | ✅ | "tt" | -| TN | str | ✅ | "tn" | -| TR | str | ✅ | "tr" | -| TM | str | ✅ | "tm" | -| TC | str | ✅ | "tc" | -| TV | str | ✅ | "tv" | -| UG | str | ✅ | "ug" | -| UA | str | ✅ | "ua" | -| AE | str | ✅ | "ae" | -| GB | str | ✅ | "gb" | -| UM | str | ✅ | "um" | -| US | str | ✅ | "us" | -| UY | str | ✅ | "uy" | -| UZ | str | ✅ | "uz" | -| VU | str | ✅ | "vu" | -| VE | str | ✅ | "ve" | -| VN | str | ✅ | "vn" | -| VG | str | ✅ | "vg" | -| VI | str | ✅ | "vi" | -| WF | str | ✅ | "wf" | -| EH | str | ✅ | "eh" | -| YE | str | ✅ | "ye" | -| ZM | str | ✅ | "zm" | -| ZW | str | ✅ | "zw" | -| AX | str | ✅ | "ax" | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| AF | `str` | ✅ | "af" | +| AL | `str` | ✅ | "al" | +| DZ | `str` | ✅ | "dz" | +| AS | `str` | ✅ | "as" | +| AD | `str` | ✅ | "ad" | +| AO | `str` | ✅ | "ao" | +| AI | `str` | ✅ | "ai" | +| AQ | `str` | ✅ | "aq" | +| AG | `str` | ✅ | "ag" | +| AR | `str` | ✅ | "ar" | +| AM | `str` | ✅ | "am" | +| AW | `str` | ✅ | "aw" | +| AU | `str` | ✅ | "au" | +| AT | `str` | ✅ | "at" | +| AZ | `str` | ✅ | "az" | +| BS | `str` | ✅ | "bs" | +| BH | `str` | ✅ | "bh" | +| BD | `str` | ✅ | "bd" | +| BB | `str` | ✅ | "bb" | +| BY | `str` | ✅ | "by" | +| BE | `str` | ✅ | "be" | +| BZ | `str` | ✅ | "bz" | +| BJ | `str` | ✅ | "bj" | +| BM | `str` | ✅ | "bm" | +| BT | `str` | ✅ | "bt" | +| BO | `str` | ✅ | "bo" | +| BQ | `str` | ✅ | "bq" | +| BA | `str` | ✅ | "ba" | +| BW | `str` | ✅ | "bw" | +| BV | `str` | ✅ | "bv" | +| BR | `str` | ✅ | "br" | +| IO | `str` | ✅ | "io" | +| BN | `str` | ✅ | "bn" | +| BG | `str` | ✅ | "bg" | +| BF | `str` | ✅ | "bf" | +| BI | `str` | ✅ | "bi" | +| CV | `str` | ✅ | "cv" | +| KH | `str` | ✅ | "kh" | +| CM | `str` | ✅ | "cm" | +| CA | `str` | ✅ | "ca" | +| KY | `str` | ✅ | "ky" | +| CF | `str` | ✅ | "cf" | +| TD | `str` | ✅ | "td" | +| CL | `str` | ✅ | "cl" | +| CN | `str` | ✅ | "cn" | +| CX | `str` | ✅ | "cx" | +| CC | `str` | ✅ | "cc" | +| CO | `str` | ✅ | "co" | +| KM | `str` | ✅ | "km" | +| CD | `str` | ✅ | "cd" | +| CG | `str` | ✅ | "cg" | +| CK | `str` | ✅ | "ck" | +| CR | `str` | ✅ | "cr" | +| HR | `str` | ✅ | "hr" | +| CU | `str` | ✅ | "cu" | +| CW | `str` | ✅ | "cw" | +| CY | `str` | ✅ | "cy" | +| CZ | `str` | ✅ | "cz" | +| CI | `str` | ✅ | "ci" | +| DK | `str` | ✅ | "dk" | +| DJ | `str` | ✅ | "dj" | +| DM | `str` | ✅ | "dm" | +| DO | `str` | ✅ | "do" | +| EC | `str` | ✅ | "ec" | +| EG | `str` | ✅ | "eg" | +| SV | `str` | ✅ | "sv" | +| GQ | `str` | ✅ | "gq" | +| ER | `str` | ✅ | "er" | +| EE | `str` | ✅ | "ee" | +| SZ | `str` | ✅ | "sz" | +| ET | `str` | ✅ | "et" | +| FK | `str` | ✅ | "fk" | +| FO | `str` | ✅ | "fo" | +| FJ | `str` | ✅ | "fj" | +| FI | `str` | ✅ | "fi" | +| FR | `str` | ✅ | "fr" | +| GF | `str` | ✅ | "gf" | +| PF | `str` | ✅ | "pf" | +| TF | `str` | ✅ | "tf" | +| GA | `str` | ✅ | "ga" | +| GM | `str` | ✅ | "gm" | +| GE | `str` | ✅ | "ge" | +| DE | `str` | ✅ | "de" | +| GH | `str` | ✅ | "gh" | +| GI | `str` | ✅ | "gi" | +| GR | `str` | ✅ | "gr" | +| GL | `str` | ✅ | "gl" | +| GD | `str` | ✅ | "gd" | +| GP | `str` | ✅ | "gp" | +| GU | `str` | ✅ | "gu" | +| GT | `str` | ✅ | "gt" | +| GG | `str` | ✅ | "gg" | +| GN | `str` | ✅ | "gn" | +| GW | `str` | ✅ | "gw" | +| GY | `str` | ✅ | "gy" | +| HT | `str` | ✅ | "ht" | +| HM | `str` | ✅ | "hm" | +| VA | `str` | ✅ | "va" | +| HN | `str` | ✅ | "hn" | +| HK | `str` | ✅ | "hk" | +| HU | `str` | ✅ | "hu" | +| IS | `str` | ✅ | "is" | +| IN | `str` | ✅ | "in" | +| ID | `str` | ✅ | "id" | +| IR | `str` | ✅ | "ir" | +| IQ | `str` | ✅ | "iq" | +| IE | `str` | ✅ | "ie" | +| IM | `str` | ✅ | "im" | +| IL | `str` | ✅ | "il" | +| IT | `str` | ✅ | "it" | +| JM | `str` | ✅ | "jm" | +| JP | `str` | ✅ | "jp" | +| JE | `str` | ✅ | "je" | +| JO | `str` | ✅ | "jo" | +| KZ | `str` | ✅ | "kz" | +| KE | `str` | ✅ | "ke" | +| KI | `str` | ✅ | "ki" | +| KP | `str` | ✅ | "kp" | +| KR | `str` | ✅ | "kr" | +| KW | `str` | ✅ | "kw" | +| KG | `str` | ✅ | "kg" | +| LA | `str` | ✅ | "la" | +| LV | `str` | ✅ | "lv" | +| LB | `str` | ✅ | "lb" | +| LS | `str` | ✅ | "ls" | +| LR | `str` | ✅ | "lr" | +| LY | `str` | ✅ | "ly" | +| LI | `str` | ✅ | "li" | +| LT | `str` | ✅ | "lt" | +| LU | `str` | ✅ | "lu" | +| MO | `str` | ✅ | "mo" | +| MG | `str` | ✅ | "mg" | +| MW | `str` | ✅ | "mw" | +| MY | `str` | ✅ | "my" | +| MV | `str` | ✅ | "mv" | +| ML | `str` | ✅ | "ml" | +| MT | `str` | ✅ | "mt" | +| MH | `str` | ✅ | "mh" | +| MQ | `str` | ✅ | "mq" | +| MR | `str` | ✅ | "mr" | +| MU | `str` | ✅ | "mu" | +| YT | `str` | ✅ | "yt" | +| MX | `str` | ✅ | "mx" | +| FM | `str` | ✅ | "fm" | +| MD | `str` | ✅ | "md" | +| MC | `str` | ✅ | "mc" | +| MN | `str` | ✅ | "mn" | +| ME | `str` | ✅ | "me" | +| MS | `str` | ✅ | "ms" | +| MA | `str` | ✅ | "ma" | +| MZ | `str` | ✅ | "mz" | +| MM | `str` | ✅ | "mm" | +| NA | `str` | ✅ | "na" | +| NR | `str` | ✅ | "nr" | +| NP | `str` | ✅ | "np" | +| NL | `str` | ✅ | "nl" | +| NC | `str` | ✅ | "nc" | +| NZ | `str` | ✅ | "nz" | +| NI | `str` | ✅ | "ni" | +| NE | `str` | ✅ | "ne" | +| NG | `str` | ✅ | "ng" | +| NU | `str` | ✅ | "nu" | +| NF | `str` | ✅ | "nf" | +| MP | `str` | ✅ | "mp" | +| NO | `str` | ✅ | "no" | +| OM | `str` | ✅ | "om" | +| PK | `str` | ✅ | "pk" | +| PW | `str` | ✅ | "pw" | +| PS | `str` | ✅ | "ps" | +| PA | `str` | ✅ | "pa" | +| PG | `str` | ✅ | "pg" | +| PY | `str` | ✅ | "py" | +| PE | `str` | ✅ | "pe" | +| PH | `str` | ✅ | "ph" | +| PN | `str` | ✅ | "pn" | +| PL | `str` | ✅ | "pl" | +| PT | `str` | ✅ | "pt" | +| PR | `str` | ✅ | "pr" | +| QA | `str` | ✅ | "qa" | +| MK | `str` | ✅ | "mk" | +| RO | `str` | ✅ | "ro" | +| RU | `str` | ✅ | "ru" | +| RW | `str` | ✅ | "rw" | +| RE | `str` | ✅ | "re" | +| BL | `str` | ✅ | "bl" | +| SH | `str` | ✅ | "sh" | +| KN | `str` | ✅ | "kn" | +| LC | `str` | ✅ | "lc" | +| MF | `str` | ✅ | "mf" | +| PM | `str` | ✅ | "pm" | +| VC | `str` | ✅ | "vc" | +| WS | `str` | ✅ | "ws" | +| SM | `str` | ✅ | "sm" | +| ST | `str` | ✅ | "st" | +| SA | `str` | ✅ | "sa" | +| SN | `str` | ✅ | "sn" | +| RS | `str` | ✅ | "rs" | +| SC | `str` | ✅ | "sc" | +| SL | `str` | ✅ | "sl" | +| SG | `str` | ✅ | "sg" | +| SX | `str` | ✅ | "sx" | +| SK | `str` | ✅ | "sk" | +| SI | `str` | ✅ | "si" | +| SB | `str` | ✅ | "sb" | +| SO | `str` | ✅ | "so" | +| ZA | `str` | ✅ | "za" | +| GS | `str` | ✅ | "gs" | +| SS | `str` | ✅ | "ss" | +| ES | `str` | ✅ | "es" | +| LK | `str` | ✅ | "lk" | +| SD | `str` | ✅ | "sd" | +| SR | `str` | ✅ | "sr" | +| SJ | `str` | ✅ | "sj" | +| SE | `str` | ✅ | "se" | +| CH | `str` | ✅ | "ch" | +| SY | `str` | ✅ | "sy" | +| TW | `str` | ✅ | "tw" | +| TJ | `str` | ✅ | "tj" | +| TZ | `str` | ✅ | "tz" | +| TH | `str` | ✅ | "th" | +| TL | `str` | ✅ | "tl" | +| TG | `str` | ✅ | "tg" | +| TK | `str` | ✅ | "tk" | +| TO | `str` | ✅ | "to" | +| TT | `str` | ✅ | "tt" | +| TN | `str` | ✅ | "tn" | +| TR | `str` | ✅ | "tr" | +| TM | `str` | ✅ | "tm" | +| TC | `str` | ✅ | "tc" | +| TV | `str` | ✅ | "tv" | +| UG | `str` | ✅ | "ug" | +| UA | `str` | ✅ | "ua" | +| AE | `str` | ✅ | "ae" | +| GB | `str` | ✅ | "gb" | +| UM | `str` | ✅ | "um" | +| US | `str` | ✅ | "us" | +| UY | `str` | ✅ | "uy" | +| UZ | `str` | ✅ | "uz" | +| VU | `str` | ✅ | "vu" | +| VE | `str` | ✅ | "ve" | +| VN | `str` | ✅ | "vn" | +| VG | `str` | ✅ | "vg" | +| VI | `str` | ✅ | "vi" | +| WF | `str` | ✅ | "wf" | +| EH | `str` | ✅ | "eh" | +| YE | `str` | ✅ | "ye" | +| ZM | `str` | ✅ | "zm" | +| ZW | `str` | ✅ | "zw" | +| AX | `str` | ✅ | "ax" | diff --git a/documentation/models/CreateContainer.md b/documentation/models/CreateContainer.md index 4791076..4f8ee11 100644 --- a/documentation/models/CreateContainer.md +++ b/documentation/models/CreateContainer.md @@ -4,178 +4,178 @@ Represents a container **Properties** -| Name | Type | Required | Description | -| :---------------------- | :------------------------------------ | :------- | :----------------------------------------------------------------------------------------------- | -| image | str | ✅ | | -| resources | ContainerResourceRequirements | ✅ | Represents a container resource requirements | -| command | List[str] | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | -| priority | ContainerGroupPriority | ❌ | | -| environment_variables | dict | ❌ | | -| logging | CreateContainerLogging | ❌ | | -| registry_authentication | CreateContainerRegistryAuthentication | ❌ | | +| Name | Type | Required | Description | +| :---------------------- | :-------------------------------------- | :------- | :----------------------------------------------------------------------------------------------- | +| image | `str` | ✅ | | +| resources | `ContainerResourceRequirements` | ✅ | Represents a container resource requirements | +| command | `List[str]` | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | +| priority | `ContainerGroupPriority` | ❌ | | +| environment_variables | `dict` | ❌ | | +| logging | `CreateContainerLogging` | ❌ | | +| registry_authentication | `CreateContainerRegistryAuthentication` | ❌ | | # CreateContainerLogging **Properties** -| Name | Type | Required | Description | -| :-------- | :--------------- | :------- | :---------- | -| axiom | LoggingAxiom2 | ❌ | | -| datadog | LoggingDatadog2 | ❌ | | -| new_relic | LoggingNewRelic2 | ❌ | | -| splunk | LoggingSplunk2 | ❌ | | -| tcp | LoggingTcp2 | ❌ | | -| http | LoggingHttp2 | ❌ | | +| Name | Type | Required | Description | +| :-------- | :----------------- | :------- | :---------- | +| axiom | `LoggingAxiom2` | ❌ | | +| datadog | `LoggingDatadog2` | ❌ | | +| new_relic | `LoggingNewRelic2` | ❌ | | +| splunk | `LoggingSplunk2` | ❌ | | +| tcp | `LoggingTcp2` | ❌ | | +| http | `LoggingHttp2` | ❌ | | # LoggingAxiom_2 **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| host | str | ✅ | | -| api_token | str | ✅ | | -| dataset | str | ✅ | | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| api_token | `str` | ✅ | | +| dataset | `str` | ✅ | | # LoggingDatadog_2 **Properties** -| Name | Type | Required | Description | -| :------ | :----------------- | :------- | :---------- | -| host | str | ✅ | | -| api_key | str | ✅ | | -| tags | List[DatadogTags2] | ❌ | | +| Name | Type | Required | Description | +| :------ | :------------------- | :------- | :---------- | +| host | `str` | ✅ | | +| api_key | `str` | ✅ | | +| tags | `List[DatadogTags2]` | ❌ | | # DatadogTags_2 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | # LoggingNewRelic_2 **Properties** -| Name | Type | Required | Description | -| :------------ | :--- | :------- | :---------- | -| host | str | ✅ | | -| ingestion_key | str | ✅ | | +| Name | Type | Required | Description | +| :------------ | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| ingestion_key | `str` | ✅ | | # LoggingSplunk_2 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| host | str | ✅ | | -| token | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| token | `str` | ✅ | | # LoggingTcp_2 **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| host | str | ✅ | | -| port | int | ✅ | | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| port | `int` | ✅ | | # LoggingHttp_2 **Properties** -| Name | Type | Required | Description | -| :---------- | :----------------- | :------- | :---------- | -| host | str | ✅ | | -| port | int | ✅ | | -| format | HttpFormat2 | ✅ | | -| compression | HttpCompression2 | ✅ | | -| user | str | ❌ | | -| password | str | ❌ | | -| path | str | ❌ | | -| headers | List[HttpHeaders3] | ❌ | | +| Name | Type | Required | Description | +| :---------- | :------------------- | :------- | :---------- | +| host | `str` | ✅ | | +| port | `int` | ✅ | | +| format | `HttpFormat2` | ✅ | | +| compression | `HttpCompression2` | ✅ | | +| user | `str` | ❌ | | +| password | `str` | ❌ | | +| path | `str` | ❌ | | +| headers | `List[HttpHeaders3]` | ❌ | | # HttpFormat_2 **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :----------- | -| JSON | str | ✅ | "json" | -| JSONLINES | str | ✅ | "json_lines" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :----------- | +| JSON | `str` | ✅ | "json" | +| JSONLINES | `str` | ✅ | "json_lines" | # HttpHeaders_3 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | # HttpCompression_2 **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| NONE | str | ✅ | "none" | -| GZIP | str | ✅ | "gzip" | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| NONE | `str` | ✅ | "none" | +| GZIP | `str` | ✅ | "gzip" | # CreateContainerRegistryAuthentication **Properties** -| Name | Type | Required | Description | -| :--------- | :------------------------------- | :------- | :---------- | -| basic | RegistryAuthenticationBasic1 | ❌ | | -| gcp_gcr | RegistryAuthenticationGcpGcr1 | ❌ | | -| aws_ecr | RegistryAuthenticationAwsEcr1 | ❌ | | -| docker_hub | RegistryAuthenticationDockerHub1 | ❌ | | -| gcp_gar | RegistryAuthenticationGcpGar1 | ❌ | | +| Name | Type | Required | Description | +| :--------- | :--------------------------------- | :------- | :---------- | +| basic | `RegistryAuthenticationBasic1` | ❌ | | +| gcp_gcr | `RegistryAuthenticationGcpGcr1` | ❌ | | +| aws_ecr | `RegistryAuthenticationAwsEcr1` | ❌ | | +| docker_hub | `RegistryAuthenticationDockerHub1` | ❌ | | +| gcp_gar | `RegistryAuthenticationGcpGar1` | ❌ | | # RegistryAuthenticationBasic_1 **Properties** -| Name | Type | Required | Description | -| :------- | :--- | :------- | :---------- | -| username | str | ✅ | | -| password | str | ✅ | | +| Name | Type | Required | Description | +| :------- | :---- | :------- | :---------- | +| username | `str` | ✅ | | +| password | `str` | ✅ | | # RegistryAuthenticationGcpGcr_1 **Properties** -| Name | Type | Required | Description | -| :---------- | :--- | :------- | :---------- | -| service_key | str | ✅ | | +| Name | Type | Required | Description | +| :---------- | :---- | :------- | :---------- | +| service_key | `str` | ✅ | | # RegistryAuthenticationAwsEcr_1 **Properties** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :---------- | -| access_key_id | str | ✅ | | -| secret_access_key | str | ✅ | | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :---------- | +| access_key_id | `str` | ✅ | | +| secret_access_key | `str` | ✅ | | # RegistryAuthenticationDockerHub_1 **Properties** -| Name | Type | Required | Description | -| :-------------------- | :--- | :------- | :---------- | -| username | str | ✅ | | -| personal_access_token | str | ✅ | | +| Name | Type | Required | Description | +| :-------------------- | :---- | :------- | :---------- | +| username | `str` | ✅ | | +| personal_access_token | `str` | ✅ | | # RegistryAuthenticationGcpGar_1 **Properties** -| Name | Type | Required | Description | -| :---------- | :--- | :------- | :---------- | -| service_key | str | ✅ | | +| Name | Type | Required | Description | +| :---------- | :---- | :------- | :---------- | +| service_key | `str` | ✅ | | diff --git a/documentation/models/CreateContainerGroup.md b/documentation/models/CreateContainerGroup.md index 9ba37be..694d249 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 | str | ✅ | | -| container | CreateContainer | ✅ | Represents a container | -| autostart_policy | bool | ✅ | | -| restart_policy | ContainerRestartPolicy | ✅ | | -| replicas | int | ✅ | | -| display_name | str | ❌ | | -| country_codes | List[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 | -| liveness_probe | ContainerGroupLivenessProbe | ❌ | Represents the container group liveness probe | -| readiness_probe | ContainerGroupReadinessProbe | ❌ | Represents the container group readiness probe | -| startup_probe | ContainerGroupStartupProbe | ❌ | Represents the container group startup probe | -| queue_connection | ContainerGroupQueueConnection | ❌ | Represents container group queue connection | +| Name | Type | Required | Description | +| :--------------- | :------------------------------- | :------- | :---------------------------------------------------------------------------------------------- | +| name | `str` | ✅ | | +| container | `CreateContainer` | ✅ | Represents a container | +| autostart_policy | `bool` | ✅ | | +| restart_policy | `ContainerRestartPolicy` | ✅ | | +| replicas | `int` | ✅ | | +| display_name | `str` | ❌ | | +| country_codes | `List[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 | +| liveness_probe | `ContainerGroupLivenessProbe` | ❌ | Represents the container group liveness probe | +| readiness_probe | `ContainerGroupReadinessProbe` | ❌ | Represents the container group readiness probe | +| startup_probe | `ContainerGroupStartupProbe` | ❌ | Represents the container group startup probe | +| queue_connection | `ContainerGroupQueueConnection` | ❌ | Represents container group queue connection | +| queue_autoscaler | `QueueAutoscaler` | ❌ | Represents the autoscaling rules for a queue | diff --git a/documentation/models/CreateContainerGroupNetworking.md b/documentation/models/CreateContainerGroupNetworking.md index 03f1a74..309f797 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 | int | ✅ | | -| auth | bool | ✅ | | +| Name | Type | Required | Description | +| :------- | :---------------------------- | :------- | :---------- | +| protocol | `ContainerNetworkingProtocol` | ✅ | | +| port | `int` | ✅ | | +| auth | `bool` | ✅ | | diff --git a/documentation/models/CreateInferenceEndpointJob.md b/documentation/models/CreateInferenceEndpointJob.md index 566fd60..a693a0d 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 | dict | ❌ | | -| webhook | str | ❌ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :------------------------------------ | +| input | `any` | ✅ | The job input. May be any valid JSON. | +| metadata | `dict` | ❌ | | +| webhook | `str` | ❌ | | diff --git a/documentation/models/CreateQueue.md b/documentation/models/CreateQueue.md index 371bb1a..84a23fd 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 | str | ✅ | The queue name. This must be unique within the project. | -| display_name | str | ❌ | The display name. This may be used as a more human-readable name. | -| description | str | ❌ | The description. This may be used as a space for notes or other information about the queue. | +| Name | Type | Required | Description | +| :----------- | :---- | :------- | :------------------------------------------------------------------------------------------- | +| name | `str` | ✅ | The queue name. This must be unique within the project. | +| display_name | `str` | ❌ | The display name. This may be used as a more human-readable name. | +| description | `str` | ❌ | 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 adcc57b..934095b 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 | dict | ❌ | | -| webhook | str | ❌ | | +| Name | Type | Required | Description | +| :------- | :----- | :------- | :------------------------------------ | +| input | `any` | ✅ | The job input. May be any valid JSON. | +| metadata | `dict` | ❌ | | +| webhook | `str` | ❌ | | diff --git a/documentation/models/GpuClass.md b/documentation/models/GpuClass.md index 2703690..5ef3b84 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\_ | str | ✅ | The unique identifier | -| name | str | ✅ | The GPU class name | -| prices | List[GpuClassPrice] | ✅ | The list of prices for each container group priority | -| is_high_demand | bool | ❌ | Whether the GPU class is in high demand | +| Name | Type | Required | Description | +| :------------- | :-------------------- | :------- | :--------------------------------------------------- | +| id\_ | `str` | ✅ | The unique identifier | +| name | `str` | ✅ | The GPU class name | +| prices | `List[GpuClassPrice]` | ✅ | The list of prices for each container group priority | +| is_high_demand | `bool` | ❌ | Whether the GPU class is in high demand | diff --git a/documentation/models/GpuClassPrice.md b/documentation/models/GpuClassPrice.md index 651381a..5323beb 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 | str | ✅ | The price | +| Name | Type | Required | Description | +| :------- | :----------------------- | :------- | :---------- | +| priority | `ContainerGroupPriority` | ✅ | | +| price | `str` | ✅ | The price | diff --git a/documentation/models/GpuClassesList.md b/documentation/models/GpuClassesList.md index 00895de..e8f3bae 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 | List[GpuClass] | ✅ | The list of GPU classes | +| Name | Type | Required | Description | +| :---- | :--------------- | :------- | :---------------------- | +| items | `List[GpuClass]` | ✅ | The list of GPU classes | diff --git a/documentation/models/InferenceEndpoint.md b/documentation/models/InferenceEndpoint.md index f5e15c4..1362d9b 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\_ | str | ✅ | The unique identifier | -| name | str | ✅ | The inference endpoint name | -| display_name | str | ✅ | The inference endpoint display name | -| description | str | ✅ | a brief description of the inference endpoint | -| endpoint_url | str | ✅ | The URL of the inference endpoint | -| readme | str | ✅ | A markdown file containing a detailed description of the inference endpoint | -| price_description | str | ✅ | A description of the price | -| icon_image | str | ✅ | The URL of the icon image | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------- | +| id\_ | `str` | ✅ | The unique identifier | +| name | `str` | ✅ | The inference endpoint name | +| display_name | `str` | ✅ | The inference endpoint display name | +| description | `str` | ✅ | a brief description of the inference endpoint | +| endpoint_url | `str` | ✅ | The URL of the inference endpoint | +| readme | `str` | ✅ | A markdown file containing a detailed description of the inference endpoint | +| price_description | `str` | ✅ | A description of the price | +| icon_image | `str` | ✅ | The URL of the icon image | diff --git a/documentation/models/InferenceEndpointJob.md b/documentation/models/InferenceEndpointJob.md index 2cad4bd..0c06a8d 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\_ | str | ✅ | | -| input | any | ✅ | The job input. May be any valid JSON. | -| inference_endpoint_name | str | ✅ | The inference endpoint name | -| status | InferenceEndpointJobStatus | ✅ | | -| events | List[InferenceEndpointJobEvent] | ✅ | | -| organization_name | str | ✅ | The organization name | -| create_time | str | ✅ | | -| update_time | str | ✅ | | -| metadata | dict | ❌ | | -| webhook | str | ❌ | | -| output | any | ❌ | The job output. May be any valid JSON. | +| Name | Type | Required | Description | +| :---------------------- | :-------------------------------- | :------- | :------------------------------------- | +| id\_ | `str` | ✅ | | +| input | `any` | ✅ | The job input. May be any valid JSON. | +| inference_endpoint_name | `str` | ✅ | The inference endpoint name | +| status | `InferenceEndpointJobStatus` | ✅ | | +| events | `List[InferenceEndpointJobEvent]` | ✅ | | +| organization_name | `str` | ✅ | The organization name | +| create_time | `str` | ✅ | | +| update_time | `str` | ✅ | | +| metadata | `dict` | ❌ | | +| webhook | `str` | ❌ | | +| output | `any` | ❌ | The job output. May be any valid JSON. | # InferenceEndpointJobStatus **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| PENDING | str | ✅ | "pending" | -| RUNNING | str | ✅ | "running" | -| SUCCEEDED | str | ✅ | "succeeded" | -| CANCELLED | str | ✅ | "cancelled" | -| FAILED | str | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| PENDING | `str` | ✅ | "pending" | +| RUNNING | `str` | ✅ | "running" | +| SUCCEEDED | `str` | ✅ | "succeeded" | +| CANCELLED | `str` | ✅ | "cancelled" | +| FAILED | `str` | ✅ | "failed" | diff --git a/documentation/models/InferenceEndpointJobEvent.md b/documentation/models/InferenceEndpointJobEvent.md index f26e976..978b5cd 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 | str | ✅ | | +| Name | Type | Required | Description | +| :----- | :-------------------------------- | :------- | :---------- | +| action | `InferenceEndpointJobEventAction` | ✅ | | +| time | `str` | ✅ | | # InferenceEndpointJobEventAction **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| CREATED | str | ✅ | "created" | -| STARTED | str | ✅ | "started" | -| SUCCEEDED | str | ✅ | "succeeded" | -| CANCELLED | str | ✅ | "cancelled" | -| FAILED | str | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| CREATED | `str` | ✅ | "created" | +| STARTED | `str` | ✅ | "started" | +| SUCCEEDED | `str` | ✅ | "succeeded" | +| CANCELLED | `str` | ✅ | "cancelled" | +| FAILED | `str` | ✅ | "failed" | diff --git a/documentation/models/InferenceEndpointJobList.md b/documentation/models/InferenceEndpointJobList.md index c29f81d..fdc40aa 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 | List[InferenceEndpointJob] | ✅ | The list of items | +| Name | Type | Required | Description | +| :---- | :--------------------------- | :------- | :---------------- | +| items | `List[InferenceEndpointJob]` | ✅ | The list of items | diff --git a/documentation/models/InferenceEndpointsList.md b/documentation/models/InferenceEndpointsList.md index ded2db5..fa79092 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 | List[InferenceEndpoint] | ✅ | The list of items | +| Name | Type | Required | Description | +| :---- | :------------------------ | :------- | :---------------- | +| items | `List[InferenceEndpoint]` | ✅ | The list of items | diff --git a/documentation/models/Queue.md b/documentation/models/Queue.md index 6ab5f54..64e7fe5 100644 --- a/documentation/models/Queue.md +++ b/documentation/models/Queue.md @@ -4,12 +4,12 @@ Represents a queue. **Properties** -| Name | Type | Required | Description | -| :--------------- | :------------------- | :------- | :-------------------------------------------------------------------------------------------- | -| id\_ | str | ✅ | The queue identifier. This is automatically generated and assigned when the queue is created. | -| name | str | ✅ | The queue name. This must be unique within the project. | -| display_name | str | ✅ | The display name. This may be used as a more human-readable name. | -| container_groups | List[ContainerGroup] | ✅ | | -| create_time | str | ✅ | The date and time the queue was created. | -| update_time | str | ✅ | The date and time the queue was last updated. | -| description | str | ❌ | The description. This may be used as a space for notes or other information about the queue. | +| Name | Type | Required | Description | +| :--------------- | :--------------------- | :------- | :-------------------------------------------------------------------------------------------- | +| id\_ | `str` | ✅ | The queue identifier. This is automatically generated and assigned when the queue is created. | +| name | `str` | ✅ | The queue name. This must be unique within the project. | +| display_name | `str` | ✅ | The display name. This may be used as a more human-readable name. | +| container_groups | `List[ContainerGroup]` | ✅ | | +| create_time | `str` | ✅ | The date and time the queue was created. | +| update_time | `str` | ✅ | The date and time the queue was last updated. | +| description | `str` | ❌ | 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..d892485 --- /dev/null +++ b/documentation/models/QueueAutoscaler.md @@ -0,0 +1,14 @@ +# QueueAutoscaler + +Represents the autoscaling rules for a queue + +**Properties** + +| Name | Type | Required | Description | +| :----------------------- | :---- | :------- | :---------- | +| min_replicas | `int` | ✅ | | +| max_replicas | `int` | ✅ | | +| desired_queue_length | `int` | ✅ | | +| polling_period | `int` | ❌ | | +| max_upscale_per_minute | `int` | ❌ | | +| max_downscale_per_minute | `int` | ❌ | | diff --git a/documentation/models/QueueJob.md b/documentation/models/QueueJob.md index 972a2b9..706b033 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\_ | str | ✅ | | -| input | any | ✅ | The job input. May be any valid JSON. | -| status | QueueJobStatus | ✅ | | -| events | List[QueueJobEvent] | ✅ | | -| create_time | str | ✅ | | -| update_time | str | ✅ | | -| metadata | dict | ❌ | | -| webhook | str | ❌ | | -| output | any | ❌ | The job output. May be any valid JSON. | +| Name | Type | Required | Description | +| :---------- | :-------------------- | :------- | :------------------------------------- | +| id\_ | `str` | ✅ | | +| input | `any` | ✅ | The job input. May be any valid JSON. | +| status | `QueueJobStatus` | ✅ | | +| events | `List[QueueJobEvent]` | ✅ | | +| create_time | `str` | ✅ | | +| update_time | `str` | ✅ | | +| metadata | `dict` | ❌ | | +| webhook | `str` | ❌ | | +| output | `any` | ❌ | The job output. May be any valid JSON. | # QueueJobStatus **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| PENDING | str | ✅ | "pending" | -| RUNNING | str | ✅ | "running" | -| SUCCEEDED | str | ✅ | "succeeded" | -| CANCELLED | str | ✅ | "cancelled" | -| FAILED | str | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| PENDING | `str` | ✅ | "pending" | +| RUNNING | `str` | ✅ | "running" | +| SUCCEEDED | `str` | ✅ | "succeeded" | +| CANCELLED | `str` | ✅ | "cancelled" | +| FAILED | `str` | ✅ | "failed" | diff --git a/documentation/models/QueueJobEvent.md b/documentation/models/QueueJobEvent.md index d0646ea..2d84d7b 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 | str | ✅ | | +| Name | Type | Required | Description | +| :----- | :-------------------- | :------- | :---------- | +| action | `QueueJobEventAction` | ✅ | | +| time | `str` | ✅ | | # QueueJobEventAction **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| CREATED | str | ✅ | "created" | -| STARTED | str | ✅ | "started" | -| SUCCEEDED | str | ✅ | "succeeded" | -| CANCELLED | str | ✅ | "cancelled" | -| FAILED | str | ✅ | "failed" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| CREATED | `str` | ✅ | "created" | +| STARTED | `str` | ✅ | "started" | +| SUCCEEDED | `str` | ✅ | "succeeded" | +| CANCELLED | `str` | ✅ | "cancelled" | +| FAILED | `str` | ✅ | "failed" | diff --git a/documentation/models/QueueJobList.md b/documentation/models/QueueJobList.md index fafc107..2985eef 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 | List[QueueJob] | ✅ | | +| Name | Type | Required | Description | +| :---- | :--------------- | :------- | :---------- | +| items | `List[QueueJob]` | ✅ | | diff --git a/documentation/models/QueueList.md b/documentation/models/QueueList.md index 6192e0d..4cf404d 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 | List[Queue] | ✅ | The list of queues. | +| Name | Type | Required | Description | +| :---- | :------------ | :------- | :------------------ | +| items | `List[Queue]` | ✅ | The list of queues. | diff --git a/documentation/models/Quotas.md b/documentation/models/Quotas.md index 9c8d40b..af5e22f 100644 --- a/documentation/models/Quotas.md +++ b/documentation/models/Quotas.md @@ -4,9 +4,9 @@ Represents the organization quotas **Properties** -| Name | Type | Required | Description | -| :---------------------- | :-------------------- | :------- | :------------------------------------- | -| container_groups_quotas | ContainerGroupsQuotas | ✅ | | -| recipes_quotas | RecipesQuotas | ✅ | | -| create_time | str | ❌ | The time the resource was created | -| update_time | str | ❌ | The time the resource was last updated | +| Name | Type | Required | Description | +| :---------------------- | :---------------------- | :------- | :------------------------------------- | +| container_groups_quotas | `ContainerGroupsQuotas` | ✅ | | +| recipes_quotas | `RecipesQuotas` | ✅ | | +| create_time | `str` | ❌ | The time the resource was created | +| update_time | `str` | ❌ | The time the resource was last updated | diff --git a/documentation/models/RecipesQuotas.md b/documentation/models/RecipesQuotas.md index 0a3c2a9..87e7f52 100644 --- a/documentation/models/RecipesQuotas.md +++ b/documentation/models/RecipesQuotas.md @@ -2,7 +2,7 @@ **Properties** -| Name | Type | Required | Description | -| :----------------------------- | :--- | :------- | :---------- | -| max_created_recipe_deployments | int | ✅ | | -| recipe_instance_quota | int | ✅ | | +| Name | Type | Required | Description | +| :----------------------------- | :---- | :------- | :---------- | +| max_created_recipe_deployments | `int` | ✅ | | +| recipe_instance_quota | `int` | ✅ | | diff --git a/documentation/models/UpdateContainer.md b/documentation/models/UpdateContainer.md index f810f92..4ea9533 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 | str | ❌ | | -| resources | Resources | ❌ | | -| command | List[str] | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | -| priority | ContainerGroupPriority | ❌ | | -| environment_variables | dict | ❌ | | -| logging | UpdateContainerLogging | ❌ | | -| registry_authentication | UpdateContainerRegistryAuthentication | ❌ | | +| Name | Type | Required | Description | +| :---------------------- | :-------------------------------------- | :------- | :----------------------------------------------------------------------------------------------- | +| image | `str` | ❌ | | +| resources | `Resources` | ❌ | | +| command | `List[str]` | ❌ | Pass a command (and optional arguments) to override the ENTRYPOINT and CMD of a container image. | +| priority | `ContainerGroupPriority` | ❌ | | +| environment_variables | `dict` | ❌ | | +| logging | `UpdateContainerLogging` | ❌ | | +| registry_authentication | `UpdateContainerRegistryAuthentication` | ❌ | | # Resources **Properties** -| Name | Type | Required | Description | -| :------------- | :-------- | :------- | :---------- | -| cpu | int | ❌ | | -| memory | int | ❌ | | -| gpu_classes | List[str] | ❌ | | -| storage_amount | int | ❌ | | +| Name | Type | Required | Description | +| :------------- | :---------- | :------- | :---------- | +| cpu | `int` | ❌ | | +| memory | `int` | ❌ | | +| gpu_classes | `List[str]` | ❌ | | +| storage_amount | `int` | ❌ | | # UpdateContainerLogging **Properties** -| Name | Type | Required | Description | -| :-------- | :--------------- | :------- | :---------- | -| axiom | LoggingAxiom3 | ❌ | | -| datadog | LoggingDatadog3 | ❌ | | -| new_relic | LoggingNewRelic3 | ❌ | | -| splunk | LoggingSplunk3 | ❌ | | -| tcp | LoggingTcp3 | ❌ | | -| http | LoggingHttp3 | ❌ | | +| Name | Type | Required | Description | +| :-------- | :----------------- | :------- | :---------- | +| axiom | `LoggingAxiom3` | ❌ | | +| datadog | `LoggingDatadog3` | ❌ | | +| new_relic | `LoggingNewRelic3` | ❌ | | +| splunk | `LoggingSplunk3` | ❌ | | +| tcp | `LoggingTcp3` | ❌ | | +| http | `LoggingHttp3` | ❌ | | # LoggingAxiom_3 **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :---------- | -| host | str | ✅ | | -| api_token | str | ✅ | | -| dataset | str | ✅ | | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| api_token | `str` | ✅ | | +| dataset | `str` | ✅ | | # LoggingDatadog_3 **Properties** -| Name | Type | Required | Description | -| :------ | :----------------- | :------- | :---------- | -| host | str | ✅ | | -| api_key | str | ✅ | | -| tags | List[DatadogTags3] | ❌ | | +| Name | Type | Required | Description | +| :------ | :------------------- | :------- | :---------- | +| host | `str` | ✅ | | +| api_key | `str` | ✅ | | +| tags | `List[DatadogTags3]` | ❌ | | # DatadogTags_3 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | # LoggingNewRelic_3 **Properties** -| Name | Type | Required | Description | -| :------------ | :--- | :------- | :---------- | -| host | str | ✅ | | -| ingestion_key | str | ✅ | | +| Name | Type | Required | Description | +| :------------ | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| ingestion_key | `str` | ✅ | | # LoggingSplunk_3 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| host | str | ✅ | | -| token | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| token | `str` | ✅ | | # LoggingTcp_3 **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| host | str | ✅ | | -| port | int | ✅ | | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| host | `str` | ✅ | | +| port | `int` | ✅ | | # LoggingHttp_3 **Properties** -| Name | Type | Required | Description | -| :---------- | :----------------- | :------- | :---------- | -| host | str | ✅ | | -| port | int | ✅ | | -| format | HttpFormat3 | ✅ | | -| compression | HttpCompression3 | ✅ | | -| user | str | ❌ | | -| password | str | ❌ | | -| path | str | ❌ | | -| headers | List[HttpHeaders4] | ❌ | | +| Name | Type | Required | Description | +| :---------- | :------------------- | :------- | :---------- | +| host | `str` | ✅ | | +| port | `int` | ✅ | | +| format | `HttpFormat3` | ✅ | | +| compression | `HttpCompression3` | ✅ | | +| user | `str` | ❌ | | +| password | `str` | ❌ | | +| path | `str` | ❌ | | +| headers | `List[HttpHeaders4]` | ❌ | | # HttpFormat_3 **Properties** -| Name | Type | Required | Description | -| :-------- | :--- | :------- | :----------- | -| JSON | str | ✅ | "json" | -| JSONLINES | str | ✅ | "json_lines" | +| Name | Type | Required | Description | +| :-------- | :---- | :------- | :----------- | +| JSON | `str` | ✅ | "json" | +| JSONLINES | `str` | ✅ | "json_lines" | # HttpHeaders_4 **Properties** -| Name | Type | Required | Description | -| :---- | :--- | :------- | :---------- | -| name | str | ✅ | | -| value | str | ✅ | | +| Name | Type | Required | Description | +| :---- | :---- | :------- | :---------- | +| name | `str` | ✅ | | +| value | `str` | ✅ | | # HttpCompression_3 **Properties** -| Name | Type | Required | Description | -| :--- | :--- | :------- | :---------- | -| NONE | str | ✅ | "none" | -| GZIP | str | ✅ | "gzip" | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| NONE | `str` | ✅ | "none" | +| GZIP | `str` | ✅ | "gzip" | # UpdateContainerRegistryAuthentication **Properties** -| Name | Type | Required | Description | -| :--------- | :------------------------------- | :------- | :---------- | -| basic | RegistryAuthenticationBasic2 | ❌ | | -| gcp_gcr | RegistryAuthenticationGcpGcr2 | ❌ | | -| aws_ecr | RegistryAuthenticationAwsEcr2 | ❌ | | -| docker_hub | RegistryAuthenticationDockerHub2 | ❌ | | -| gcp_gar | RegistryAuthenticationGcpGar2 | ❌ | | +| Name | Type | Required | Description | +| :--------- | :--------------------------------- | :------- | :---------- | +| basic | `RegistryAuthenticationBasic2` | ❌ | | +| gcp_gcr | `RegistryAuthenticationGcpGcr2` | ❌ | | +| aws_ecr | `RegistryAuthenticationAwsEcr2` | ❌ | | +| docker_hub | `RegistryAuthenticationDockerHub2` | ❌ | | +| gcp_gar | `RegistryAuthenticationGcpGar2` | ❌ | | # RegistryAuthenticationBasic_2 **Properties** -| Name | Type | Required | Description | -| :------- | :--- | :------- | :---------- | -| username | str | ✅ | | -| password | str | ✅ | | +| Name | Type | Required | Description | +| :------- | :---- | :------- | :---------- | +| username | `str` | ✅ | | +| password | `str` | ✅ | | # RegistryAuthenticationGcpGcr_2 **Properties** -| Name | Type | Required | Description | -| :---------- | :--- | :------- | :---------- | -| service_key | str | ✅ | | +| Name | Type | Required | Description | +| :---------- | :---- | :------- | :---------- | +| service_key | `str` | ✅ | | # RegistryAuthenticationAwsEcr_2 **Properties** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :---------- | -| access_key_id | str | ✅ | | -| secret_access_key | str | ✅ | | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :---------- | +| access_key_id | `str` | ✅ | | +| secret_access_key | `str` | ✅ | | # RegistryAuthenticationDockerHub_2 **Properties** -| Name | Type | Required | Description | -| :-------------------- | :--- | :------- | :---------- | -| username | str | ✅ | | -| personal_access_token | str | ✅ | | +| Name | Type | Required | Description | +| :-------------------- | :---- | :------- | :---------- | +| username | `str` | ✅ | | +| personal_access_token | `str` | ✅ | | # RegistryAuthenticationGcpGar_2 **Properties** -| Name | Type | Required | Description | -| :---------- | :--- | :------- | :---------- | -| service_key | str | ✅ | | +| Name | Type | Required | Description | +| :---------- | :---- | :------- | :---------- | +| service_key | `str` | ✅ | | diff --git a/documentation/models/UpdateContainerGroup.md b/documentation/models/UpdateContainerGroup.md index b4695dc..3473bb5 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 | -| :-------------- | :----------------------------- | :------- | :---------------------------------------------------------------------------------------------- | -| display_name | str | ❌ | | -| container | UpdateContainer | ❌ | Represents an update container object | -| replicas | int | ❌ | | -| country_codes | List[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 | -| liveness_probe | ContainerGroupLivenessProbe | ❌ | Represents the container group liveness probe | -| readiness_probe | ContainerGroupReadinessProbe | ❌ | Represents the container group readiness probe | -| startup_probe | ContainerGroupStartupProbe | ❌ | Represents the container group startup probe | +| Name | Type | Required | Description | +| :-------------- | :------------------------------- | :------- | :---------------------------------------------------------------------------------------------- | +| display_name | `str` | ❌ | | +| container | `UpdateContainer` | ❌ | Represents an update container object | +| replicas | `int` | ❌ | | +| country_codes | `List[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 | +| liveness_probe | `ContainerGroupLivenessProbe` | ❌ | Represents the container group liveness probe | +| readiness_probe | `ContainerGroupReadinessProbe` | ❌ | Represents the container group readiness probe | +| startup_probe | `ContainerGroupStartupProbe` | ❌ | Represents the container group startup probe | diff --git a/documentation/models/UpdateContainerGroupNetworking.md b/documentation/models/UpdateContainerGroupNetworking.md index 56116fa..0e096ee 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 | int | ❌ | | +| Name | Type | Required | Description | +| :--- | :---- | :------- | :---------- | +| port | `int` | ❌ | | diff --git a/documentation/models/UpdateQueue.md b/documentation/models/UpdateQueue.md index 204671f..5f9c9dc 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 | -| :----------- | :--- | :------- | :------------------------------------------------------------------------------------------- | -| display_name | str | ❌ | The display name. This may be used as a more human-readable name. | -| description | str | ❌ | The description. This may be used as a space for notes or other information about the queue. | +| Name | Type | Required | Description | +| :----------- | :---- | :------- | :------------------------------------------------------------------------------------------- | +| display_name | `str` | ❌ | The display name. This may be used as a more human-readable name. | +| description | `str` | ❌ | 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 baf3511..a942d3c 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 | -| :--------- | :--- | :------- | :--------------------- | -| secret_key | str | ✅ | The webhook secret key | +| Name | Type | Required | Description | +| :--------- | :---- | :------- | :--------------------- | +| secret_key | `str` | ✅ | The webhook secret key | diff --git a/documentation/models/WorkloadError.md b/documentation/models/WorkloadError.md index a06ef80..2ae9f17 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 | str | ✅ | | -| failed_at | str | ✅ | | -| instance_id | str | ✅ | | -| machine_id | str | ✅ | | -| allocated_at | str | ✅ | | -| version | int | ✅ | | -| started_at | str | ❌ | | +| Name | Type | Required | Description | +| :----------- | :---- | :------- | :---------- | +| detail | `str` | ✅ | | +| failed_at | `str` | ✅ | | +| instance_id | `str` | ✅ | | +| machine_id | `str` | ✅ | | +| allocated_at | `str` | ✅ | | +| version | `int` | ✅ | | +| started_at | `str` | ❌ | | diff --git a/documentation/models/WorkloadErrorList.md b/documentation/models/WorkloadErrorList.md index 38fc572..555893e 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 | List[WorkloadError] | ✅ | | +| Name | Type | Required | Description | +| :---- | :-------------------- | :------- | :---------- | +| items | `List[WorkloadError]` | ✅ | | diff --git a/documentation/services/ContainerGroupsService.md b/documentation/services/ContainerGroupsService.md index 0f152f0..589f445 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 | -| :-------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | -| [list_container_groups](#list_container_groups) | Gets the list of container groups | -| [create_container_group](#create_container_group) | Creates a new container group | -| [get_container_group](#get_container_group) | Gets a container group | -| [update_container_group](#update_container_group) | Updates a container group | -| [delete_container_group](#delete_container_group) | Deletes a container group | -| [start_container_group](#start_container_group) | Starts a container group | -| [stop_container_group](#stop_container_group) | Stops a container group | -| [list_container_group_instances](#list_container_group_instances) | Retrieves a list of container group instances | -| [get_container_group_instance](#get_container_group_instance) | Retrieves the details of a single instance within a container group by instance ID | -| [reallocate_container_group_instance](#reallocate_container_group_instance) | Remove a node from a workload and reallocate the workload to a different node | -| [recreate_container_group_instance](#recreate_container_group_instance) | Stops a container, destroys it, creates a new one without requiring the image to be downloaded again on a different node | -| [restart_container_group_instance](#restart_container_group_instance) | Restarts a workload on a node without reallocating it | +| Methods | Description | +| :-------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | +| [list_container_groups](#list_container_groups) | Gets the list of container groups | +| [create_container_group](#create_container_group) | Creates a new container group | +| [get_container_group](#get_container_group) | Gets a container group | +| [update_container_group](#update_container_group) | Updates a container group | +| [delete_container_group](#delete_container_group) | Deletes a container group | +| [start_container_group](#start_container_group) | Starts a container group | +| [stop_container_group](#stop_container_group) | Stops a container group | +| [list_container_group_instances](#list_container_group_instances) | Gets the list of container group instances | +| [get_container_group_instance](#get_container_group_instance) | Gets a container group instance | +| [reallocate_container_group_instance](#reallocate_container_group_instance) | Reallocates a container group instance to run on a different Salad Node | +| [recreate_container_group_instance](#recreate_container_group_instance) | Stops a container, destroys it, and starts a new one without requiring the image to be downloaded again on a new Salad Node | +| [restart_container_group_instance](#restart_container_group_instance) | Stops a container and restarts it on the same Salad Node | ## list_container_groups @@ -26,10 +26,10 @@ Gets the list of container groups **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -48,8 +48,8 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.list_container_groups( - organization_name="nhyrq", - project_name="r92pbz5hsuado6z0y3kws22ptp7cp7eaw33zizk" + organization_name="v50imwzgi4em4q035", + project_name="m6yw3-xm60cb7tiev8rketqiiwjepibzf2ust1cvjx8oua8mepeueo5-1" ) print(result) @@ -64,11 +64,11 @@ Creates a new container group **Parameters** -| Name | Type | Required | Description | -| :---------------- | :-------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| request_body | [CreateContainerGroup](../models/CreateContainerGroup.md) | ✅ | The request body. | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :---------------- | :---------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| request_body | `[CreateContainerGroup](../models/CreateContainerGroup.md)` | ✅ | The request body. | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -88,17 +88,17 @@ sdk = SaladCloudSdk( ) request_body = CreateContainerGroup( - name="yywq967xo8ifvlka8kdg6t3d8cqm9k9rc7a8bvhvcpg50j51gan4fglcmonhm", - display_name="0hxi6,PR", + name="qfojt-6ccoil4t55-ccoyybgw92dermtsdfn3t2xmag", + display_name="O0hSlJUW", container={ - "image": "nostrud aute adipisicing", + "image": "voluptate officia adipisicing", "resources": { "cpu": 10, - "memory": 7505, + "memory": 17858, "gpu_classes": [ "gpu_classes" ], - "storage_amount": 3605508236 + "storage_amount": 32391110488 }, "command": [ "command" @@ -107,13 +107,13 @@ request_body = CreateContainerGroup( "environment_variables": {}, "logging": { "axiom": { - "host": "sed", - "api_token": "nisi elit est", - "dataset": "Excepteur" + "host": "Ut con", + "api_token": "nostrud irure dolore", + "dataset": "mollit irure et Duis dolore" }, "datadog": { - "host": "Lorem magna qui Duis", - "api_key": "minim aliquip qui", + "host": "pariatur", + "api_key": "non ut", "tags": [ { "name": "name", @@ -122,20 +122,20 @@ request_body = CreateContainerGroup( ] }, "new_relic": { - "host": "adipisicing", - "ingestion_key": "culpa enim" + "host": "cupidatat cillum est sit minim", + "ingestion_key": "dolore laboris fugiat Duis" }, "splunk": { - "host": "ut", - "token": "aliquip dolore" + "host": "aliquip velit culpa", + "token": "ex" }, "tcp": { - "host": "irure reprehenderit ut", - "port": 26986 + "host": "aliqua", + "port": 17249 }, "http": { - "host": "cupidatat irure reprehenderit amet", - "port": 9553, + "host": "magna", + "port": 62049, "user": "user", "password": "password", "path": "path", @@ -170,24 +170,24 @@ request_body = CreateContainerGroup( } } }, - autostart_policy=True, + autostart_policy=False, restart_policy="always", - replicas=122, + replicas=114, country_codes=[ "af" ], networking={ "protocol": "http", - "port": 53954, + "port": 9813, "auth": False }, liveness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -198,14 +198,14 @@ request_body = CreateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 1, + "initial_delay_seconds": 5, "period_seconds": 10, "timeout_seconds": 30, "success_threshold": 1, @@ -213,11 +213,11 @@ request_body = CreateContainerGroup( }, readiness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -228,14 +228,14 @@ request_body = CreateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 10, + "initial_delay_seconds": 6, "period_seconds": 1, "timeout_seconds": 1, "success_threshold": 1, @@ -243,11 +243,11 @@ request_body = CreateContainerGroup( }, startup_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -258,30 +258,38 @@ request_body = CreateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 6, + "initial_delay_seconds": 4, "period_seconds": 3, "timeout_seconds": 10, "success_threshold": 2, "failure_threshold": 1200 }, queue_connection={ - "path": "qui cupidatat esse labore", - "port": 36246, - "queue_name": "tv1-ax-msj6w-h3wkst4x03b6y4ltw1qvh-38ot" + "path": "ullamco magna est nulla aliqua", + "port": 49952, + "queue_name": "nnz26lyemw7nednorlqjlsihb42092pn8d" + }, + queue_autoscaler={ + "min_replicas": 57, + "max_replicas": 24, + "desired_queue_length": 20, + "polling_period": 1406, + "max_upscale_per_minute": 35, + "max_downscale_per_minute": 42 } ) result = sdk.container_groups.create_container_group( request_body=request_body, - organization_name="nhyrq", - project_name="r92pbz5hsuado6z0y3kws22ptp7cp7eaw33zizk" + organization_name="v50imwzgi4em4q035", + project_name="m6yw3-xm60cb7tiev8rketqiiwjepibzf2ust1cvjx8oua8mepeueo5-1" ) print(result) @@ -296,11 +304,11 @@ Gets a container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Return Type** @@ -319,9 +327,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.get_container_group( - organization_name="hjn8ph-8qr9s", - project_name="zpcs1c-85eq2giu1ly3ke1lk2gb3mqhp", - container_group_name="obcxrd0mqez" + organization_name="gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw", + project_name="xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz", + container_group_name="ojjj5b9hbe2fr6f5t7j1htjaws1zx3r" ) print(result) @@ -336,12 +344,12 @@ Updates a container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :-------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| request_body | [UpdateContainerGroup](../models/UpdateContainerGroup.md) | ✅ | The request body. | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| request_body | `[UpdateContainerGroup](../models/UpdateContainerGroup.md)` | ✅ | The request body. | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Return Type** @@ -361,16 +369,16 @@ sdk = SaladCloudSdk( ) request_body = UpdateContainerGroup( - display_name="GzGG5v3-Z", + display_name="-xzxtaW.t2I", container={ - "image": "labore mollit tempor elit", + "image": "ex cillum dolor", "resources": { - "cpu": 3, - "memory": 2085, + "cpu": 11, + "memory": 21424, "gpu_classes": [ "gpu_classes" ], - "storage_amount": 27222255995 + "storage_amount": 12333132242 }, "command": [ "command" @@ -379,13 +387,13 @@ request_body = UpdateContainerGroup( "environment_variables": {}, "logging": { "axiom": { - "host": "et in ipsum", - "api_token": "in sit in velit mollit", - "dataset": "in" + "host": "commodo ea exercitation pariatur consequat", + "api_token": "ipsum", + "dataset": "id Excepteur" }, "datadog": { - "host": "incididunt irure", - "api_key": "ea ullamco", + "host": "exercitation aliquip", + "api_key": "veniam", "tags": [ { "name": "name", @@ -394,20 +402,20 @@ request_body = UpdateContainerGroup( ] }, "new_relic": { - "host": "labore irure enim consequat", - "ingestion_key": "aliquip consequat" + "host": "amet velit sed cillum", + "ingestion_key": "et" }, "splunk": { - "host": "ea fugiat", - "token": "nulla pariatur" + "host": "proident", + "token": "est" }, "tcp": { - "host": "reprehenderit magna Ut veniam do", - "port": 37055 + "host": "ut velit ea cillum", + "port": 13557 }, "http": { - "host": "nisi laborum pariatur", - "port": 15435, + "host": "nisi fugiat cupidatat", + "port": 60288, "user": "user", "password": "password", "path": "path", @@ -442,20 +450,20 @@ request_body = UpdateContainerGroup( } } }, - replicas=242, + replicas=110, country_codes=[ "af" ], networking={ - "port": 16926 + "port": 64823 }, liveness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -466,14 +474,14 @@ request_body = UpdateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 1, + "initial_delay_seconds": 5, "period_seconds": 10, "timeout_seconds": 30, "success_threshold": 1, @@ -481,11 +489,11 @@ request_body = UpdateContainerGroup( }, readiness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -496,14 +504,14 @@ request_body = UpdateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 10, + "initial_delay_seconds": 6, "period_seconds": 1, "timeout_seconds": 1, "success_threshold": 1, @@ -511,11 +519,11 @@ request_body = UpdateContainerGroup( }, startup_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -526,14 +534,14 @@ request_body = UpdateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 6, + "initial_delay_seconds": 4, "period_seconds": 3, "timeout_seconds": 10, "success_threshold": 2, @@ -543,9 +551,9 @@ request_body = UpdateContainerGroup( result = sdk.container_groups.update_container_group( request_body=request_body, - organization_name="hjn8ph-8qr9s", - project_name="zpcs1c-85eq2giu1ly3ke1lk2gb3mqhp", - container_group_name="obcxrd0mqez" + organization_name="gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw", + project_name="xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz", + container_group_name="ojjj5b9hbe2fr6f5t7j1htjaws1zx3r" ) print(result) @@ -560,11 +568,11 @@ Deletes a container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Example Usage Code Snippet** @@ -579,9 +587,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.delete_container_group( - organization_name="hjn8ph-8qr9s", - project_name="zpcs1c-85eq2giu1ly3ke1lk2gb3mqhp", - container_group_name="obcxrd0mqez" + organization_name="gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw", + project_name="xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz", + container_group_name="ojjj5b9hbe2fr6f5t7j1htjaws1zx3r" ) print(result) @@ -596,11 +604,11 @@ Starts a container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Example Usage Code Snippet** @@ -615,9 +623,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.start_container_group( - organization_name="x1dy6hcwr9a5xaxeifh6e02xtma0zqz8asfuvjihhlkjxajbi3pwr9bnx", - project_name="y7lm", - container_group_name="l3q-oa3p3" + organization_name="zfx07sgyz1fs97sfhtue78-54vdogp2qrcnt-8a", + project_name="v7jhy3jn2rdf012fi7ouno3mk9", + container_group_name="a4d0ajj5ajjquzeg-z3kvqxtnoxnlzhjhjt-8naw" ) print(result) @@ -632,11 +640,11 @@ Stops a container group **Parameters** -| Name | Type | Required | Description | -| :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Example Usage Code Snippet** @@ -651,9 +659,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.stop_container_group( - organization_name="qg6vce6y8gr9gth6qwq", - project_name="hgk2", - container_group_name="xxf9hw2fg7q6om9s6wkwjqmbzvl-xnxr-q14lm43yp" + organization_name="c0o0gqev-mnkpy8af-s7rq68p2lenu8izbg09xnu6-fkv4dta4yd", + project_name="rpi16e4ddle58fi8u9w2qgnsgj7cnci4p90a72aagy0f001ws1rwna83a3asuz", + container_group_name="fd6ugn07m5xpcp89lefemdke05z4s9eg1d2caksvlhpzm" ) print(result) @@ -661,18 +669,18 @@ print(result) ## list_container_group_instances -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 | -| :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Return Type** @@ -691,9 +699,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.list_container_group_instances( - organization_name="r2ewwqmqzjxx4rgbkz9z0o", - project_name="wsjwmyricvgcl-a", - container_group_name="lfjbdzaim314b-agf7f3di5" + organization_name="dcbh1", + project_name="pdcapp3enb9gd2f4k49vviu53s67ckwwnxsd-gfjsmuxcljdg4t1zzyoj", + container_group_name="vl2kuh4c67m3ae7qwlwipkdye-ad" ) print(result) @@ -701,19 +709,19 @@ print(result) ## get_container_group_instance -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 | -| :-------------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | -| container_group_instance_id | str | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :-------------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | +| container_group_instance_id | `str` | ✅ | The unique instance identifier | **Return Type** @@ -732,9 +740,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.get_container_group_instance( - organization_name="r73buakrgl6y3rjdvhzythcjdr395d9kcqp4cb924r41g8h69zigf6pcd56q", - project_name="ij2glutxyxjzu-kbkyf64swspzpifkfz1iqxdqeh723l4g1l4if4prvjrh", - container_group_name="dy89w4q4lafvnap7fs4nkqpn7ls1z4okwf0mrkx5ngmb8o-bh3029krp8r4nbzi", + organization_name="b0up7kyr7vabeivb96iwcvlvvm1n", + project_name="ngljb", + container_group_name="xtp82b9jzwqov1insghigvfq0donadhrrdqx-2redu46g7e", container_group_instance_id="container_group_instance_id" ) @@ -743,19 +751,19 @@ print(result) ## reallocate_container_group_instance -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 | -| :-------------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | -| container_group_instance_id | str | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :-------------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | +| container_group_instance_id | `str` | ✅ | The unique instance identifier | **Example Usage Code Snippet** @@ -770,9 +778,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.reallocate_container_group_instance( - organization_name="v3y98q43p0yluu6goai4jrn6fimmbqq9dx0ysgegc9lbt3rb5ve2dfxn47rzqt", - project_name="dsz8ru-a-8c24v6nkirwkf0y7", - container_group_name="rvvhdab0-otceyo1pjg79tnitjvskxomth5lg4v240t9", + organization_name="xk27gbnpmwk5xor49bk4ujk7", + project_name="cy1l6xj-5vzihwp4ho850l3faynnuq71ru6y", + container_group_name="mgza-e8llajq25o36x8b-38phh", container_group_instance_id="container_group_instance_id" ) @@ -781,19 +789,19 @@ print(result) ## recreate_container_group_instance -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 | -| :-------------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | -| container_group_instance_id | str | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :-------------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | +| container_group_instance_id | `str` | ✅ | The unique instance identifier | **Example Usage Code Snippet** @@ -808,9 +816,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.recreate_container_group_instance( - organization_name="s6kh32qycsfx2nq31jsr4cu78utkmdfyxq2dutq30f1kgben6cwy2216zw", - project_name="ve8h7ruif57rm1z2f7e741vj2k8eq7ndtsvg8rk9cps8opkv30dop2y", - container_group_name="n53hzo0tabn9gntx3gxr0jo4pi3ty2akde1ugp2xc", + organization_name="pkfh3rhnvt4x30k5t", + project_name="o7r3q30xz", + container_group_name="aq7hd1fjfxgtq8uehil3eplo", container_group_instance_id="container_group_instance_id" ) @@ -819,19 +827,19 @@ print(result) ## restart_container_group_instance -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 | -| :-------------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | -| container_group_instance_id | str | ✅ | The unique instance identifier | +| Name | Type | Required | Description | +| :-------------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | +| container_group_instance_id | `str` | ✅ | The unique instance identifier | **Example Usage Code Snippet** @@ -846,9 +854,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.restart_container_group_instance( - organization_name="ml61xwkce80bgd0", - project_name="kuexscfukz0bups982", - container_group_name="r8gqlu7c", + organization_name="kd79h7bg0vpngqc8hz5pxjwi7muqnmuuqsx3q3zm2hxkci5yv6kho", + project_name="u5ljgqmbs6a7s", + container_group_name="qmq3nj6oy8b2wpzbidnelidy9s6k9w", container_group_instance_id="container_group_instance_id" ) diff --git a/documentation/services/InferenceEndpointsService.md b/documentation/services/InferenceEndpointsService.md index 4596910..4279810 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 | | :-------------------------------------------------------------- | :--------------------------------------------- | -| [list_inference_endpoints](#list_inference_endpoints) | Gets the list of all inference endpoints | +| [list_inference_endpoints](#list_inference_endpoints) | Gets the list of inference endpoints | | [get_inference_endpoint](#get_inference_endpoint) | Gets an inference endpoint | | [get_inference_endpoint_jobs](#get_inference_endpoint_jobs) | Retrieves a list of an inference endpoint jobs | | [create_inference_endpoint_job](#create_inference_endpoint_job) | Creates a new job | @@ -13,18 +13,18 @@ A list of all methods in the `InferenceEndpointsService` service. Click on the m ## list_inference_endpoints -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 | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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 | int | ❌ | The page number | -| page_size | int | ❌ | The number of items per page | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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 | `int` | ❌ | The page number | +| page_size | `int` | ❌ | The number of items per page | **Return Type** @@ -43,9 +43,9 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.list_inference_endpoints( - organization_name="st2-urph37evrys1geyqe9zqcl509sj17pmml--8w-efwac", - page=1281776861, - page_size=39 + organization_name="wg1umdxtc9fte8osib-e-5ux2vsmrhjjt13u7q3pryxxnm", + page=756148233, + page_size=66 ) print(result) @@ -60,10 +60,10 @@ Gets an inference endpoint **Parameters** -| Name | Type | Required | Description | -| :---------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| inference_endpoint_name | str | ✅ | The unique inference endpoint name | +| Name | Type | Required | Description | +| :---------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| inference_endpoint_name | `str` | ✅ | The unique inference endpoint name | **Return Type** @@ -82,8 +82,8 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.get_inference_endpoint( - organization_name="r3ca1qhgg3f8sedhivpq69pz1fv6p6td3lk58q-xi9e71", - inference_endpoint_name="ex" + organization_name="uzp1dyfm2yp4-lxa27tl0fwms3fu3myo74a99jr6ouv4w8", + inference_endpoint_name="aute Ut reprehenderit occaecat sed" ) print(result) @@ -98,12 +98,12 @@ Retrieves a list of an inference endpoint jobs **Parameters** -| Name | Type | Required | Description | -| :---------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| inference_endpoint_name | str | ✅ | The unique inference endpoint name | -| page | int | ❌ | The page number | -| page_size | int | ❌ | The number of items per page | +| Name | Type | Required | Description | +| :---------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| inference_endpoint_name | `str` | ✅ | The unique inference endpoint name | +| page | `int` | ❌ | The page number | +| page_size | `int` | ❌ | The number of items per page | **Return Type** @@ -122,10 +122,10 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.get_inference_endpoint_jobs( - organization_name="o5xa3fo8vph2o1f-37ajjw041g16mvzbwxaa3c0u0co", - inference_endpoint_name="nulla do", - page=1108363256, - page_size=2 + organization_name="trzfoq1p77wk9jgwxjp56dzbnwtbgowklqt1wsbe00", + inference_endpoint_name="ut officia ut", + page=1653138765, + page_size=76 ) print(result) @@ -140,11 +140,11 @@ Creates a new job **Parameters** -| Name | Type | Required | Description | -| :---------------------- | :-------------------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| request_body | [CreateInferenceEndpointJob](../models/CreateInferenceEndpointJob.md) | ✅ | The request body. | -| organization_name | str | ✅ | 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. | -| inference_endpoint_name | str | ✅ | The unique inference endpoint name | +| Name | Type | Required | Description | +| :---------------------- | :---------------------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| request_body | `[CreateInferenceEndpointJob](../models/CreateInferenceEndpointJob.md)` | ✅ | The request body. | +| organization_name | `str` | ✅ | 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. | +| inference_endpoint_name | `str` | ✅ | The unique inference endpoint name | **Return Type** @@ -171,8 +171,8 @@ request_body = CreateInferenceEndpointJob( result = sdk.inference_endpoints.create_inference_endpoint_job( request_body=request_body, - organization_name="o5xa3fo8vph2o1f-37ajjw041g16mvzbwxaa3c0u0co", - inference_endpoint_name="nulla do" + organization_name="trzfoq1p77wk9jgwxjp56dzbnwtbgowklqt1wsbe00", + inference_endpoint_name="ut officia ut" ) print(result) @@ -187,11 +187,11 @@ Retrieves a job in an inference endpoint **Parameters** -| Name | Type | Required | Description | -| :------------------------ | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| inference_endpoint_name | str | ✅ | The unique inference endpoint name | -| inference_endpoint_job_id | str | ✅ | The unique job id | +| Name | Type | Required | Description | +| :------------------------ | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| inference_endpoint_name | `str` | ✅ | The unique inference endpoint name | +| inference_endpoint_job_id | `str` | ✅ | The unique job id | **Return Type** @@ -210,8 +210,8 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.get_inference_endpoint_job( - organization_name="s04w2crlogjmfdcc56apm9zbbx488p3ma8ymve3kv7u5j1tuskgp-t61s33ubq", - inference_endpoint_name="sint ea", + organization_name="b7tj9", + inference_endpoint_name="sed eu labore", inference_endpoint_job_id="inference_endpoint_job_id" ) @@ -227,11 +227,11 @@ Deletes an inference endpoint job **Parameters** -| Name | Type | Required | Description | -| :------------------------ | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| inference_endpoint_name | str | ✅ | The unique inference endpoint name | -| inference_endpoint_job_id | str | ✅ | The unique job id | +| Name | Type | Required | Description | +| :------------------------ | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| inference_endpoint_name | `str` | ✅ | The unique inference endpoint name | +| inference_endpoint_job_id | `str` | ✅ | The unique job id | **Example Usage Code Snippet** @@ -246,8 +246,8 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.delete_inference_endpoint_job( - organization_name="s04w2crlogjmfdcc56apm9zbbx488p3ma8ymve3kv7u5j1tuskgp-t61s33ubq", - inference_endpoint_name="sint ea", + organization_name="b7tj9", + inference_endpoint_name="sed eu labore", inference_endpoint_job_id="inference_endpoint_job_id" ) diff --git a/documentation/services/OrganizationDataService.md b/documentation/services/OrganizationDataService.md index 4a2cc86..530269f 100644 --- a/documentation/services/OrganizationDataService.md +++ b/documentation/services/OrganizationDataService.md @@ -15,9 +15,9 @@ List the GPU Classes **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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 | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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** @@ -35,7 +35,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.organization_data.list_gpu_classes(organization_name="wxgeliermrcdrg557eislsg5l8m8kmas3z0-6ns") +result = sdk.organization_data.list_gpu_classes(organization_name="ksb7ikadj659qttkrqdm5b9xdre4met9iop") print(result) ``` diff --git a/documentation/services/QueuesService.md b/documentation/services/QueuesService.md index c6cf29f..4398685 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 | [get_queue](#get_queue) | Gets an existing queue in the given project. | | [update_queue](#update_queue) | Updates an existing queue in the given project. | | [delete_queue](#delete_queue) | Deletes an existing queue in the given project. | -| [list_queue_jobs](#list_queue_jobs) | Retrieves a list of queue jobs | +| [list_queue_jobs](#list_queue_jobs) | Gets the list of jobs in a queue | | [create_queue_job](#create_queue_job) | Creates a new job | -| [get_queue_job](#get_queue_job) | Retrieves a job in a queue | -| [delete_queue_job](#delete_queue_job) | Deletes a queue job | +| [get_queue_job](#get_queue_job) | Gets a job in a queue | +| [delete_queue_job](#delete_queue_job) | Cancels a job in a queue | ## list_queues @@ -23,10 +23,10 @@ Gets the list of queues in the given project. **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -45,8 +45,8 @@ sdk = SaladCloudSdk( ) result = sdk.queues.list_queues( - organization_name="gcmqvx5-larlezt8ks00ar9f8kfq524njjzfmn5dis4gk", - project_name="x9ql9z" + organization_name="rtxaydgbmb5wprcvb9628akhug9lnd3c0", + project_name="p4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsz6xilo12xl52y9c177" ) print(result) @@ -61,11 +61,11 @@ Creates a new queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :---------------- | :-------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| request_body | [CreateQueue](../models/CreateQueue.md) | ✅ | The request body. | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| Name | Type | Required | Description | +| :---------------- | :---------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| request_body | `[CreateQueue](../models/CreateQueue.md)` | ✅ | The request body. | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | **Return Type** @@ -85,15 +85,15 @@ sdk = SaladCloudSdk( ) request_body = CreateQueue( - name="mh7g70vophyeafe4lxl6gmt4hizzzamvy3j90uelmwdmv", - display_name="gEiIPCAh", - description="dolor aliquip" + name="wcaz2jbu5pfmpygxffsf4bh4e6", + display_name="Ef", + description="aute Ut nostrud veniam sint" ) result = sdk.queues.create_queue( request_body=request_body, - organization_name="gcmqvx5-larlezt8ks00ar9f8kfq524njjzfmn5dis4gk", - project_name="x9ql9z" + organization_name="rtxaydgbmb5wprcvb9628akhug9lnd3c0", + project_name="p4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsz6xilo12xl52y9c177" ) print(result) @@ -108,11 +108,11 @@ Gets an existing queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | **Return Type** @@ -131,9 +131,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.get_queue( - organization_name="s6o2b", - project_name="z-hsy9-rgx52jml2un9bjy3nn4rykiwe0vex", - queue_name="q77lymon4qqm4j2k111l74jgrz9lbr76iko0hba99bukkai1ci9jgia3pwf8f-v" + organization_name="g1bq27ohe5dpzbgsk8gvpuhecson4k2eclxss3", + project_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", + queue_name="bnkfiyt3k5ke3wy-5gl1809r" ) print(result) @@ -148,12 +148,12 @@ Updates an existing queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :---------------- | :-------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| request_body | [UpdateQueue](../models/UpdateQueue.md) | ✅ | The request body. | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | +| Name | Type | Required | Description | +| :---------------- | :---------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| request_body | `[UpdateQueue](../models/UpdateQueue.md)` | ✅ | The request body. | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | **Return Type** @@ -173,15 +173,15 @@ sdk = SaladCloudSdk( ) request_body = UpdateQueue( - display_name="MoX4JPAm1M.", - description="in ea minim labore" + display_name="TLURNvvFGXm", + description="aliqua et sit anim esse" ) result = sdk.queues.update_queue( request_body=request_body, - organization_name="s6o2b", - project_name="z-hsy9-rgx52jml2un9bjy3nn4rykiwe0vex", - queue_name="q77lymon4qqm4j2k111l74jgrz9lbr76iko0hba99bukkai1ci9jgia3pwf8f-v" + organization_name="g1bq27ohe5dpzbgsk8gvpuhecson4k2eclxss3", + project_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", + queue_name="bnkfiyt3k5ke3wy-5gl1809r" ) print(result) @@ -196,11 +196,11 @@ Deletes an existing queue in the given project. **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | **Example Usage Code Snippet** @@ -215,9 +215,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.delete_queue( - organization_name="s6o2b", - project_name="z-hsy9-rgx52jml2un9bjy3nn4rykiwe0vex", - queue_name="q77lymon4qqm4j2k111l74jgrz9lbr76iko0hba99bukkai1ci9jgia3pwf8f-v" + organization_name="g1bq27ohe5dpzbgsk8gvpuhecson4k2eclxss3", + project_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", + queue_name="bnkfiyt3k5ke3wy-5gl1809r" ) print(result) @@ -225,20 +225,20 @@ print(result) ## list_queue_jobs -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 | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | -| page | int | ❌ | The page number | -| page_size | int | ❌ | The number of items per page | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | +| page | `int` | ❌ | The page number | +| page_size | `int` | ❌ | The number of items per page | **Return Type** @@ -257,11 +257,11 @@ sdk = SaladCloudSdk( ) result = sdk.queues.list_queue_jobs( - organization_name="s3artniqzrtb3xp", - project_name="ghu49za-gk-63eofvgj1t0umc64usbu", - queue_name="tz9a-29ellqfizdwuu79xr4e598", - page=1660039363, - page_size=20 + organization_name="jb7eyumc25lm4prwopvwr-1961g-m85nbqda3ufs", + project_name="sn780t45z2tw4xt1b86w0clx6vkq-3", + queue_name="sx811v32aty9s-ghx1hm2nw1mhgooidhvnhwadaqzuh19krhv62or5c", + page=2110014563, + page_size=23 ) print(result) @@ -276,12 +276,12 @@ Creates a new job **Parameters** -| Name | Type | Required | Description | -| :---------------- | :-------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| request_body | [CreateQueueJob](../models/CreateQueueJob.md) | ✅ | The request body. | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | +| Name | Type | Required | Description | +| :---------------- | :---------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| request_body | `[CreateQueueJob](../models/CreateQueueJob.md)` | ✅ | The request body. | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | **Return Type** @@ -308,9 +308,9 @@ request_body = CreateQueueJob( result = sdk.queues.create_queue_job( request_body=request_body, - organization_name="s3artniqzrtb3xp", - project_name="ghu49za-gk-63eofvgj1t0umc64usbu", - queue_name="tz9a-29ellqfizdwuu79xr4e598" + organization_name="jb7eyumc25lm4prwopvwr-1961g-m85nbqda3ufs", + project_name="sn780t45z2tw4xt1b86w0clx6vkq-3", + queue_name="sx811v32aty9s-ghx1hm2nw1mhgooidhvnhwadaqzuh19krhv62or5c" ) print(result) @@ -318,19 +318,19 @@ print(result) ## get_queue_job -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 | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | -| queue_job_id | str | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | +| queue_job_id | `str` | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | **Return Type** @@ -349,9 +349,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.get_queue_job( - organization_name="q5amdp8n95tm7sbm4-h-l-za21p3dtwrf8h51jcaivs9xc", - project_name="nhu27mdjh418v3ixyidy7jsx-nnjlyt7-bhj1c1wox", - queue_name="tszyoxkrcz6v9wz35jltvo0g-6z9z", + organization_name="j-8sae7t0u7o0emyztq64o8ut710qtepjztx34mk6lruecseiyq06ab3ok5xr", + project_name="eokxas9m7y892q4m5rifzmevenpg1vot8xgbal184sloim-c7555huym18dia9d", + queue_name="zbvvpn2qgtohp", queue_job_id="queue_job_id" ) @@ -360,19 +360,19 @@ print(result) ## delete_queue_job -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 | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| queue_name | str | ✅ | The queue name. | -| queue_job_id | str | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | +| Name | Type | Required | Description | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| queue_name | `str` | ✅ | The queue name. | +| queue_job_id | `str` | ✅ | The job identifier. This is automatically generated and assigned when the job is created. | **Example Usage Code Snippet** @@ -387,9 +387,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.delete_queue_job( - organization_name="q5amdp8n95tm7sbm4-h-l-za21p3dtwrf8h51jcaivs9xc", - project_name="nhu27mdjh418v3ixyidy7jsx-nnjlyt7-bhj1c1wox", - queue_name="tszyoxkrcz6v9wz35jltvo0g-6z9z", + organization_name="j-8sae7t0u7o0emyztq64o8ut710qtepjztx34mk6lruecseiyq06ab3ok5xr", + project_name="eokxas9m7y892q4m5rifzmevenpg1vot8xgbal184sloim-c7555huym18dia9d", + queue_name="zbvvpn2qgtohp", queue_job_id="queue_job_id" ) diff --git a/documentation/services/QuotasService.md b/documentation/services/QuotasService.md index 6f142bd..b449c90 100644 --- a/documentation/services/QuotasService.md +++ b/documentation/services/QuotasService.md @@ -15,9 +15,9 @@ Gets the organization quotas **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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 | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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** @@ -35,7 +35,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.quotas.get_quotas(organization_name="fl1mcxorfzr4rx2m8p8o1avm0cpka2159") +result = sdk.quotas.get_quotas(organization_name="o110sou") print(result) ``` diff --git a/documentation/services/WebhookSecretKeyService.md b/documentation/services/WebhookSecretKeyService.md index 2ea02a7..7033856 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 | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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 | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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** @@ -36,7 +36,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.webhook_secret_key.get_webhook_secret_key(organization_name="cqgy62") +result = sdk.webhook_secret_key.get_webhook_secret_key(organization_name="dyxdaqq1t3iwwpawdlk-78rt9bh26smkuf3v0nd2ropp") print(result) ``` @@ -50,9 +50,9 @@ Updates the webhook secret key **Parameters** -| Name | Type | Required | Description | -| :---------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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 | +| :---------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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** @@ -70,7 +70,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.webhook_secret_key.update_webhook_secret_key(organization_name="cqgy62") +result = sdk.webhook_secret_key.update_webhook_secret_key(organization_name="dyxdaqq1t3iwwpawdlk-78rt9bh26smkuf3v0nd2ropp") print(result) ``` diff --git a/documentation/services/WorkloadErrorsService.md b/documentation/services/WorkloadErrorsService.md index b6763ba..d0f19fe 100644 --- a/documentation/services/WorkloadErrorsService.md +++ b/documentation/services/WorkloadErrorsService.md @@ -15,11 +15,11 @@ Gets the workload errors **Parameters** -| Name | Type | Required | Description | -| :------------------- | :--- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| organization_name | str | ✅ | 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. | -| project_name | str | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | -| container_group_name | str | ✅ | The unique container group name | +| Name | Type | Required | Description | +| :------------------- | :---- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| organization_name | `str` | ✅ | 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. | +| project_name | `str` | ✅ | Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. | +| container_group_name | `str` | ✅ | The unique container group name | **Return Type** @@ -38,9 +38,9 @@ sdk = SaladCloudSdk( ) result = sdk.workload_errors.get_workload_errors( - organization_name="e1hyb0xog4htqwzv2xifmedj8m3aft", - project_name="ita8o56f6-ln3mgpj5ybc3o2jr6guahpm6a-9zm", - container_group_name="in0mmtzaxq1g5d8jy220ol2mol23pv6c6zej" + organization_name="u9szw31h4fee237cnffybnugpd7nbngs47jne2vq5j0d2m4f20", + project_name="c5ozb1-4j-you0d7uftlpfgcaqa-2oc58y844m0ne", + container_group_name="khlkkgda39h5upyur493wxwbxrj4x" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-gpu-classes-get.md b/documentation/snippets/organizations-{organization_name}-gpu-classes-get.md index 80f148c..a6efc3d 100644 --- a/documentation/snippets/organizations-{organization_name}-gpu-classes-get.md +++ b/documentation/snippets/organizations-{organization_name}-gpu-classes-get.md @@ -8,7 +8,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.organization_data.list_gpu_classes(organization_name="wxgeliermrcdrg557eislsg5l8m8kmas3z0-6ns") +result = sdk.organization_data.list_gpu_classes(organization_name="ksb7ikadj659qttkrqdm5b9xdre4met9iop") print(result) diff --git a/documentation/snippets/organizations-{organization_name}-inference-endpoints-get.md b/documentation/snippets/organizations-{organization_name}-inference-endpoints-get.md index 599b890..bd35876 100644 --- a/documentation/snippets/organizations-{organization_name}-inference-endpoints-get.md +++ b/documentation/snippets/organizations-{organization_name}-inference-endpoints-get.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.list_inference_endpoints( - organization_name="st2-urph37evrys1geyqe9zqcl509sj17pmml--8w-efwac", - page=1281776861, - page_size=39 + organization_name="wg1umdxtc9fte8osib-e-5ux2vsmrhjjt13u7q3pryxxnm", + page=756148233, + page_size=66 ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-get.md b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-get.md index 2b08f1c..a473604 100644 --- a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-get.md +++ b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-get.md @@ -9,8 +9,8 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.get_inference_endpoint( - organization_name="r3ca1qhgg3f8sedhivpq69pz1fv6p6td3lk58q-xi9e71", - inference_endpoint_name="ex" + organization_name="uzp1dyfm2yp4-lxa27tl0fwms3fu3myo74a99jr6ouv4w8", + inference_endpoint_name="aute Ut reprehenderit occaecat sed" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-get.md b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-get.md index dedacb8..7316b31 100644 --- a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-get.md +++ b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-get.md @@ -9,10 +9,10 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.get_inference_endpoint_jobs( - organization_name="o5xa3fo8vph2o1f-37ajjw041g16mvzbwxaa3c0u0co", - inference_endpoint_name="nulla do", - page=1108363256, - page_size=2 + organization_name="trzfoq1p77wk9jgwxjp56dzbnwtbgowklqt1wsbe00", + inference_endpoint_name="ut officia ut", + page=1653138765, + page_size=76 ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-post.md b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-post.md index 38a9700..f083302 100644 --- a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-post.md +++ b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-post.md @@ -17,8 +17,8 @@ request_body = CreateInferenceEndpointJob( result = sdk.inference_endpoints.create_inference_endpoint_job( request_body=request_body, - organization_name="o5xa3fo8vph2o1f-37ajjw041g16mvzbwxaa3c0u0co", - inference_endpoint_name="nulla do" + organization_name="trzfoq1p77wk9jgwxjp56dzbnwtbgowklqt1wsbe00", + inference_endpoint_name="ut officia ut" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-delete.md b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-delete.md index 858ccb6..b08eaa7 100644 --- a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-delete.md +++ b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-delete.md @@ -9,8 +9,8 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.delete_inference_endpoint_job( - organization_name="s04w2crlogjmfdcc56apm9zbbx488p3ma8ymve3kv7u5j1tuskgp-t61s33ubq", - inference_endpoint_name="sint ea", + organization_name="b7tj9", + inference_endpoint_name="sed eu labore", inference_endpoint_job_id="inference_endpoint_job_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-get.md b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-get.md index 01b8b82..d4fde1d 100644 --- a/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-get.md +++ b/documentation/snippets/organizations-{organization_name}-inference-endpoints-{inference_endpoint_name}-jobs-{inference_endpoint_job_id}-get.md @@ -9,8 +9,8 @@ sdk = SaladCloudSdk( ) result = sdk.inference_endpoints.get_inference_endpoint_job( - organization_name="s04w2crlogjmfdcc56apm9zbbx488p3ma8ymve3kv7u5j1tuskgp-t61s33ubq", - inference_endpoint_name="sint ea", + organization_name="b7tj9", + inference_endpoint_name="sed eu labore", inference_endpoint_job_id="inference_endpoint_job_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md index 5f441e9..9253a88 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-get.md @@ -9,8 +9,8 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.list_container_groups( - organization_name="nhyrq", - project_name="r92pbz5hsuado6z0y3kws22ptp7cp7eaw33zizk" + organization_name="v50imwzgi4em4q035", + project_name="m6yw3-xm60cb7tiev8rketqiiwjepibzf2ust1cvjx8oua8mepeueo5-1" ) print(result) 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 f9bec0f..e0026f4 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 @@ -10,17 +10,17 @@ sdk = SaladCloudSdk( ) request_body = CreateContainerGroup( - name="yywq967xo8ifvlka8kdg6t3d8cqm9k9rc7a8bvhvcpg50j51gan4fglcmonhm", - display_name="0hxi6,PR", + name="qfojt-6ccoil4t55-ccoyybgw92dermtsdfn3t2xmag", + display_name="O0hSlJUW", container={ - "image": "nostrud aute adipisicing", + "image": "voluptate officia adipisicing", "resources": { "cpu": 10, - "memory": 7505, + "memory": 17858, "gpu_classes": [ "gpu_classes" ], - "storage_amount": 3605508236 + "storage_amount": 32391110488 }, "command": [ "command" @@ -29,13 +29,13 @@ request_body = CreateContainerGroup( "environment_variables": {}, "logging": { "axiom": { - "host": "sed", - "api_token": "nisi elit est", - "dataset": "Excepteur" + "host": "Ut con", + "api_token": "nostrud irure dolore", + "dataset": "mollit irure et Duis dolore" }, "datadog": { - "host": "Lorem magna qui Duis", - "api_key": "minim aliquip qui", + "host": "pariatur", + "api_key": "non ut", "tags": [ { "name": "name", @@ -44,20 +44,20 @@ request_body = CreateContainerGroup( ] }, "new_relic": { - "host": "adipisicing", - "ingestion_key": "culpa enim" + "host": "cupidatat cillum est sit minim", + "ingestion_key": "dolore laboris fugiat Duis" }, "splunk": { - "host": "ut", - "token": "aliquip dolore" + "host": "aliquip velit culpa", + "token": "ex" }, "tcp": { - "host": "irure reprehenderit ut", - "port": 26986 + "host": "aliqua", + "port": 17249 }, "http": { - "host": "cupidatat irure reprehenderit amet", - "port": 9553, + "host": "magna", + "port": 62049, "user": "user", "password": "password", "path": "path", @@ -92,24 +92,24 @@ request_body = CreateContainerGroup( } } }, - autostart_policy=True, + autostart_policy=False, restart_policy="always", - replicas=122, + replicas=114, country_codes=[ "af" ], networking={ "protocol": "http", - "port": 53954, + "port": 9813, "auth": False }, liveness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -120,14 +120,14 @@ request_body = CreateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 1, + "initial_delay_seconds": 5, "period_seconds": 10, "timeout_seconds": 30, "success_threshold": 1, @@ -135,11 +135,11 @@ request_body = CreateContainerGroup( }, readiness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -150,14 +150,14 @@ request_body = CreateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 10, + "initial_delay_seconds": 6, "period_seconds": 1, "timeout_seconds": 1, "success_threshold": 1, @@ -165,11 +165,11 @@ request_body = CreateContainerGroup( }, startup_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -180,30 +180,38 @@ request_body = CreateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 6, + "initial_delay_seconds": 4, "period_seconds": 3, "timeout_seconds": 10, "success_threshold": 2, "failure_threshold": 1200 }, queue_connection={ - "path": "qui cupidatat esse labore", - "port": 36246, - "queue_name": "tv1-ax-msj6w-h3wkst4x03b6y4ltw1qvh-38ot" + "path": "ullamco magna est nulla aliqua", + "port": 49952, + "queue_name": "nnz26lyemw7nednorlqjlsihb42092pn8d" + }, + queue_autoscaler={ + "min_replicas": 57, + "max_replicas": 24, + "desired_queue_length": 20, + "polling_period": 1406, + "max_upscale_per_minute": 35, + "max_downscale_per_minute": 42 } ) result = sdk.container_groups.create_container_group( request_body=request_body, - organization_name="nhyrq", - project_name="r92pbz5hsuado6z0y3kws22ptp7cp7eaw33zizk" + organization_name="v50imwzgi4em4q035", + project_name="m6yw3-xm60cb7tiev8rketqiiwjepibzf2ust1cvjx8oua8mepeueo5-1" ) print(result) 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 e5a72f8..d6b80c0 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 @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.delete_container_group( - organization_name="hjn8ph-8qr9s", - project_name="zpcs1c-85eq2giu1ly3ke1lk2gb3mqhp", - container_group_name="obcxrd0mqez" + organization_name="gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw", + project_name="xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz", + container_group_name="ojjj5b9hbe2fr6f5t7j1htjaws1zx3r" ) print(result) 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 65c204b..2e42f03 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 @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.workload_errors.get_workload_errors( - organization_name="e1hyb0xog4htqwzv2xifmedj8m3aft", - project_name="ita8o56f6-ln3mgpj5ybc3o2jr6guahpm6a-9zm", - container_group_name="in0mmtzaxq1g5d8jy220ol2mol23pv6c6zej" + organization_name="u9szw31h4fee237cnffybnugpd7nbngs47jne2vq5j0d2m4f20", + project_name="c5ozb1-4j-you0d7uftlpfgcaqa-2oc58y844m0ne", + container_group_name="khlkkgda39h5upyur493wxwbxrj4x" ) print(result) 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 1883a45..8400f38 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 @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.get_container_group( - organization_name="hjn8ph-8qr9s", - project_name="zpcs1c-85eq2giu1ly3ke1lk2gb3mqhp", - container_group_name="obcxrd0mqez" + organization_name="gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw", + project_name="xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz", + container_group_name="ojjj5b9hbe2fr6f5t7j1htjaws1zx3r" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-get.md index 6153a6a..6298828 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-get.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.list_container_group_instances( - organization_name="r2ewwqmqzjxx4rgbkz9z0o", - project_name="wsjwmyricvgcl-a", - container_group_name="lfjbdzaim314b-agf7f3di5" + organization_name="dcbh1", + project_name="pdcapp3enb9gd2f4k49vviu53s67ckwwnxsd-gfjsmuxcljdg4t1zzyoj", + container_group_name="vl2kuh4c67m3ae7qwlwipkdye-ad" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-get.md index 2550a7d..0ba2386 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-get.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.get_container_group_instance( - organization_name="r73buakrgl6y3rjdvhzythcjdr395d9kcqp4cb924r41g8h69zigf6pcd56q", - project_name="ij2glutxyxjzu-kbkyf64swspzpifkfz1iqxdqeh723l4g1l4if4prvjrh", - container_group_name="dy89w4q4lafvnap7fs4nkqpn7ls1z4okwf0mrkx5ngmb8o-bh3029krp8r4nbzi", + organization_name="b0up7kyr7vabeivb96iwcvlvvm1n", + project_name="ngljb", + container_group_name="xtp82b9jzwqov1insghigvfq0donadhrrdqx-2redu46g7e", container_group_instance_id="container_group_instance_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-reallocate-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-reallocate-post.md index 341ae7f..2b19791 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-reallocate-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-reallocate-post.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.reallocate_container_group_instance( - organization_name="v3y98q43p0yluu6goai4jrn6fimmbqq9dx0ysgegc9lbt3rb5ve2dfxn47rzqt", - project_name="dsz8ru-a-8c24v6nkirwkf0y7", - container_group_name="rvvhdab0-otceyo1pjg79tnitjvskxomth5lg4v240t9", + organization_name="xk27gbnpmwk5xor49bk4ujk7", + project_name="cy1l6xj-5vzihwp4ho850l3faynnuq71ru6y", + container_group_name="mgza-e8llajq25o36x8b-38phh", container_group_instance_id="container_group_instance_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-recreate-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-recreate-post.md index 9fd1a11..c2b1bce 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-recreate-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-recreate-post.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.recreate_container_group_instance( - organization_name="s6kh32qycsfx2nq31jsr4cu78utkmdfyxq2dutq30f1kgben6cwy2216zw", - project_name="ve8h7ruif57rm1z2f7e741vj2k8eq7ndtsvg8rk9cps8opkv30dop2y", - container_group_name="n53hzo0tabn9gntx3gxr0jo4pi3ty2akde1ugp2xc", + organization_name="pkfh3rhnvt4x30k5t", + project_name="o7r3q30xz", + container_group_name="aq7hd1fjfxgtq8uehil3eplo", container_group_instance_id="container_group_instance_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-restart-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-restart-post.md index cbea2aa..5217129 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-restart-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-instances-{container_group_instance_id}-restart-post.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.restart_container_group_instance( - organization_name="ml61xwkce80bgd0", - project_name="kuexscfukz0bups982", - container_group_name="r8gqlu7c", + organization_name="kd79h7bg0vpngqc8hz5pxjwi7muqnmuuqsx3q3zm2hxkci5yv6kho", + project_name="u5ljgqmbs6a7s", + container_group_name="qmq3nj6oy8b2wpzbidnelidy9s6k9w", container_group_instance_id="container_group_instance_id" ) 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 f5c69a9..75feef2 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 @@ -10,16 +10,16 @@ sdk = SaladCloudSdk( ) request_body = UpdateContainerGroup( - display_name="GzGG5v3-Z", + display_name="-xzxtaW.t2I", container={ - "image": "labore mollit tempor elit", + "image": "ex cillum dolor", "resources": { - "cpu": 3, - "memory": 2085, + "cpu": 11, + "memory": 21424, "gpu_classes": [ "gpu_classes" ], - "storage_amount": 27222255995 + "storage_amount": 12333132242 }, "command": [ "command" @@ -28,13 +28,13 @@ request_body = UpdateContainerGroup( "environment_variables": {}, "logging": { "axiom": { - "host": "et in ipsum", - "api_token": "in sit in velit mollit", - "dataset": "in" + "host": "commodo ea exercitation pariatur consequat", + "api_token": "ipsum", + "dataset": "id Excepteur" }, "datadog": { - "host": "incididunt irure", - "api_key": "ea ullamco", + "host": "exercitation aliquip", + "api_key": "veniam", "tags": [ { "name": "name", @@ -43,20 +43,20 @@ request_body = UpdateContainerGroup( ] }, "new_relic": { - "host": "labore irure enim consequat", - "ingestion_key": "aliquip consequat" + "host": "amet velit sed cillum", + "ingestion_key": "et" }, "splunk": { - "host": "ea fugiat", - "token": "nulla pariatur" + "host": "proident", + "token": "est" }, "tcp": { - "host": "reprehenderit magna Ut veniam do", - "port": 37055 + "host": "ut velit ea cillum", + "port": 13557 }, "http": { - "host": "nisi laborum pariatur", - "port": 15435, + "host": "nisi fugiat cupidatat", + "port": 60288, "user": "user", "password": "password", "path": "path", @@ -91,20 +91,20 @@ request_body = UpdateContainerGroup( } } }, - replicas=242, + replicas=110, country_codes=[ "af" ], networking={ - "port": 16926 + "port": 64823 }, liveness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -115,14 +115,14 @@ request_body = UpdateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 1, + "initial_delay_seconds": 5, "period_seconds": 10, "timeout_seconds": 30, "success_threshold": 1, @@ -130,11 +130,11 @@ request_body = UpdateContainerGroup( }, readiness_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -145,14 +145,14 @@ request_body = UpdateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 10, + "initial_delay_seconds": 6, "period_seconds": 1, "timeout_seconds": 1, "success_threshold": 1, @@ -160,11 +160,11 @@ request_body = UpdateContainerGroup( }, startup_probe={ "tcp": { - "port": 33909 + "port": 23269 }, "http": { "path": "path", - "port": 58747, + "port": 61900, "scheme": "http", "headers": [ { @@ -175,14 +175,14 @@ request_body = UpdateContainerGroup( }, "grpc": { "service": "service", - "port": 54101 + "port": 58759 }, "exec_": { "command": [ "command" ] }, - "initial_delay_seconds": 6, + "initial_delay_seconds": 4, "period_seconds": 3, "timeout_seconds": 10, "success_threshold": 2, @@ -192,9 +192,9 @@ request_body = UpdateContainerGroup( result = sdk.container_groups.update_container_group( request_body=request_body, - organization_name="hjn8ph-8qr9s", - project_name="zpcs1c-85eq2giu1ly3ke1lk2gb3mqhp", - container_group_name="obcxrd0mqez" + organization_name="gq7z7dvdopv2czgde1zrufxgiv5tp-kncd4gfzda9ik-lw", + project_name="xd-if9b1yvozs9trd4v0bll7qwslfehyhnfadnjp2w52gwrmz", + container_group_name="ojjj5b9hbe2fr6f5t7j1htjaws1zx3r" ) print(result) 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 9b791f4..7c43689 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 @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.start_container_group( - organization_name="x1dy6hcwr9a5xaxeifh6e02xtma0zqz8asfuvjihhlkjxajbi3pwr9bnx", - project_name="y7lm", - container_group_name="l3q-oa3p3" + organization_name="zfx07sgyz1fs97sfhtue78-54vdogp2qrcnt-8a", + project_name="v7jhy3jn2rdf012fi7ouno3mk9", + container_group_name="a4d0ajj5ajjquzeg-z3kvqxtnoxnlzhjhjt-8naw" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-stop-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-stop-post.md index 2901061..f9467a8 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-stop-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-containers-{container_group_name}-stop-post.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.container_groups.stop_container_group( - organization_name="qg6vce6y8gr9gth6qwq", - project_name="hgk2", - container_group_name="xxf9hw2fg7q6om9s6wkwjqmbzvl-xnxr-q14lm43yp" + organization_name="c0o0gqev-mnkpy8af-s7rq68p2lenu8izbg09xnu6-fkv4dta4yd", + project_name="rpi16e4ddle58fi8u9w2qgnsgj7cnci4p90a72aagy0f001ws1rwna83a3asuz", + container_group_name="fd6ugn07m5xpcp89lefemdke05z4s9eg1d2caksvlhpzm" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-get.md index fe89bdb..07e86f4 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-get.md @@ -9,8 +9,8 @@ sdk = SaladCloudSdk( ) result = sdk.queues.list_queues( - organization_name="gcmqvx5-larlezt8ks00ar9f8kfq524njjzfmn5dis4gk", - project_name="x9ql9z" + organization_name="rtxaydgbmb5wprcvb9628akhug9lnd3c0", + project_name="p4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsz6xilo12xl52y9c177" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-post.md index edfe8fc..d633b15 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-post.md @@ -10,15 +10,15 @@ sdk = SaladCloudSdk( ) request_body = CreateQueue( - name="mh7g70vophyeafe4lxl6gmt4hizzzamvy3j90uelmwdmv", - display_name="gEiIPCAh", - description="dolor aliquip" + name="wcaz2jbu5pfmpygxffsf4bh4e6", + display_name="Ef", + description="aute Ut nostrud veniam sint" ) result = sdk.queues.create_queue( request_body=request_body, - organization_name="gcmqvx5-larlezt8ks00ar9f8kfq524njjzfmn5dis4gk", - project_name="x9ql9z" + organization_name="rtxaydgbmb5wprcvb9628akhug9lnd3c0", + project_name="p4bdb9jsi-f1xex70mdgjf5n-5ua-e28xyu9ujbls0vsz6xilo12xl52y9c177" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-delete.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-delete.md index ee48e2a..5427123 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-delete.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-delete.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.delete_queue( - organization_name="s6o2b", - project_name="z-hsy9-rgx52jml2un9bjy3nn4rykiwe0vex", - queue_name="q77lymon4qqm4j2k111l74jgrz9lbr76iko0hba99bukkai1ci9jgia3pwf8f-v" + organization_name="g1bq27ohe5dpzbgsk8gvpuhecson4k2eclxss3", + project_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", + queue_name="bnkfiyt3k5ke3wy-5gl1809r" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-get.md index 6310816..d3d0807 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-get.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.get_queue( - organization_name="s6o2b", - project_name="z-hsy9-rgx52jml2un9bjy3nn4rykiwe0vex", - queue_name="q77lymon4qqm4j2k111l74jgrz9lbr76iko0hba99bukkai1ci9jgia3pwf8f-v" + organization_name="g1bq27ohe5dpzbgsk8gvpuhecson4k2eclxss3", + project_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", + queue_name="bnkfiyt3k5ke3wy-5gl1809r" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-get.md index 2a5f175..1b58db9 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-get.md @@ -9,11 +9,11 @@ sdk = SaladCloudSdk( ) result = sdk.queues.list_queue_jobs( - organization_name="s3artniqzrtb3xp", - project_name="ghu49za-gk-63eofvgj1t0umc64usbu", - queue_name="tz9a-29ellqfizdwuu79xr4e598", - page=1660039363, - page_size=20 + organization_name="jb7eyumc25lm4prwopvwr-1961g-m85nbqda3ufs", + project_name="sn780t45z2tw4xt1b86w0clx6vkq-3", + queue_name="sx811v32aty9s-ghx1hm2nw1mhgooidhvnhwadaqzuh19krhv62or5c", + page=2110014563, + page_size=23 ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-post.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-post.md index e6a6090..bded91e 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-post.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-post.md @@ -17,9 +17,9 @@ request_body = CreateQueueJob( result = sdk.queues.create_queue_job( request_body=request_body, - organization_name="s3artniqzrtb3xp", - project_name="ghu49za-gk-63eofvgj1t0umc64usbu", - queue_name="tz9a-29ellqfizdwuu79xr4e598" + organization_name="jb7eyumc25lm4prwopvwr-1961g-m85nbqda3ufs", + project_name="sn780t45z2tw4xt1b86w0clx6vkq-3", + queue_name="sx811v32aty9s-ghx1hm2nw1mhgooidhvnhwadaqzuh19krhv62or5c" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-delete.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-delete.md index 2f0af6d..07d781f 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-delete.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-delete.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.delete_queue_job( - organization_name="q5amdp8n95tm7sbm4-h-l-za21p3dtwrf8h51jcaivs9xc", - project_name="nhu27mdjh418v3ixyidy7jsx-nnjlyt7-bhj1c1wox", - queue_name="tszyoxkrcz6v9wz35jltvo0g-6z9z", + organization_name="j-8sae7t0u7o0emyztq64o8ut710qtepjztx34mk6lruecseiyq06ab3ok5xr", + project_name="eokxas9m7y892q4m5rifzmevenpg1vot8xgbal184sloim-c7555huym18dia9d", + queue_name="zbvvpn2qgtohp", queue_job_id="queue_job_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-get.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-get.md index 0d47aa0..891b63b 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-get.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-jobs-{queue_job_id}-get.md @@ -9,9 +9,9 @@ sdk = SaladCloudSdk( ) result = sdk.queues.get_queue_job( - organization_name="q5amdp8n95tm7sbm4-h-l-za21p3dtwrf8h51jcaivs9xc", - project_name="nhu27mdjh418v3ixyidy7jsx-nnjlyt7-bhj1c1wox", - queue_name="tszyoxkrcz6v9wz35jltvo0g-6z9z", + organization_name="j-8sae7t0u7o0emyztq64o8ut710qtepjztx34mk6lruecseiyq06ab3ok5xr", + project_name="eokxas9m7y892q4m5rifzmevenpg1vot8xgbal184sloim-c7555huym18dia9d", + queue_name="zbvvpn2qgtohp", queue_job_id="queue_job_id" ) diff --git a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-patch.md b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-patch.md index a43f4da..cc82dc7 100644 --- a/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-patch.md +++ b/documentation/snippets/organizations-{organization_name}-projects-{project_name}-queues-{queue_name}-patch.md @@ -10,15 +10,15 @@ sdk = SaladCloudSdk( ) request_body = UpdateQueue( - display_name="MoX4JPAm1M.", - description="in ea minim labore" + display_name="TLURNvvFGXm", + description="aliqua et sit anim esse" ) result = sdk.queues.update_queue( request_body=request_body, - organization_name="s6o2b", - project_name="z-hsy9-rgx52jml2un9bjy3nn4rykiwe0vex", - queue_name="q77lymon4qqm4j2k111l74jgrz9lbr76iko0hba99bukkai1ci9jgia3pwf8f-v" + organization_name="g1bq27ohe5dpzbgsk8gvpuhecson4k2eclxss3", + project_name="wtxd1j0ixuhfk-hdff3n3-hbtsigyh53bt0g4gjh8mcz4", + queue_name="bnkfiyt3k5ke3wy-5gl1809r" ) print(result) diff --git a/documentation/snippets/organizations-{organization_name}-quotas-get.md b/documentation/snippets/organizations-{organization_name}-quotas-get.md index ed9fb79..92eab95 100644 --- a/documentation/snippets/organizations-{organization_name}-quotas-get.md +++ b/documentation/snippets/organizations-{organization_name}-quotas-get.md @@ -8,7 +8,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.quotas.get_quotas(organization_name="fl1mcxorfzr4rx2m8p8o1avm0cpka2159") +result = sdk.quotas.get_quotas(organization_name="o110sou") print(result) diff --git a/documentation/snippets/organizations-{organization_name}-webhook-secret-key-get.md b/documentation/snippets/organizations-{organization_name}-webhook-secret-key-get.md index e01d6c2..1edb599 100644 --- a/documentation/snippets/organizations-{organization_name}-webhook-secret-key-get.md +++ b/documentation/snippets/organizations-{organization_name}-webhook-secret-key-get.md @@ -8,7 +8,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.webhook_secret_key.get_webhook_secret_key(organization_name="cqgy62") +result = sdk.webhook_secret_key.get_webhook_secret_key(organization_name="dyxdaqq1t3iwwpawdlk-78rt9bh26smkuf3v0nd2ropp") print(result) diff --git a/documentation/snippets/organizations-{organization_name}-webhook-secret-key-post.md b/documentation/snippets/organizations-{organization_name}-webhook-secret-key-post.md index 0025686..47f59a0 100644 --- a/documentation/snippets/organizations-{organization_name}-webhook-secret-key-post.md +++ b/documentation/snippets/organizations-{organization_name}-webhook-secret-key-post.md @@ -8,7 +8,7 @@ sdk = SaladCloudSdk( timeout=10000 ) -result = sdk.webhook_secret_key.update_webhook_secret_key(organization_name="cqgy62") +result = sdk.webhook_secret_key.update_webhook_secret_key(organization_name="dyxdaqq1t3iwwpawdlk-78rt9bh26smkuf3v0nd2ropp") print(result) diff --git a/examples/install.cmd b/examples/install.cmd old mode 100755 new mode 100644 index 302472c..d998041 --- a/examples/install.cmd +++ b/examples/install.cmd @@ -2,4 +2,4 @@ python -m venv .venv call .venv\Scripts\activate pip install build python -m build --outdir dist ..\ -pip install dist\salad_cloud_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist\salad_cloud_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall diff --git a/examples/install.sh b/examples/install.sh old mode 100755 new mode 100644 index 8283aa5..ea4729e --- a/examples/install.sh +++ b/examples/install.sh @@ -2,4 +2,4 @@ python -m venv .venv . .venv/bin/activate pip install build python -m build --outdir dist ../ -pip install dist/salad_cloud_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist/salad_cloud_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall diff --git a/examples/sample.py b/examples/sample.py index a9ce578..3752376 100644 --- a/examples/sample.py +++ b/examples/sample.py @@ -7,6 +7,6 @@ timeout=10000, ) -result = sdk.quotas.get_quotas(organization_name="fl1mcxorfzr4rx2m8p8o1avm0cpka2159") +result = sdk.quotas.get_quotas(organization_name="o110sou") print(result) diff --git a/install.cmd b/install.cmd old mode 100755 new mode 100644 index 76a81f9..21fd456 --- a/install.cmd +++ b/install.cmd @@ -15,7 +15,7 @@ if "%USE_VENV%"=="1" ( pip install build python -m build --outdir dist . -pip install dist\salad_cloud_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist\salad_cloud_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall if "%USE_VENV%"=="1" ( deactivate diff --git a/install.sh b/install.sh old mode 100755 new mode 100644 index d58aa83..a44d895 --- a/install.sh +++ b/install.sh @@ -19,7 +19,7 @@ fi pip install build python -m build --outdir dist . -pip install dist/salad_cloud_sdk-0.9.0-alpha.1-py3-none-any.whl --force-reinstall +pip install dist/salad_cloud_sdk-0.9.0-alpha.2-py3-none-any.whl --force-reinstall if [ "$USE_VENV" -eq 1 ]; then deactivate diff --git a/pyproject.toml b/pyproject.toml index c8c376d..7be753f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta" [project] name = "salad-cloud-sdk" -version = "0.9.0-alpha.1" +version = "0.9.0-alpha.2" license = { text = "MIT" } description = """The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.""" -readme = "README.md" +readme = "PyPI_README.md" requires-python = ">=3.7" classifiers = [ "Development Status :: 3 - Alpha", diff --git a/src/salad_cloud_sdk/models/__init__.py b/src/salad_cloud_sdk/models/__init__.py index 43671ea..f99e4e7 100644 --- a/src/salad_cloud_sdk/models/__init__.py +++ b/src/salad_cloud_sdk/models/__init__.py @@ -29,6 +29,7 @@ from .container_group_readiness_probe import ContainerGroupReadinessProbe from .container_group_startup_probe import ContainerGroupStartupProbe from .container_group_queue_connection import ContainerGroupQueueConnection +from .queue_autoscaler import QueueAutoscaler from .container_resource_requirements import ContainerResourceRequirements from .container_group_priority import ContainerGroupPriority from .container_group_status import ContainerGroupStatus diff --git a/src/salad_cloud_sdk/models/container_group.py b/src/salad_cloud_sdk/models/container_group.py index 6a380ef..f293909 100644 --- a/src/salad_cloud_sdk/models/container_group.py +++ b/src/salad_cloud_sdk/models/container_group.py @@ -11,6 +11,7 @@ from .container_group_readiness_probe import ContainerGroupReadinessProbe from .container_group_startup_probe import ContainerGroupStartupProbe from .container_group_queue_connection import ContainerGroupQueueConnection +from .queue_autoscaler import QueueAutoscaler @JsonMap({"id_": "id"}) @@ -53,6 +54,8 @@ class ContainerGroup(BaseModel): :type pending_change: bool :param version: version :type version: int + :param queue_autoscaler: Represents the autoscaling rules for a queue, defaults to None + :type queue_autoscaler: QueueAutoscaler, optional """ def __init__( @@ -75,6 +78,7 @@ def __init__( readiness_probe: ContainerGroupReadinessProbe = None, startup_probe: ContainerGroupStartupProbe = None, queue_connection: ContainerGroupQueueConnection = None, + queue_autoscaler: QueueAutoscaler = None, ): """Represents a container group @@ -114,6 +118,8 @@ def __init__( :type pending_change: bool :param version: version :type version: int + :param queue_autoscaler: Represents the autoscaling rules for a queue, defaults to None + :type queue_autoscaler: QueueAutoscaler, optional """ self.id_ = id_ self.name = self._define_str( @@ -155,3 +161,4 @@ def __init__( self.update_time = update_time self.pending_change = pending_change self.version = self._define_number("version", version, ge=1) + self.queue_autoscaler = self._define_object(queue_autoscaler, QueueAutoscaler) diff --git a/src/salad_cloud_sdk/models/create_container_group.py b/src/salad_cloud_sdk/models/create_container_group.py index f096851..86b1d98 100644 --- a/src/salad_cloud_sdk/models/create_container_group.py +++ b/src/salad_cloud_sdk/models/create_container_group.py @@ -10,6 +10,7 @@ from .container_group_readiness_probe import ContainerGroupReadinessProbe from .container_group_startup_probe import ContainerGroupStartupProbe from .container_group_queue_connection import ContainerGroupQueueConnection +from .queue_autoscaler import QueueAutoscaler @JsonMap({}) @@ -40,6 +41,8 @@ class CreateContainerGroup(BaseModel): :type startup_probe: ContainerGroupStartupProbe, optional :param queue_connection: Represents container group queue connection, defaults to None :type queue_connection: ContainerGroupQueueConnection, optional + :param queue_autoscaler: Represents the autoscaling rules for a queue, defaults to None + :type queue_autoscaler: QueueAutoscaler, optional """ def __init__( @@ -56,6 +59,7 @@ def __init__( readiness_probe: ContainerGroupReadinessProbe = None, startup_probe: ContainerGroupStartupProbe = None, queue_connection: ContainerGroupQueueConnection = None, + queue_autoscaler: QueueAutoscaler = None, ): """Represents a request to create a container group @@ -83,6 +87,8 @@ def __init__( :type startup_probe: ContainerGroupStartupProbe, optional :param queue_connection: Represents container group queue connection, defaults to None :type queue_connection: ContainerGroupQueueConnection, optional + :param queue_autoscaler: Represents the autoscaling rules for a queue, defaults to None + :type queue_autoscaler: QueueAutoscaler, optional """ self.name = self._define_str( "name", @@ -121,3 +127,4 @@ def __init__( self.queue_connection = self._define_object( queue_connection, ContainerGroupQueueConnection ) + self.queue_autoscaler = self._define_object(queue_autoscaler, QueueAutoscaler) diff --git a/src/salad_cloud_sdk/models/queue_autoscaler.py b/src/salad_cloud_sdk/models/queue_autoscaler.py new file mode 100644 index 0000000..ad5725a --- /dev/null +++ b/src/salad_cloud_sdk/models/queue_autoscaler.py @@ -0,0 +1,72 @@ +from .utils.json_map import JsonMap +from .utils.base_model import BaseModel + + +@JsonMap({}) +class QueueAutoscaler(BaseModel): + """Represents the autoscaling rules for a queue + + :param min_replicas: min_replicas + :type min_replicas: int + :param max_replicas: max_replicas + :type max_replicas: int + :param desired_queue_length: desired_queue_length + :type desired_queue_length: int + :param polling_period: polling_period, defaults to None + :type polling_period: int, optional + :param max_upscale_per_minute: max_upscale_per_minute, defaults to None + :type max_upscale_per_minute: int, optional + :param max_downscale_per_minute: max_downscale_per_minute, defaults to None + :type max_downscale_per_minute: int, optional + """ + + def __init__( + self, + min_replicas: int, + max_replicas: int, + desired_queue_length: int, + polling_period: int = None, + max_upscale_per_minute: int = None, + max_downscale_per_minute: int = None, + ): + """Represents the autoscaling rules for a queue + + :param min_replicas: min_replicas + :type min_replicas: int + :param max_replicas: max_replicas + :type max_replicas: int + :param desired_queue_length: desired_queue_length + :type desired_queue_length: int + :param polling_period: polling_period, defaults to None + :type polling_period: int, optional + :param max_upscale_per_minute: max_upscale_per_minute, defaults to None + :type max_upscale_per_minute: int, optional + :param max_downscale_per_minute: max_downscale_per_minute, defaults to None + :type max_downscale_per_minute: int, optional + """ + self.min_replicas = self._define_number( + "min_replicas", min_replicas, ge=0, le=100 + ) + self.max_replicas = self._define_number( + "max_replicas", max_replicas, ge=1, le=100 + ) + self.desired_queue_length = self._define_number( + "desired_queue_length", desired_queue_length, ge=1, le=100 + ) + self.polling_period = self._define_number( + "polling_period", polling_period, nullable=True, ge=15, le=1800 + ) + self.max_upscale_per_minute = self._define_number( + "max_upscale_per_minute", + max_upscale_per_minute, + nullable=True, + ge=1, + le=100, + ) + self.max_downscale_per_minute = self._define_number( + "max_downscale_per_minute", + max_downscale_per_minute, + nullable=True, + ge=1, + le=100, + ) diff --git a/src/salad_cloud_sdk/net/transport/request.py b/src/salad_cloud_sdk/net/transport/request.py index 5cab252..3cb8748 100644 --- a/src/salad_cloud_sdk/net/transport/request.py +++ b/src/salad_cloud_sdk/net/transport/request.py @@ -1,4 +1,4 @@ -from typing import Any +from typing import Any, Set from .utils import extract_original_data @@ -80,7 +80,7 @@ def set_body(self, body: Any, content_type: str = "application/json") -> "Reques self.headers["Content-Type"] = content_type return self - def set_scopes(self, scopes: list) -> "Request": + def set_scopes(self, scopes: Set[str]) -> "Request": """ Set the scopes for the request. diff --git a/src/salad_cloud_sdk/services/container_groups.py b/src/salad_cloud_sdk/services/container_groups.py index 8369c12..d8bc246 100644 --- a/src/salad_cloud_sdk/services/container_groups.py +++ b/src/salad_cloud_sdk/services/container_groups.py @@ -322,7 +322,7 @@ def stop_container_group( def list_container_group_instances( self, organization_name: str, project_name: str, container_group_name: str ) -> ContainerGroupInstances: - """Retrieves a list of container group instances + """Gets the list of container group instances :param organization_name: 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. :type organization_name: str @@ -370,7 +370,7 @@ def get_container_group_instance( container_group_name: str, container_group_instance_id: str, ) -> ContainerGroupInstance: - """Retrieves the details of a single instance within a container group by instance ID + """Gets a container group instance :param organization_name: 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. :type organization_name: str @@ -422,7 +422,7 @@ def reallocate_container_group_instance( container_group_name: str, container_group_instance_id: str, ) -> Any: - """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 organization_name: 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. :type organization_name: str @@ -472,7 +472,7 @@ def recreate_container_group_instance( container_group_name: str, container_group_instance_id: str, ) -> Any: - """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 organization_name: 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. :type organization_name: str @@ -522,7 +522,7 @@ def restart_container_group_instance( container_group_name: str, container_group_instance_id: str, ) -> Any: - """Restarts a workload on a node without reallocating it + """Stops a container and restarts it on the same Salad Node :param organization_name: 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. :type organization_name: str diff --git a/src/salad_cloud_sdk/services/inference_endpoints.py b/src/salad_cloud_sdk/services/inference_endpoints.py index 166f6bd..399ab9b 100644 --- a/src/salad_cloud_sdk/services/inference_endpoints.py +++ b/src/salad_cloud_sdk/services/inference_endpoints.py @@ -16,7 +16,7 @@ class InferenceEndpointsService(BaseService): def list_inference_endpoints( self, organization_name: str, page: int = None, page_size: int = None ) -> InferenceEndpointsList: - """Gets the list of all inference endpoints + """Gets the list of inference endpoints :param organization_name: 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. :type organization_name: str diff --git a/src/salad_cloud_sdk/services/queues.py b/src/salad_cloud_sdk/services/queues.py index 0e3e49f..cdb6486 100644 --- a/src/salad_cloud_sdk/services/queues.py +++ b/src/salad_cloud_sdk/services/queues.py @@ -239,7 +239,7 @@ def list_queue_jobs( page: int = None, page_size: int = None, ) -> QueueJobList: - """Retrieves a list of queue jobs + """Gets the list of jobs in a queue :param organization_name: 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. :type organization_name: str @@ -347,7 +347,7 @@ def get_queue_job( queue_name: str, queue_job_id: str, ) -> QueueJob: - """Retrieves a job in a queue + """Gets a job in a queue :param organization_name: 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. :type organization_name: str @@ -399,7 +399,7 @@ def delete_queue_job( queue_name: str, queue_job_id: str, ) -> Any: - """Deletes a queue job + """Cancels a job in a queue :param organization_name: 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. :type organization_name: str