Skip to content

Commit

Permalink
osc-sdk-java v0.9.0
Browse files Browse the repository at this point in the history
Signed-off-by: Outscale Bot <[email protected]>
  • Loading branch information
Open-Source-Bot committed Oct 3, 2024
1 parent aa4d791 commit 959c79f
Show file tree
Hide file tree
Showing 1,417 changed files with 6,638 additions and 2,946 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# osc-sdk-java

3DS OUTSCALE API
- API version: 1.30.0
- API version: v1.33.1

Welcome to the OUTSCALE API documentation.<br />
The OUTSCALE API enables you to manage your resources in the OUTSCALE Cloud. This documentation describes the different actions available along with code examples.<br /><br />
Expand Down Expand Up @@ -46,7 +46,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>io.github.outscale</groupId>
<artifactId>osc-sdk-java</artifactId>
<version>0.8.0</version>
<version>0.9.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -62,7 +62,7 @@ Add this dependency to your project's build file:
}
dependencies {
implementation "io.github.outscale:osc-sdk-java:0.8.0"
implementation "io.github.outscale:osc-sdk-java:0.9.0"
}
```

Expand All @@ -76,7 +76,7 @@ mvn clean package

Then manually install the following JARs:

* `target/osc-sdk-java-0.8.0.jar`
* `target/osc-sdk-java-0.9.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down
2 changes: 1 addition & 1 deletion api_version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.30.0
v1.33.1
6 changes: 3 additions & 3 deletions docs/AccessKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Information about the access key.
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**accessKeyId** | **String** | The ID of the access key. | [optional] |
|**creationDate** | **OffsetDateTime** | The date and time (UTC) at which the access key was created. | [optional] |
|**expirationDate** | **OffsetDateTime** | The date and time (UTC) at which the access key expires. | [optional] |
|**lastModificationDate** | **OffsetDateTime** | The date and time (UTC) at which the access key was last modified. | [optional] |
|**creationDate** | **String** | The date and time (UTC) at which the access key was created. | [optional] |
|**expirationDate** | **String** | The date and time (UTC) at which the access key expires. | [optional] |
|**lastModificationDate** | **String** | The date and time (UTC) at which the access key was last modified. | [optional] |
|**state** | **String** | The state of the access key (&#x60;ACTIVE&#x60; if the key is valid for API calls, or &#x60;INACTIVE&#x60; if not). | [optional] |


Expand Down
6 changes: 3 additions & 3 deletions docs/AccessKeySecretKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Information about the access key.
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**accessKeyId** | **String** | The ID of the access key. | [optional] |
|**creationDate** | **OffsetDateTime** | The date and time (UTC) at which the access key was created. | [optional] |
|**expirationDate** | **OffsetDateTime** | The date and time (UTC) at which the access key expires. | [optional] |
|**lastModificationDate** | **OffsetDateTime** | The date and time (UTC) at which the access key was last modified. | [optional] |
|**creationDate** | **String** | The date and time (UTC) at which the access key was created. | [optional] |
|**expirationDate** | **String** | The date and time (UTC) at which the access key expires. | [optional] |
|**lastModificationDate** | **String** | The date and time (UTC) at which the access key was last modified. | [optional] |
|**secretKey** | **String** | The secret key that enables you to send requests. | [optional] |
|**state** | **String** | The state of the access key (&#x60;ACTIVE&#x60; if the key is valid for API calls, or &#x60;INACTIVE&#x60; if not). | [optional] |

Expand Down
2 changes: 1 addition & 1 deletion docs/BsuCreated.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Information about the created BSU volume.
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**deleteOnVmDeletion** | **Boolean** | If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. | [optional] |
|**linkDate** | **OffsetDateTime** | The date and time (UTC) at which the volume was attached to the VM, in ISO 8601 date-time format. | [optional] |
|**linkDate** | **LocalDate** | The date and time (UTC) at which the volume was attached to the VM, in ISO 8601 date-time format. | [optional] |
|**state** | **String** | The state of the volume. | [optional] |
|**volumeId** | **String** | The ID of the volume. | [optional] |

Expand Down
70 changes: 70 additions & 0 deletions docs/CatalogApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*
|------------- | ------------- | -------------|
| [**readCatalog**](CatalogApi.md#readCatalog) | **POST** /ReadCatalog | |
| [**readCatalogs**](CatalogApi.md#readCatalogs) | **POST** /ReadCatalogs | |
| [**readUnitPrice**](CatalogApi.md#readUnitPrice) | **POST** /ReadUnitPrice | |


<a name="readCatalog"></a>
Expand Down Expand Up @@ -146,3 +147,72 @@ public class Example {
|-------------|-------------|------------------|
| **200** | The HTTP 200 response (OK). | - |

<a name="readUnitPrice"></a>
# **readUnitPrice**
> ReadUnitPriceResponse readUnitPrice(readUnitPriceRequest)


### Example
```java
// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.CatalogApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
// Configure AWS Signature V4 authorization
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")

// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");

CatalogApi apiInstance = new CatalogApi(defaultClient);
ReadUnitPriceRequest readUnitPriceRequest = new ReadUnitPriceRequest(); // ReadUnitPriceRequest |
try {
ReadUnitPriceResponse result = apiInstance.readUnitPrice(readUnitPriceRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CatalogApi#readUnitPrice");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **readUnitPriceRequest** | [**ReadUnitPriceRequest**](ReadUnitPriceRequest.md)| | [optional] |

### Return type

[**ReadUnitPriceResponse**](ReadUnitPriceResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | The HTTP 200 response (OK). | - |

2 changes: 1 addition & 1 deletion docs/CatalogEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Information about the catalog entry.
|**subregionName** | **String** | The Subregion associated with the catalog entry. | [optional] |
|**title** | **String** | The description of the catalog entry. | [optional] |
|**type** | **String** | The type of resource associated with the catalog entry. | [optional] |
|**unitPrice** | **Float** | The unit price of the catalog entry, in the currency of the Region&#39;s catalog. | [optional] |
|**unitPrice** | **Float** | The unit price of the catalog entry in the currency of your account, in the ISO-4217 format (for example, &#x60;EUR&#x60;). | [optional] |



6 changes: 3 additions & 3 deletions docs/ConsumptionEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ Information about the resources consumed during the specified time period.
|------------ | ------------- | ------------- | -------------|
|**accountId** | **String** | The ID of your TINA account. | [optional] |
|**category** | **String** | The category of the resource (for example, &#x60;network&#x60;). | [optional] |
|**fromDate** | **OffsetDateTime** | The beginning of the time period (UTC). | [optional] |
|**fromDate** | **String** | The beginning of the time period (UTC). | [optional] |
|**operation** | **String** | The API call that triggered the resource consumption (for example, &#x60;RunInstances&#x60; or &#x60;CreateVolume&#x60;). | [optional] |
|**payingAccountId** | **String** | The ID of the TINA account which is billed for your consumption. It can be different from your account in the &#x60;AccountId&#x60; parameter. | [optional] |
|**price** | **Double** | The total price of the consumed resource during the specified time period, in the currency of the Region&#39;s catalog. | [optional] |
|**service** | **String** | The service of the API call (&#x60;TinaOS-FCU&#x60;, &#x60;TinaOS-LBU&#x60;, &#x60;TinaOS-DirectLink&#x60;, &#x60;TinaOS-OOS&#x60;, or &#x60;TinaOS-OSU&#x60;). | [optional] |
|**subregionName** | **String** | The name of the Subregion. | [optional] |
|**title** | **String** | A description of the consumed resource. | [optional] |
|**toDate** | **OffsetDateTime** | The end of the time period (UTC). | [optional] |
|**toDate** | **String** | The end of the time period (UTC). | [optional] |
|**type** | **String** | The type of resource, depending on the API call. | [optional] |
|**unitPrice** | **Double** | The unit price of the consumed resource, in the currency of the Region&#39;s catalog. | [optional] |
|**unitPrice** | **Double** | The unit price of the consumed resource in the currency of your account, in the ISO-4217 format (for example, &#x60;EUR&#x60;). | [optional] |
|**value** | **Double** | The consumed amount for the resource. The unit depends on the resource type. For more information, see the &#x60;Title&#x60; element. | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion docs/CreateAccessKeyRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**expirationDate** | **OffsetDateTime** | The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, &#x60;2020-06-14T00:00:00.000Z&#x60;, or &#x60;2020-06-14&#x60;). To remove an existing expiration date, use the method without specifying this parameter. | [optional] |
|**expirationDate** | **String** | The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, &#x60;2020-06-14T00:00:00.000Z&#x60;, or &#x60;2020-06-14&#x60;). To remove an existing expiration date, use the method without specifying this parameter. | [optional] |
|**userName** | **String** | The name of the EIM user that owns the key to be created. If you do not specify a user name, this action creates an access key for the user who sends the request (which can be the root account). | [optional] |


Expand Down
8 changes: 4 additions & 4 deletions docs/CreateImageRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**architecture** | **String** | **(when registering from a snapshot, or from a bucket without using a manifest file)** The architecture of the OMI (&#x60;i386&#x60; or &#x60;x86_64&#x60;). | [optional] |
|**blockDeviceMappings** | [**List&lt;BlockDeviceMappingImage&gt;**](BlockDeviceMappingImage.md) | **(when registering from a snapshot, or from a bucket without using a manifest file)** One or more block device mappings. | [optional] |
|**architecture** | **String** | **(when registering from a snapshot)** The architecture of the OMI (&#x60;i386&#x60; or &#x60;x86_64&#x60;). | [optional] |
|**blockDeviceMappings** | [**List&lt;BlockDeviceMappingImage&gt;**](BlockDeviceMappingImage.md) | **(when registering from a snapshot)** One or more block device mappings. | [optional] |
|**description** | **String** | A description for the new OMI. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**fileLocation** | **String** | **(when registering from a bucket by using a manifest file)** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Configuring a Pre-signed URL](https://docs.outscale.com/en/userguide/Configuring-a-Pre-signed-URL.html) or [Managing Access to Your Buckets and Objects](https://docs.outscale.com/en/userguide/Managing-Access-to-Your-Buckets-and-Objects.html).&lt;br /&gt; You can also specify the normal URL of the OMI if you have permission on the OOS bucket, without using the manifest file, but in that case, you need to manually specify through the other parameters all the information that would otherwise be read from the manifest file. | [optional] |
|**fileLocation** | **String** | **(when registering from a bucket by using a manifest file)** The pre-signed URL of the manifest file for the OMI you want to register. For more information, see [Creating a Pre-signed URL](https://docs.outscale.com/en/userguide/Creating-a-Pre-Signed-URL.html). | [optional] |
|**imageName** | **String** | A unique name for the new OMI.&lt;br /&gt; Constraints: 3-128 alphanumeric characters, underscores (&#x60;_&#x60;), spaces (&#x60; &#x60;), parentheses (&#x60;()&#x60;), slashes (&#x60;/&#x60;), periods (&#x60;.&#x60;), or dashes (&#x60;-&#x60;). | [optional] |
|**noReboot** | **Boolean** | **(when creating from a VM)** If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. | [optional] |
|**productCodes** | **List&lt;String&gt;** | The product codes associated with the OMI. | [optional] |
|**rootDeviceName** | **String** | **(when registering from a snapshot, or from a bucket without using a manifest file)** The name of the root device for the new OMI. | [optional] |
|**rootDeviceName** | **String** | **(when registering from a snapshot)** The name of the root device for the new OMI. | [optional] |
|**sourceImageId** | **String** | **(when copying an OMI)** The ID of the OMI you want to copy. | [optional] |
|**sourceRegionName** | **String** | **(when copying an OMI)** The name of the source Region (always the same as the Region of your account). | [optional] |
|**vmId** | **String** | **(when creating from a VM)** The ID of the VM from which you want to create the OMI. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateLoadBalancerPolicyRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
|**cookieName** | **String** | The name of the application cookie used for stickiness. This parameter is required if you create a stickiness policy based on an application-generated cookie. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**loadBalancerName** | **String** | The name of the load balancer for which you want to create a policy. | |
|**policyName** | **String** | The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (-). | |
|**policyName** | **String** | The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (&#x60;-&#x60;). | |
|**policyType** | **String** | The type of stickiness policy you want to create: &#x60;app&#x60; or &#x60;load_balancer&#x60;. | |


Expand Down
2 changes: 1 addition & 1 deletion docs/CreateLoadBalancerRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**listeners** | [**List&lt;ListenerForCreation&gt;**](ListenerForCreation.md) | One or more listeners to create. | |
|**loadBalancerName** | **String** | The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (-). This name must not start or end with a dash. | |
|**loadBalancerName** | **String** | The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (&#x60;-&#x60;). This name must not start or end with a dash. | |
|**loadBalancerType** | **String** | The type of load balancer: &#x60;internet-facing&#x60; or &#x60;internal&#x60;. Use this parameter only for load balancers in a Net. | [optional] |
|**publicIp** | **String** | (internet-facing only) The public IP you want to associate with the load balancer. If not specified, a public IP owned by 3DS OUTSCALE is associated. | [optional] |
|**securityGroups** | **List&lt;String&gt;** | (Net only) One or more IDs of security groups you want to assign to the load balancer. If not specified, the default security group of the Net is assigned to the load balancer. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/CreateNetPeeringRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**accepterNetId** | **String** | The ID of the Net you want to connect with. | |
|**accepterOwnerId** | **String** | The account ID of the owner of the Net you want to connect with. By default, the account ID of the owner of the Net from which the peering request is sent. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**sourceNetId** | **String** | The ID of the Net you send the peering request from. | |

Expand Down
4 changes: 2 additions & 2 deletions docs/CreateServerCertificateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
|**body** | **String** | The PEM-encoded X509 certificate.&lt;br /&gt;With OSC CLI, use the following syntax to make sure your certificate file is correctly parsed: &#x60;--Body&#x3D;&amp;quot;$(cat FILENAME)&amp;quot;&#x60;. | |
|**chain** | **String** | The PEM-encoded intermediate certification authorities.&lt;br /&gt;With OSC CLI, use the following syntax to make sure your certificate chain file is correctly parsed: &#x60;--Chain&#x3D;&amp;quot;$(cat FILENAME)&amp;quot;&#x60;. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**name** | **String** | A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (+), equals (&#x3D;), commas (,), periods (.), at signs (@), minuses (-), or underscores (_). | |
|**path** | **String** | The path to the server certificate, set to a slash (/) if not specified. | [optional] |
|**name** | **String** | A unique name for the certificate. Constraints: 1-128 alphanumeric characters, pluses (&#x60;+&#x60;), equals (&#x60;&#x3D;&#x60;), commas (&#x60;,&#x60;), periods (&#x60;.&#x60;), at signs (&#x60;@&#x60;), minuses (&#x60;-&#x60;), or underscores (&#x60;_&#x60;). | |
|**path** | **String** | The path to the server certificate, set to a slash (&#x60;/&#x60;) if not specified. | [optional] |
|**privateKey** | **String** | The PEM-encoded private key matching the certificate.&lt;br /&gt;With OSC CLI, use the following syntax to make sure your key file is correctly parsed: &#x60;--PrivateKey&#x3D;&amp;quot;$(cat FILENAME)&amp;quot;&#x60;. | |


Expand Down
Loading

0 comments on commit 959c79f

Please sign in to comment.