Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SDK v0.5.0 #124

Merged
merged 1 commit into from
Jan 16, 2024
Merged

SDK v0.5.0 #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
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.27.0
- API version: 1.28.5

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.4.0</version>
<version>0.5.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.4.0"
implementation "io.github.outscale:osc-sdk-java:0.5.0"
}
```

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

Then manually install the following JARs:

* `target/osc-sdk-java-0.4.0.jar`
* `target/osc-sdk-java-0.5.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down
2 changes: 1 addition & 1 deletion api_version
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.27.0
1.28.5
126 changes: 0 additions & 126 deletions docs/AccountApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*
| [**createAccount**](AccountApi.md#createAccount) | **POST** /CreateAccount | |
| [**readAccounts**](AccountApi.md#readAccounts) | **POST** /ReadAccounts | |
| [**readConsumptionAccount**](AccountApi.md#readConsumptionAccount) | **POST** /ReadConsumptionAccount | |
| [**resetAccountPassword**](AccountApi.md#resetAccountPassword) | **POST** /ResetAccountPassword | |
| [**sendResetPasswordEmail**](AccountApi.md#sendResetPasswordEmail) | **POST** /SendResetPasswordEmail | |
| [**updateAccount**](AccountApi.md#updateAccount) | **POST** /UpdateAccount | |


Expand Down Expand Up @@ -289,130 +287,6 @@ public class Example {
|-------------|-------------|------------------|
| **200** | The HTTP 200 response (OK). | - |

<a name="resetAccountPassword"></a>
# **resetAccountPassword**
> ResetAccountPasswordResponse resetAccountPassword(resetAccountPasswordRequest)



### 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.models.*;
import io.github.outscale.osc_sdk_java.client.api.AccountApi;

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")

AccountApi apiInstance = new AccountApi(defaultClient);
ResetAccountPasswordRequest resetAccountPasswordRequest = new ResetAccountPasswordRequest(); // ResetAccountPasswordRequest |
try {
ResetAccountPasswordResponse result = apiInstance.resetAccountPassword(resetAccountPasswordRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountApi#resetAccountPassword");
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 |
|------------- | ------------- | ------------- | -------------|
| **resetAccountPasswordRequest** | [**ResetAccountPasswordRequest**](ResetAccountPasswordRequest.md)| | [optional] |

### Return type

[**ResetAccountPasswordResponse**](ResetAccountPasswordResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

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

<a name="sendResetPasswordEmail"></a>
# **sendResetPasswordEmail**
> SendResetPasswordEmailResponse sendResetPasswordEmail(sendResetPasswordEmailRequest)



### 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.models.*;
import io.github.outscale.osc_sdk_java.client.api.AccountApi;

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")

AccountApi apiInstance = new AccountApi(defaultClient);
SendResetPasswordEmailRequest sendResetPasswordEmailRequest = new SendResetPasswordEmailRequest(); // SendResetPasswordEmailRequest |
try {
SendResetPasswordEmailResponse result = apiInstance.sendResetPasswordEmail(sendResetPasswordEmailRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AccountApi#sendResetPasswordEmail");
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 |
|------------- | ------------- | ------------- | -------------|
| **sendResetPasswordEmailRequest** | [**SendResetPasswordEmailRequest**](SendResetPasswordEmailRequest.md)| | [optional] |

### Return type

[**SendResetPasswordEmailResponse**](SendResetPasswordEmailResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

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

<a name="updateAccount"></a>
# **updateAccount**
> UpdateAccountResponse updateAccount(updateAccountRequest)
Expand Down
2 changes: 1 addition & 1 deletion docs/ApiAccessPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Information about the API access policy.
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**maxAccessKeyExpirationSeconds** | **Long** | The maximum possible lifetime for your access keys, in seconds. If &#x60;0&#x60;, your access keys can have unlimited lifetimes. | [optional] |
|**requireTrustedEnv** | **Boolean** | If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see the &#x60;ApiKeyAuth&#x60; authentication scheme in the [Authentication](#authentication) section. | [optional] |
|**requireTrustedEnv** | **Boolean** | If true, a trusted session is activated, allowing you to bypass Certificate Authorities (CAs) enforcement. For more information, see [About Your API Access Policy](https://docs.outscale.com/en/userguide/About-Your-API-Access-Policy.html).&lt;br /&gt; If this is enabled, it is required that you and all your users log in to Cockpit v2 using the WebAuthn method for multi-factor authentication. For more information, see [About Authentication &gt; Multi-Factor Authentication](https://docs.outscale.com/en/userguide/About-Authentication.html#_multi_factor_authentication). | [optional] |



2 changes: 2 additions & 0 deletions docs/ConsumptionEntry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ Information about the resources consumed during the specified time period.
|**fromDate** | **OffsetDateTime** | The beginning of the time period, in ISO 8601 date-time format. | [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 catalog of the Region where the API method was used. | [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, in ISO 8601 date-time format. | [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 catalog of the Region where the API method was used. | [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/CreateClientGatewayRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**bgpAsn** | **Integer** | The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. This number must be between &#x60;1&#x60; and &#x60;4294967295&#x60;. | |
|**bgpAsn** | **Integer** | The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. &lt;br/&gt; This number must be between &#x60;1&#x60; and &#x60;4294967295&#x60;. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294. | |
|**connectionType** | **String** | The communication protocol used to establish tunnel with your client gateway (only &#x60;ipsec.1&#x60; is supported). | |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**publicIp** | **String** | The public fixed IPv4 address of your client gateway. | |
Expand Down
18 changes: 9 additions & 9 deletions docs/CreateImageRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**architecture** | **String** | The architecture of the OMI (by default, &#x60;i386&#x60; if you specified the &#x60;FileLocation&#x60; or &#x60;RootDeviceName&#x60; parameter). | [optional] |
|**blockDeviceMappings** | [**List&lt;BlockDeviceMappingImage&gt;**](BlockDeviceMappingImage.md) | One or more block device mappings. | [optional] |
|**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;x84_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] |
|**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** | The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in a bucket. If you specify this parameter, a copy of the OMI is created in your account. You must specify only one of the following parameters: &#x60;FileLocation&#x60;, &#x60;RootDeviceName&#x60;, &#x60;SourceImageId&#x60; or &#x60;VmId&#x60;. | [optional] |
|**imageName** | **String** | A unique name for the new OMI.&lt;br /&gt; Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-). | [optional] |
|**noReboot** | **Boolean** | If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not. | [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] |
|**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** | The name of the root device. You must specify only one of the following parameters: &#x60;FileLocation&#x60;, &#x60;RootDeviceName&#x60;, &#x60;SourceImageId&#x60; or &#x60;VmId&#x60;. | [optional] |
|**sourceImageId** | **String** | The ID of the OMI you want to copy. You must specify only one of the following parameters: &#x60;FileLocation&#x60;, &#x60;RootDeviceName&#x60;, &#x60;SourceImageId&#x60; or &#x60;VmId&#x60;. | [optional] |
|**sourceRegionName** | **String** | The name of the source Region, which must be the same as the Region of your account. | [optional] |
|**vmId** | **String** | The ID of the VM from which you want to create the OMI. You must specify only one of the following parameters: &#x60;FileLocation&#x60;, &#x60;RootDeviceName&#x60;, &#x60;SourceImageId&#x60; or &#x60;VmId&#x60;. | [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] |
|**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] |



2 changes: 1 addition & 1 deletion docs/CreateKeypairRequest.md
View file
Open in desktop
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] |
|**keypairName** | **String** | A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). | |
|**publicKey** | **String** | The public key. It must be Base64-encoded. | [optional] |
|**publicKey** | **String** | The public key to import in your account, if you are importing an existing keypair. This value must be Base64-encoded. | [optional] |



2 changes: 1 addition & 1 deletion docs/CreateNetRequest.md
View file
Open in desktop
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] |
|**ipRange** | **String** | The IP range for the Net, in CIDR notation (for example, &#x60;10.0.0.0/16&#x60;). | |
|**tenancy** | **String** | The tenancy options for the VMs (&#x60;default&#x60; if a VM created in a Net can be launched with any tenancy, &#x60;dedicated&#x60; if it can be launched with dedicated tenancy VMs running on single-tenant hardware). | [optional] |
|**tenancy** | **String** | The tenancy options for the VMs:&lt;br /&gt; - &#x60;default&#x60; if a VM created in a Net can be launched with any tenancy.&lt;br /&gt; - &#x60;dedicated&#x60; if it can be launched with dedicated tenancy VMs running on single-tenant hardware.&lt;br /&gt; - &#x60;dedicated group ID&#x60;: if it can be launched in a dedicated group on single-tenant hardware. | [optional] |



4 changes: 2 additions & 2 deletions docs/CreateSecurityGroupRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**description** | **String** | A description for the security group, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). | |
|**description** | **String** | A description for the security group.&lt;br /&gt; This description can contain between 1 and 255 characters. Allowed characters are &#x60;a-z&#x60;, &#x60;A-Z&#x60;, &#x60;0-9&#x60;, accented letters, spaces, and &#x60;_.-:/()#,@[]+&#x3D;&amp;;{}!$*&#x60;. | |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**netId** | **String** | The ID of the Net for the security group. | [optional] |
|**securityGroupName** | **String** | The name of the security group.&lt;br /&gt; This name must not start with &#x60;sg-&#x60;.&lt;/br&gt; This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed. | |
|**securityGroupName** | **String** | The name of the security group.&lt;br /&gt; This name must not start with &#x60;sg-&#x60;.&lt;br /&gt; This name must be unique and contain between 1 and 255 characters. Allowed characters are &#x60;a-z&#x60;, &#x60;A-Z&#x60;, &#x60;0-9&#x60;, spaces, and &#x60;_.-:/()#,@[]+&#x3D;&amp;;{}!$*&#x60;. | |



Loading
Loading