SaladCloudImdsSdk Java SDK 0.9.0-alpha.6

Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project.

Versions

• API version: 0.9.0-alpha.3
• SDK version: 0.9.0-alpha.6

About the API

The SaladCloud Instance Metadata Service (IMDS). Please refer to the SaladCloud API Documentation for more details.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Java >= 1.8

Installation

If you use Maven, place the following within the dependency tag in your pom.xml file:

<dependency>
    <groupId>com.salad.cloud</groupId>
    <artifactId>imds-sdk</artifactId>
    <version>0.9.0-alpha.6</version>
</dependency>

If you use Gradle, paste the next line inside the dependencies block of your build.gradle file:

implementation group: com.salad.cloud, name: imds-sdk, version: 0.9.0-alpha.6

If you use JAR files, package the SDK by running the following command:

mvn compile assembly:single

Then, add the JAR file to your project's classpath.

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

import com.salad.cloud.imdssdk.SaladCloudImdsSdk;
import com.salad.cloud.imdssdk.config.SaladCloudImdsSdkConfig;

public class Main {

  public static void main(String[] args) {
    SaladCloudImdsSdkConfig config = SaladCloudImdsSdkConfig.builder().timeout(10000).build();
    SaladCloudImdsSdk saladCloudImdsSdk = new SaladCloudImdsSdk(config);
  }
}

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import com.salad.cloud.imdssdk.SaladCloudImdsSdk;
import com.salad.cloud.imdssdk.exceptions.ApiError;
import com.salad.cloud.imdssdk.models.DeletionCost;
import com.salad.cloud.imdssdk.models.GetDeletionCostParameters;
import com.salad.cloud.imdssdk.models.Metadata;

public class Main {

  public static void main(String[] args) {
    SaladCloudImdsSdk saladCloudImdsSdk = new SaladCloudImdsSdk();

    GetDeletionCostParameters requestParameters = GetDeletionCostParameters.builder().metadata(Metadata.TRUE).build();

    try {
      DeletionCost response = saladCloudImdsSdk.metadata.getDeletionCost(requestParameters);

      System.out.println(response);
    } catch (ApiError e) {
      e.printStackTrace();
    }

    System.exit(0);
  }
}

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Name
MetadataService

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 with links to their detailed documentation:

Name	Description
DeletionCost	The deletion cost of the current container instance.
Metadata
GetDeletionCostParameters
ReplaceDeletionCostParameters
ReallocatePrototype	Represents a request to reallocate the current container instance to another SaladCloud node.
ReallocateParameters
RecreateParameters
RestartParameters
Status	The health statuses of the current container instance.
GetStatusParameters
Token	The identity token of the current container instance.
GetTokenParameters
SaladCloudImdsError	An API error. The code and type uniquely identify the type of the error. The code is a short value that may be used for programmatic error handling. The type is an absolute URL that may be resolved for more detailed information. Refer to the SaladCloud IMDS reference for a list of the expected code and type values. Also, note that all properties are optional. Clients should implement robust error handling to account for unexpected errors.

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.