{"id":19046310,"url":"https://github.com/saladtechnologies/salad-cloud-sdk-java","last_synced_at":"2025-02-21T23:45:34.481Z","repository":{"id":254627342,"uuid":"847072361","full_name":"SaladTechnologies/salad-cloud-sdk-java","owner":"SaladTechnologies","description":"SaladCloud SDK for Java","archived":false,"fork":false,"pushed_at":"2025-02-10T21:33:10.000Z","size":262,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-16T16:59:00.497Z","etag":null,"topics":["java","salad","saladcloud","sdk","sdk-java"],"latest_commit_sha":null,"homepage":"https://salad.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SaladTechnologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-24T19:08:23.000Z","updated_at":"2025-02-05T03:29:24.000Z","dependencies_parsed_at":"2025-01-02T08:44:19.810Z","dependency_job_id":"f6737df4-7f88-4e69-a6a7-d3b6cac590d1","html_url":"https://github.com/SaladTechnologies/salad-cloud-sdk-java","commit_stats":null,"previous_names":["saladtechnologies/salad-cloud-sdk-java"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SaladTechnologies%2Fsalad-cloud-sdk-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SaladTechnologies%2Fsalad-cloud-sdk-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SaladTechnologies%2Fsalad-cloud-sdk-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SaladTechnologies%2Fsalad-cloud-sdk-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SaladTechnologies","download_url":"https://codeload.github.com/SaladTechnologies/salad-cloud-sdk-java/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240103501,"owners_count":19748195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","salad","saladcloud","sdk","sdk-java"],"created_at":"2024-11-08T22:54:17.880Z","updated_at":"2025-02-21T23:45:34.475Z","avatar_url":"https://github.com/SaladTechnologies.png","language":"Java","readme":"# SaladCloudSdk Java SDK 0.9.0-alpha.7\n\nWelcome to the SaladCloudSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudSdk SDK in your project.\n\n## Versions\n\n- API version: `0.9.0-alpha.6`\n- SDK version: `0.9.0-alpha.7`\n\n## About the API\n\nThe SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.\n\n## Table of Contents\n\n- [Setup \u0026 Configuration](#setup--configuration)\n  - [Supported Language Versions](#supported-language-versions)\n  - [Installation](#installation)\n- [Authentication](#authentication)\n  - [API Key Authentication](#api-key-authentication)\n- [Setting a Custom Timeout](#setting-a-custom-timeout)\n- [Sample Usage](#sample-usage)\n- [Services](#services)\n- [Models](#models)\n- [License](#license)\n\n# Setup \u0026 Configuration\n\n## Supported Language Versions\n\nThis SDK is compatible with the following versions: `Java \u003e= 1.8`\n\n## Installation\n\nIf you use Maven, place the following within the _dependency_ tag in your `pom.xml` file:\n\n```XML\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.salad.cloud\u003c/groupId\u003e\n    \u003cartifactId\u003esdk\u003c/artifactId\u003e\n    \u003cversion\u003e0.9.0-alpha.7\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nIf you use Gradle, paste the next line inside the _dependencies_ block of your `build.gradle` file:\n\n```Gradle\nimplementation group: com.salad.cloud, name: sdk, version: 0.9.0-alpha.7\n```\n\nIf you use JAR files, package the SDK by running the following command:\n\n```shell\nmvn compile assembly:single\n```\n\nThen, add the JAR file to your project's classpath.\n\n## Authentication\n\n### API Key Authentication\n\nThe 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.\n\n#### Setting the API key\n\nWhen you initialize the SDK, you can set the API key as follows:\n\n```java\nimport com.salad.cloud.sdk.SaladCloudSdk;\nimport com.salad.cloud.sdk.config.ApiKeyAuthConfig;\nimport com.salad.cloud.sdk.config.SaladCloudSdkConfig;\n\npublic class Main {\n\n  public static void main(String[] args) {\n    ApiKeyAuthConfig apiKeyAuthConfig = ApiKeyAuthConfig\n      .builder()\n      .apiKey(\"YOUR_API_KEY\")\n      .apiKeyHeader(\"YOUR_API_KEY_HEADER\")\n      .build();\n\n    SaladCloudSdkConfig config = SaladCloudSdkConfig.builder().apiKeyAuthConfig(apiKeyAuthConfig).build();\n\n    SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);\n  }\n}\n\n```\n\nIf you need to set or update the API key after initializing the SDK, you can use:\n\n```java\nsaladCloudSdk.setApiKey('YOUR_API_KEY');\nsaladCloudSdk.setApiKeyHeader('YOUR_API_KEY_HEADER');\n```\n\n## Setting a Custom Timeout\n\nYou can set a custom timeout for the SDK's HTTP requests as follows:\n\n```java\nimport com.salad.cloud.sdk.SaladCloudSdk;\nimport com.salad.cloud.sdk.config.SaladCloudSdkConfig;\n\npublic class Main {\n\n  public static void main(String[] args) {\n    SaladCloudSdkConfig config = SaladCloudSdkConfig.builder().timeout(10000).build();\n    SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);\n  }\n}\n\n```\n\n# Sample Usage\n\nBelow is a comprehensive example demonstrating how to authenticate and call a simple endpoint:\n\n```java\nimport com.salad.cloud.sdk.SaladCloudSdk;\nimport com.salad.cloud.sdk.config.ApiKeyAuthConfig;\nimport com.salad.cloud.sdk.config.SaladCloudSdkConfig;\nimport com.salad.cloud.sdk.exceptions.ApiException;\nimport com.salad.cloud.sdk.models.Quotas;\n\npublic class Main {\n\n  public static void main(String[] args) {\n    SaladCloudSdkConfig config = SaladCloudSdkConfig\n      .builder()\n      .apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey(\"YOUR_API_KEY\").build())\n      .build();\n\n    SaladCloudSdk saladCloudSdk = new SaladCloudSdk(config);\n\n    try {\n      Quotas response = saladCloudSdk.quotas.getQuotas(\"fu2s7l\");\n\n      System.out.println(response);\n    } catch (ApiException e) {\n      e.printStackTrace();\n    }\n\n    System.exit(0);\n  }\n}\n\n```\n\n## Services\n\nThe SDK provides various services to interact with the API.\n\n\u003cdetails\u003e\n\u003csummary\u003eBelow is a list of all available services with links to their detailed documentation:\u003c/summary\u003e\n\n| Name                                                                             |\n| :------------------------------------------------------------------------------- |\n| [ContainerGroupsService](documentation/services/ContainerGroupsService.md)       |\n| [WorkloadErrorsService](documentation/services/WorkloadErrorsService.md)         |\n| [SystemLogsService](documentation/services/SystemLogsService.md)                 |\n| [QueuesService](documentation/services/QueuesService.md)                         |\n| [QuotasService](documentation/services/QuotasService.md)                         |\n| [InferenceEndpointsService](documentation/services/InferenceEndpointsService.md) |\n| [OrganizationDataService](documentation/services/OrganizationDataService.md)     |\n| [WebhookSecretKeyService](documentation/services/WebhookSecretKeyService.md)     |\n\n\u003c/details\u003e\n\n## Models\n\nThe 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.\n\n\u003cdetails\u003e\n\u003csummary\u003eBelow is a list of all available models with links to their detailed documentation:\u003c/summary\u003e\n\n| Name                                                                                             | Description                                                              |\n| :----------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- |\n| [ContainerGroupList](documentation/models/ContainerGroupList.md)                                 | Represents a list of container groups                                    |\n| [CreateContainerGroup](documentation/models/CreateContainerGroup.md)                             | Represents a request to create a container group                         |\n| [ContainerGroup](documentation/models/ContainerGroup.md)                                         | Represents a container group                                             |\n| [UpdateContainerGroup](documentation/models/UpdateContainerGroup.md)                             | Represents a request to update a container group                         |\n| [ContainerGroupInstances](documentation/models/ContainerGroupInstances.md)                       | Represents a list of container group instances                           |\n| [ContainerGroupInstance](documentation/models/ContainerGroupInstance.md)                         | Represents the details of a single container group instance              |\n| [WorkloadErrorList](documentation/models/WorkloadErrorList.md)                                   | Represents a list of workload errors                                     |\n| [SystemLogList](documentation/models/SystemLogList.md)                                           | Represents a list of system logs                                         |\n| [QueueList](documentation/models/QueueList.md)                                                   | Represents a list of queues                                              |\n| [CreateQueue](documentation/models/CreateQueue.md)                                               | Represents a request to create a new queue.                              |\n| [Queue](documentation/models/Queue.md)                                                           | Represents a queue.                                                      |\n| [UpdateQueue](documentation/models/UpdateQueue.md)                                               | Represents a request to update an existing queue.                        |\n| [QueueJobList](documentation/models/QueueJobList.md)                                             | Represents a list of queue jobs                                          |\n| [CreateQueueJob](documentation/models/CreateQueueJob.md)                                         | Represents a request to create a queue job                               |\n| [QueueJob](documentation/models/QueueJob.md)                                                     | Represents a queue job                                                   |\n| [Quotas](documentation/models/Quotas.md)                                                         | Represents the organization quotas                                       |\n| [InferenceEndpointsList](documentation/models/InferenceEndpointsList.md)                         | Represents a list of inference endpoints                                 |\n| [InferenceEndpoint](documentation/models/InferenceEndpoint.md)                                   | Represents an inference endpoint                                         |\n| [InferenceEndpointJobList](documentation/models/InferenceEndpointJobList.md)                     | Represents a list of inference endpoint jobs                             |\n| [CreateInferenceEndpointJob](documentation/models/CreateInferenceEndpointJob.md)                 | Represents a request to create a inference endpoint job                  |\n| [InferenceEndpointJob](documentation/models/InferenceEndpointJob.md)                             | Represents a inference endpoint job                                      |\n| [GpuClassesList](documentation/models/GpuClassesList.md)                                         | Represents a list of GPU classes                                         |\n| [WebhookSecretKey](documentation/models/WebhookSecretKey.md)                                     | Represents a webhook secret key                                          |\n| [Container](documentation/models/Container.md)                                                   | Represents a container                                                   |\n| [ContainerRestartPolicy](documentation/models/ContainerRestartPolicy.md)                         |                                                                          |\n| [ContainerGroupState](documentation/models/ContainerGroupState.md)                               | Represents a container group state                                       |\n| [CountryCode](documentation/models/CountryCode.md)                                               |                                                                          |\n| [ContainerGroupNetworking](documentation/models/ContainerGroupNetworking.md)                     | Represents container group networking parameters                         |\n| [ContainerGroupLivenessProbe](documentation/models/ContainerGroupLivenessProbe.md)               | Represents the container group liveness probe                            |\n| [ContainerGroupReadinessProbe](documentation/models/ContainerGroupReadinessProbe.md)             | Represents the container group readiness probe                           |\n| [ContainerGroupStartupProbe](documentation/models/ContainerGroupStartupProbe.md)                 | Represents the container group startup probe                             |\n| [ContainerGroupQueueConnection](documentation/models/ContainerGroupQueueConnection.md)           | Represents container group queue connection                              |\n| [QueueAutoscaler](documentation/models/QueueAutoscaler.md)                                       | Represents the autoscaling rules for a queue                             |\n| [ContainerResourceRequirements](documentation/models/ContainerResourceRequirements.md)           | Represents a container resource requirements                             |\n| [ContainerGroupPriority](documentation/models/ContainerGroupPriority.md)                         |                                                                          |\n| [ContainerGroupStatus](documentation/models/ContainerGroupStatus.md)                             |                                                                          |\n| [ContainerGroupInstanceStatusCount](documentation/models/ContainerGroupInstanceStatusCount.md)   | Represents a container group instance status count                       |\n| [ContainerNetworkingProtocol](documentation/models/ContainerNetworkingProtocol.md)               |                                                                          |\n| [ContainerGroupProbeTcp](documentation/models/ContainerGroupProbeTcp.md)                         |                                                                          |\n| [ContainerGroupProbeHttp](documentation/models/ContainerGroupProbeHttp.md)                       |                                                                          |\n| [ContainerGroupProbeGrpc](documentation/models/ContainerGroupProbeGrpc.md)                       |                                                                          |\n| [ContainerGroupProbeExec](documentation/models/ContainerGroupProbeExec.md)                       |                                                                          |\n| [ContainerProbeHttpScheme](documentation/models/ContainerProbeHttpScheme.md)                     |                                                                          |\n| [ContainerGroupProbeHttpHeaders2](documentation/models/ContainerGroupProbeHttpHeaders2.md)       |                                                                          |\n| [CreateContainer](documentation/models/CreateContainer.md)                                       | Represents a container                                                   |\n| [CreateContainerGroupNetworking](documentation/models/CreateContainerGroupNetworking.md)         | Represents container group networking parameters                         |\n| [UpdateContainer](documentation/models/UpdateContainer.md)                                       | Represents an update container object                                    |\n| [UpdateContainerGroupNetworking](documentation/models/UpdateContainerGroupNetworking.md)         | Represents update container group networking parameters                  |\n| [WorkloadError](documentation/models/WorkloadError.md)                                           | Represents a workload error                                              |\n| [SystemLog](documentation/models/SystemLog.md)                                                   | Represents a system log                                                  |\n| [QueueJobEvent](documentation/models/QueueJobEvent.md)                                           | Represents an event for queue job                                        |\n| [ContainerGroupsQuotas](documentation/models/ContainerGroupsQuotas.md)                           |                                                                          |\n| [InferenceEndpointJobEvent](documentation/models/InferenceEndpointJobEvent.md)                   | Represents an event for inference endpoint job                           |\n| [GpuClass](documentation/models/GpuClass.md)                                                     | Represents a GPU Class                                                   |\n| [GpuClassPrice](documentation/models/GpuClassPrice.md)                                           | Represents the price of a GPU class for a given container group priority |\n| [ListQueueJobsParameters](documentation/models/ListQueueJobsParameters.md)                       |                                                                          |\n| [ListInferenceEndpointsParameters](documentation/models/ListInferenceEndpointsParameters.md)     |                                                                          |\n| [GetInferenceEndpointJobsParameters](documentation/models/GetInferenceEndpointJobsParameters.md) |                                                                          |\n\n\u003c/details\u003e\n\n## License\n\nThis SDK is licensed under the MIT License.\n\nSee the [LICENSE](LICENSE) file for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaladtechnologies%2Fsalad-cloud-sdk-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaladtechnologies%2Fsalad-cloud-sdk-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaladtechnologies%2Fsalad-cloud-sdk-java/lists"}