Skip to content

Commit

Permalink
osc-sdk-java v0.7.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 authored and outscale-mdr committed Apr 26, 2024
1 parent 8ba1f30 commit c869977
Show file tree
Hide file tree
Showing 1,436 changed files with 18,842 additions and 3,488 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.28.7
- API version: 1.29.3

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.6.0</version>
<version>0.7.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.6.0"
implementation "io.github.outscale:osc-sdk-java:0.7.0"
}
```

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

Then manually install the following JARs:

* `target/osc-sdk-java-0.6.0.jar`
* `target/osc-sdk-java-0.7.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.28.7
1.29.3
2 changes: 1 addition & 1 deletion docs/ApiAccessRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Information about the API access rule.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**apiAccessRuleId** | **String** | The ID of the API access rule. | [optional] |
|**apiAccessRuleId** | **String** | The ID of the API access rule. | [optional] |
|**caIds** | **List&lt;String&gt;** | One or more IDs of Client Certificate Authorities (CAs) used for the API access rule. | [optional] |
|**cns** | **List&lt;String&gt;** | One or more Client Certificate Common Names (CNs). | [optional] |
|**description** | **String** | The description of the API access rule. | [optional] |
Expand Down
8 changes: 4 additions & 4 deletions docs/BackendVmHealth.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

# BackendVmHealth

Information about the health of a back-end VM.
Information about the health of a backend VM.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**description** | **String** | The description of the state of the back-end VM. | [optional] |
|**state** | **String** | The state of the back-end VM (&#x60;InService&#x60; \\| &#x60;OutOfService&#x60; \\| &#x60;Unknown&#x60;). | [optional] |
|**description** | **String** | The description of the state of the backend VM. | [optional] |
|**state** | **String** | The state of the backend VM (&#x60;InService&#x60; \\| &#x60;OutOfService&#x60; \\| &#x60;Unknown&#x60;). | [optional] |
|**stateReason** | **String** | Information about the cause of &#x60;OutOfService&#x60; VMs.&lt;br /&gt; Specifically, whether the cause is Elastic Load Balancing or the VM (&#x60;ELB&#x60; \\| &#x60;Instance&#x60; \\| &#x60;N/A&#x60;). | [optional] |
|**vmId** | **String** | The ID of the back-end VM. | [optional] |
|**vmId** | **String** | The ID of the backend VM. | [optional] |



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 of attachment of the volume to the VM, in ISO 8601 date-time format. | [optional] |
|**linkDate** | **OffsetDateTime** | The date and time (UTC) of attachment of the volume 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
4 changes: 2 additions & 2 deletions docs/Catalogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Information about the catalogs.
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**entries** | [**List&lt;CatalogEntry&gt;**](CatalogEntry.md) | One or more catalog entries. | [optional] |
|**fromDate** | **OffsetDateTime** | The beginning of the time period, in ISO 8601 date-time format. | [optional] |
|**fromDate** | **OffsetDateTime** | The beginning of the time period (UTC). | [optional] |
|**state** | [**StateEnum**](#StateEnum) | The state of the catalog (&#x60;CURRENT&#x60; \\| &#x60;OBSOLETE&#x60;). | [optional] |
|**toDate** | **OffsetDateTime** | The end of the time period, in ISO 8601 date-time format. | [optional] |
|**toDate** | **OffsetDateTime** | The end of the time period (UTC). | [optional] |



Expand Down
4 changes: 2 additions & 2 deletions docs/ConsumptionEntry.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ 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, in ISO 8601 date-time format. | [optional] |
|**fromDate** | **OffsetDateTime** | 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, in ISO 8601 date-time format. | [optional] |
|**toDate** | **OffsetDateTime** | 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] |
|**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
4 changes: 2 additions & 2 deletions docs/CreateApiAccessRuleRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**caIds** | **List&lt;String&gt;** | One or more IDs of Client Certificate Authorities (CAs). | [optional] |
|**caIds** | **List&lt;String&gt;** | One or more IDs of Client Certificate Authorities (CAs). | [optional] |
|**cns** | **List&lt;String&gt;** | One or more Client Certificate Common Names (CNs). If this parameter is specified, you must also specify the &#x60;CaIds&#x60; parameter. | [optional] |
|**description** | **String** | A description for the API access rule. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**ipRanges** | **List&lt;String&gt;** | One or more IP addresses or CIDR blocks (for example, &#x60;192.0.2.0/16&#x60;). | [optional] |
|**ipRanges** | **List&lt;String&gt;** | One or more IPs or CIDR blocks (for example, &#x60;192.0.2.0/16&#x60;). | [optional] |



1 change: 1 addition & 0 deletions docs/CreateNatServiceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**clientToken** | **String** | A unique identifier which enables you to manage the idempotency. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**publicIpId** | **String** | The allocation ID of the public IP to associate with the NAT service.&lt;br /&gt; If the public IP is already associated with another resource, you must first disassociate it. | |
|**subnetId** | **String** | The ID of the Subnet in which you want to create the NAT service. | |
Expand Down
6 changes: 3 additions & 3 deletions docs/CreateServerCertificateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**body** | **String** | The PEM-encoded X509 certificate.&lt;br /&gt;With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: &#x60;--CaPem&#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 CA file is correctly parsed: &#x60;--CaPem&#x3D;&amp;quot;$(cat FILENAME)&amp;quot;&#x60;. | [optional] |
|**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] |
|**privateKey** | **String** | The PEM-encoded private key matching the certificate.&lt;br /&gt;With OSC CLI, use the following syntax to make sure your CA file is correctly parsed: &#x60;--CaPem&#x3D;&amp;quot;$(cat FILENAME)&amp;quot;&#x60;. | |
|**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;. | |



2 changes: 1 addition & 1 deletion docs/CreateVmTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
|------------ | ------------- | ------------- | -------------|
|**cpuCores** | **Integer** | The number of vCores to use for each VM. | |
|**cpuGeneration** | **String** | The processor generation to use for each VM (for example, &#x60;v4&#x60;). | |
|**cpuPerformance** | [**CpuPerformanceEnum**](#CpuPerformanceEnum) | The performance of the VMs (&#x60;medium&#x60; \\| &#x60;high&#x60; \\| &#x60;highest&#x60;). | [optional] |
|**cpuPerformance** | [**CpuPerformanceEnum**](#CpuPerformanceEnum) | The performance of the VMs (&#x60;medium&#x60; \\| &#x60;high&#x60; \\| &#x60;highest&#x60;). | [optional] |
|**description** | **String** | A description for the VM template. | [optional] |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**imageId** | **String** | The ID of the OMI to use for each VM. You can find a list of OMIs by calling the [ReadImages](#readimages) method. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/CreateVolumeRequest.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] |
|**iops** | **Integer** | The number of I/O operations per second (IOPS). This parameter must be specified only if you create an &#x60;io1&#x60; volume. The maximum number of IOPS allowed for &#x60;io1&#x60; volumes is &#x60;13000&#x60; with a maximum performance ratio of 300 IOPS per gibibyte. | [optional] |
|**size** | **Integer** | The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (&#x60;SnapshotId&#x60; unspecified). | [optional] |
|**size** | **Integer** | The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14901 GiB. This parameter is required if the volume is not created from a snapshot (&#x60;SnapshotId&#x60; unspecified). | [optional] |
|**snapshotId** | **String** | The ID of the snapshot from which you want to create the volume. | [optional] |
|**subregionName** | **String** | The Subregion in which you want to create the volume. | |
|**volumeType** | **String** | The type of volume you want to create (&#x60;io1&#x60; \\| &#x60;gp2&#x60; \\| &#x60;standard&#x60;). If not specified, a &#x60;standard&#x60; volume is created.&lt;br /&gt; For more information about volume types, see [About Volumes &gt; Volume Types and IOPS](https://docs.outscale.com/en/userguide/About-Volumes.html#_volume_types_and_iops). | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteVmTemplateRequest.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] |
|**vmTemplateId** | **String** | The ID of the VM template you want to delete. | |
|**vmTemplateId** | **String** | The ID of the VM template you want to delete. | |



2 changes: 1 addition & 1 deletion docs/DeregisterVmsInLoadBalancerRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**backendVmIds** | **List&lt;String&gt;** | One or more IDs of back-end VMs. | |
|**backendVmIds** | **List&lt;String&gt;** | One or more IDs of backend VMs. | |
|**dryRun** | **Boolean** | If true, checks whether you have the required permissions to perform the action. | [optional] |
|**loadBalancerName** | **String** | The name of the load balancer. | |

Expand Down
6 changes: 3 additions & 3 deletions docs/Errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Information about the errors.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**code** | **String** | The code of the error. | [optional] |
|**details** | **String** | The details of the error. | [optional] |
|**type** | **String** | The type of the error. | [optional] |
|**code** | **String** | The code of the error (for example, &#x60;4078&#x60;). You can search for this returned code in the [errors page](api-errors.html) to find more details about the error. | [optional] |
|**details** | **String** | A description providing more details about the error. | [optional] |
|**type** | **String** | The type of the error (for example, &#x60;InvalidParameterValue&#x60;). | [optional] |



2 changes: 1 addition & 1 deletion docs/FiltersApiAccessRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ One or more filters.
|**caIds** | **List&lt;String&gt;** | One or more IDs of Client Certificate Authorities (CAs). | [optional] |
|**cns** | **List&lt;String&gt;** | One or more Client Certificate Common Names (CNs). | [optional] |
|**descriptions** | **List&lt;String&gt;** | One or more descriptions of API access rules. | [optional] |
|**ipRanges** | **List&lt;String&gt;** | One or more IP addresses or CIDR blocks (for example, &#x60;192.0.2.0/16&#x60;). | [optional] |
|**ipRanges** | **List&lt;String&gt;** | One or more IPs or CIDR blocks (for example, &#x60;192.0.2.0/16&#x60;). | [optional] |



1 change: 1 addition & 0 deletions docs/FiltersNatService.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ One or more filters.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**clientTokens** | **List&lt;String&gt;** | The idempotency tokens provided when creating the NAT services. | [optional] |
|**natServiceIds** | **List&lt;String&gt;** | The IDs of the NAT services. | [optional] |
|**netIds** | **List&lt;String&gt;** | The IDs of the Nets in which the NAT services are. | [optional] |
|**states** | **List&lt;String&gt;** | The states of the NAT services (&#x60;pending&#x60; \\| &#x60;available&#x60; \\| &#x60;deleting&#x60; \\| &#x60;deleted&#x60;). | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/FiltersNic.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ One or more filters.
|**linkNicVmIds** | **List&lt;String&gt;** | The IDs of the VMs the NICs are attached to. | [optional] |
|**linkPublicIpAccountIds** | **List&lt;String&gt;** | The account IDs of the owners of the public IPs associated with the NICs. | [optional] |
|**linkPublicIpLinkPublicIpIds** | **List&lt;String&gt;** | The association IDs returned when the public IPs were associated with the NICs. | [optional] |
|**linkPublicIpPublicDnsNames** | **List&lt;String&gt;** | The public DNS names associated with the public IPs. | [optional] |
|**linkPublicIpPublicIpIds** | **List&lt;String&gt;** | The allocation IDs returned when the public IPs were allocated to their accounts. | [optional] |
|**linkPublicIpPublicIps** | **List&lt;String&gt;** | The public IPs associated with the NICs. | [optional] |
|**macAddresses** | **List&lt;String&gt;** | The Media Access Control (MAC) addresses of the NICs. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/FiltersSnapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ One or more filters.
|**permissionsToCreateVolumeGlobalPermission** | **Boolean** | If true, lists all public volumes. If false, lists all private volumes. | [optional] |
|**progresses** | **List&lt;Integer&gt;** | The progresses of the snapshots, as a percentage. | [optional] |
|**snapshotIds** | **List&lt;String&gt;** | The IDs of the snapshots. | [optional] |
|**states** | **List&lt;String&gt;** | The states of the snapshots (&#x60;in-queue&#x60; \\| &#x60;completed&#x60; \\| &#x60;error&#x60;). | [optional] |
|**states** | **List&lt;String&gt;** | The states of the snapshots (&#x60;in-queue&#x60; \\| &#x60;pending&#x60; \\| &#x60;completed&#x60; \\| &#x60;error&#x60; \\| &#x60;deleting&#x60;). | [optional] |
|**tagKeys** | **List&lt;String&gt;** | The keys of the tags associated with the snapshots. | [optional] |
|**tagValues** | **List&lt;String&gt;** | The values of the tags associated with the snapshots. | [optional] |
|**tags** | **List&lt;String&gt;** | The key/value combination of the tags associated with the snapshots, in the following format: &amp;quot;Filters&amp;quot;:{&amp;quot;Tags&amp;quot;:[&amp;quot;TAGKEY&#x3D;TAGVALUE&amp;quot;]}. | [optional] |
Expand Down
2 changes: 1 addition & 1 deletion docs/FiltersVm.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ One or more filters.
|**nicIsSourceDestChecked** | **Boolean** | Whether the source/destination checking is enabled (true) or disabled (false). | [optional] |
|**nicLinkNicDeleteOnVmDeletion** | **Boolean** | Whether the NICs are deleted when the VMs they are attached to are deleted. | [optional] |
|**nicLinkNicDeviceNumbers** | **List&lt;Integer&gt;** | The device numbers the NICs are attached to. | [optional] |
|**nicLinkNicLinkNicDates** | **List&lt;LocalDate&gt;** | The dates and time when the NICs were attached to the VMs. | [optional] |
|**nicLinkNicLinkNicDates** | **List&lt;LocalDate&gt;** | The dates and times (UTC) when the NICs were attached to the VMs. | [optional] |
|**nicLinkNicLinkNicIds** | **List&lt;String&gt;** | The IDs of the NIC attachments. | [optional] |
|**nicLinkNicStates** | **List&lt;String&gt;** | The states of the attachments. | [optional] |
|**nicLinkNicVmAccountIds** | **List&lt;String&gt;** | The account IDs of the owners of the VMs the NICs are attached to. | [optional] |
Expand Down
1 change: 0 additions & 1 deletion docs/FiltersVmTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# FiltersVmTemplate

One or more filters.

## Properties

Expand Down
Loading

0 comments on commit c869977

Please sign in to comment.