https://github.com/saladtechnologies/salad-cloud-imds-sdk-dotnet
SaladCloud IMDS SDK for .NET
https://github.com/saladtechnologies/salad-cloud-imds-sdk-dotnet
Last synced: about 1 month ago
JSON representation
SaladCloud IMDS SDK for .NET
- Host: GitHub
- URL: https://github.com/saladtechnologies/salad-cloud-imds-sdk-dotnet
- Owner: SaladTechnologies
- License: mit
- Created: 2024-09-05T22:06:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-05T04:30:15.000Z (about 1 year ago)
- Last Synced: 2025-02-16T16:59:00.443Z (8 months ago)
- Language: C#
- Size: 47.9 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# SaladCloudImdsSdk C# SDK 0.9.0-alpha.4
Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project.
[](https://liblab.com/?utm_source=readme)
## Versions
- API version: `0.9.0-alpha.2`
- SDK version: `0.9.0-alpha.4`
## About the API
The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud API Documentation](https://docs.salad.com/reference) for more details.
## Table of Contents
- [Setup & Configuration](#setup--configuration)
- [Supported Language Versions](#supported-language-versions)
- [Installation](#installation)
- [Sample Usage](#sample-usage)
- [Services](#services)
- [Models](#models)
- [License](#license)
# Setup & Configuration
## Supported Language Versions
This SDK is compatible with the following versions: `C# >= .NET 6`
## Installation
To get started with the SDK, we recommend installing using `nuget`:
```bash
dotnet add package Salad.Cloud.IMDS.SDK
```
# Sample Usage
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
```cs
using Salad.Cloud.IMDS.SDK;
using Salad.Cloud.IMDS.SDK.Config;
using Environment = Salad.Cloud.IMDS.SDK.Http.Environment;
var config = new SaladCloudImdsSdkConfig
{
Environment = Environment.Default
};
var client = new SaladCloudImdsSdkClient(config);
var response = await client.Metadata.GetDeletionCostAsync();
Console.WriteLine(response);
```
## 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](documentation/services/MetadataService.md) |
## 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](documentation/models/DeletionCost.md) | The deletion cost of the current container instance. |
| [ReallocatePrototype](documentation/models/ReallocatePrototype.md) | Represents a request to reallocate the current container instance to another SaladCloud node. |
| [Status](documentation/models/Status.md) | The health statuses of the current container instance. |
| [Token](documentation/models/Token.md) | The identity token of the current container instance. |
## License
This SDK is licensed under the MIT License.
See the [LICENSE](LICENSE) file for more details.