Skip to content

Commit 402353f

Browse files
outscale-mdrjerome-jutteau
authored andcommitted
osc-sdk-java v0.3.0
1 parent 3a63ad7 commit 402353f

File tree

1,215 files changed

+15449
-1317
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,215 files changed

+15449
-1317
lines changed
Lines changed: 63 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -1,182 +1,91 @@
11
diff --git a/outscale.yaml b/outscale.yaml
2-
index 8d912fe..17586a0 100644
2+
index 1016bea..47eb28c 100644
33
--- a/outscale.yaml
44
+++ b/outscale.yaml
5-
@@ -43,15 +43,15 @@ components:
6-
type: string
7-
CreationDate:
8-
description: The date and time (UTC) of creation of the access key.
9-
- format: datetime
10-
+ format: date-time
11-
type: string
12-
ExpirationDate:
13-
description: The date (UTC) at which the access key expires.
14-
- format: datetime
15-
+ format: date-time
16-
type: string
17-
LastModificationDate:
18-
description: The date and time (UTC) of the last modification of the access key.
19-
- format: datetime
20-
+ format: date-time
21-
type: string
22-
State:
23-
description: The state of the access key (`ACTIVE` if the key is valid for API calls, or `INACTIVE` if not).
24-
@@ -66,15 +66,15 @@ components:
25-
type: string
26-
CreationDate:
27-
description: The date and time (UTC) of creation of the access key.
28-
- format: datetime
29-
+ format: date-time
30-
type: string
31-
ExpirationDate:
32-
description: The date and time (UTC) at which the access key expires.
33-
- format: datetime
34-
+ format: date-time
35-
type: string
36-
LastModificationDate:
37-
description: The date and time (UTC) of the last modification of the access key.
38-
- format: datetime
39-
+ format: date-time
40-
type: string
41-
SecretKey:
42-
description: The access key that enables you to send requests.
43-
@@ -285,7 +285,7 @@ components:
44-
type: boolean
45-
LinkDate:
46-
description: The time and date of attachment of the volume to the VM.
47-
- format: date
48-
+ format: date-time
49-
type: string
50-
State:
51-
description: The state of the volume.
52-
@@ -445,7 +445,7 @@ components:
53-
type: string
54-
FromDate:
55-
description: The beginning of the time period.
56-
- format: datetime
57-
+ format: date-time
58-
type: string
59-
Operation:
60-
description: The API call that triggered the resource consumption (for example, `RunInstances` or `CreateVolume`).
61-
@@ -464,7 +464,7 @@ components:
62-
type: string
63-
ToDate:
64-
description: The end of the time period.
65-
- format: datetime
66-
+ format: date-time
67-
type: string
68-
Type:
69-
description: The type of resource, depending on the API call.
70-
@@ -482,7 +482,7 @@ components:
5+
@@ -506,11 +506,8 @@ components:
716
type: boolean
727
ExpirationDate:
73-
description: The date and time at which you want the access key to expire, in ISO 8601 format (for example, `2017-06-14` or `2017-06-14T00:00:00Z`). To remove an existing expiration date, use the method without specifying this parameter.
74-
- format: datetime
75-
+ format: date-time
76-
type: string
8+
description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z`, or `2020-06-14`). To remove an existing expiration date, use the method without specifying this parameter.
9+
- oneOf:
10+
- - format: date-time
11+
- type: string
12+
- - format: date
13+
- type: string
14+
+ format: date-time
15+
+ type: string
7716
type: object
7817
CreateAccessKeyResponse:
79-
@@ -2669,11 +2669,11 @@ components:
18+
additionalProperties: false
19+
@@ -2846,18 +2843,12 @@ components:
8020
type: array
8121
QueryDateAfter:
82-
description: The date after which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-14`). By default, this date is set to 48 hours before the `QueryDateBefore` parameter value.
83-
- format: date
84-
+ format: date-time
85-
type: string
22+
description: The date and time, or the date, after which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). By default, this date is set to 48 hours before the `QueryDateBefore` parameter value.
23+
- oneOf:
24+
- - format: date-time
25+
- type: string
26+
- - format: date
27+
- type: string
28+
+ format: date-time
29+
+ type: string
8630
QueryDateBefore:
87-
description: The date before which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-30`). By default, this date is set to now, or 48 hours after the `QueryDateAfter` parameter value.
88-
- format: date
89-
+ format: date-time
90-
type: string
31+
description: The date and time, or the date, before which you want to retrieve logged calls, in ISO 8601 format (for example, `2020-06-30T00:00:00.000Z` or `2020-06-14`). By default, this date is set to now, or 48 hours after the `QueryDateAfter` parameter value.
32+
- oneOf:
33+
- - format: date-time
34+
- type: string
35+
- - format: date
36+
- type: string
37+
+ format: date-time
38+
+ type: string
9139
QueryIpAddresses:
9240
description: The IPs used for the logged calls.
93-
@@ -4024,7 +4024,7 @@ components:
94-
CreationDates:
95-
description: The dates and times of creation of the volumes.
96-
items:
97-
- format: date
98-
+ format: date-time
99-
type: string
100-
type: array
101-
LinkVolumeDeleteOnVmDeletion:
102-
@@ -4038,7 +4038,7 @@ components:
103-
LinkVolumeLinkDates:
104-
description: The dates and times of creation of the volumes.
10541
items:
106-
- format: date
107-
+ format: date-time
108-
type: string
42+
@@ -4583,7 +4574,7 @@ components:
10943
type: array
110-
LinkVolumeLinkStates:
111-
@@ -4990,7 +4990,7 @@ components:
112-
type: string
113-
QueryDate:
114-
description: The date of the logged call, in ISO 8601 format.
115-
- format: date
116-
+ format: date-time
44+
CreationDate:
45+
description: The date and time of creation of the OMI, in ISO 8601 date-time format.
46+
- format: date-time
47+
+ format: date
11748
type: string
118-
QueryHeaderRaw:
119-
description: The raw header of the HTTP request of the logged call.
120-
@@ -5815,7 +5815,7 @@ components:
49+
Description:
50+
description: The description of the OMI.
51+
@@ -6171,22 +6162,16 @@ components:
12152
type: boolean
12253
FromDate:
123-
description: The beginning of the time period, in ISO 8601 date-time format (for example, `2017-06-14` or `2017-06-14T00:00:00Z`).
124-
- format: datetime
125-
+ format: date-time
126-
type: string
54+
description: The beginning of the time period, in ISO 8601 date format (for example, `2020-06-14`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-14T00:00:00.000Z`).
55+
- oneOf:
56+
- - format: date
57+
- type: string
58+
- - format: date-time
59+
- type: string
60+
+ format: date-time
61+
+ type: string
12762
Overall:
12863
default: false
129-
@@ -5823,7 +5823,7 @@ components:
64+
description: By default or if false, returns only the consumption of the specific account that sends this request. If true, returns either the overall consumption of your paying account and all linked accounts (if the account that sends this request is a paying account) or returns nothing (if the account that sends this request is a linked account).
13065
type: boolean
13166
ToDate:
132-
description: The end of the time period, in ISO 8601 date-time format (for example, `2017-06-30` or `2017-06-30T00:00:00Z`).
133-
- format: datetime
134-
+ format: date-time
135-
type: string
67+
description: The end of the time period, in ISO 8601 date format (for example, `2020-06-30`). The date-time format is also accepted, but only with a time set to midnight (for example, `2020-06-30T00:00:00.000Z`).
68+
- oneOf:
69+
- - format: date
70+
- type: string
71+
- - format: date-time
72+
- type: string
73+
+ format: date-time
74+
+ type: string
13675
required:
13776
- FromDate
138-
@@ -7042,7 +7042,7 @@ components:
139-
type: string
140-
CreationDate:
141-
description: The date and time of creation of the snapshot.
142-
- format: datetime
143-
+ format: date-time
144-
type: string
145-
Description:
146-
description: The description of the snapshot.
147-
@@ -7454,7 +7454,7 @@ components:
77+
- ToDate
78+
@@ -7901,11 +7886,8 @@ components:
14879
type: boolean
14980
ExpirationDate:
150-
description: The date and time at which you want the access key to expire, in ISO 8601 format (for example, `2017-06-14` or `2017-06-14T00:00:00Z`). If not specified, the access key is set to not expire.
151-
- format: datetime
152-
+ format: date-time
153-
type: string
81+
description: The date and time, or the date, at which you want the access key to expire, in ISO 8601 format (for example, `2020-06-14T00:00:00.000Z` or `2020-06-14`). If not specified, the access key is set to not expire.
82+
- oneOf:
83+
- - format: date-time
84+
- type: string
85+
- - format: date
86+
- type: string
87+
+ format: date-time
88+
+ type: string
15489
State:
15590
description: The new state for the access key (`ACTIVE` \| `INACTIVE`). When set to `ACTIVE`, the access key is enabled and can be used to send requests. When set to `INACTIVE`, the access key is disabled.
156-
@@ -8116,7 +8116,7 @@ components:
157-
type: integer
158-
LastStateChangeDate:
159-
description: The date and time (UTC) of the latest state update.
160-
- format: datetime
161-
+ format: date-time
162-
type: string
163-
OutsideIpAddress:
164-
description: The IP on the OUTSCALE side of the tunnel.
165-
@@ -8172,7 +8172,7 @@ components:
166-
type: string
167-
CreationDate:
168-
description: The date and time of creation of the VM.
169-
- format: datetime
170-
+ format: date-time
171-
type: string
172-
DeletionProtection:
173-
description: If true, you cannot delete the VM unless you change this parameter back to false.
174-
@@ -8335,7 +8335,7 @@ components:
175-
properties:
176-
CreationDate:
177-
description: The date and time of creation of the volume.
178-
- format: datetime
179-
+ format: date-time
18091
type: string
181-
Iops:
182-
description: 'The number of I/O operations per second (IOPS):<br />

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# osc-sdk-java
44

55
3DS OUTSCALE API
6-
- API version: 1.25.0
6+
- API version: 1.26.0
77

88
Welcome to the OUTSCALE API documentation.<br />
99
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 />
@@ -46,7 +46,7 @@ Add this dependency to your project's POM:
4646
<dependency>
4747
<groupId>io.github.outscale</groupId>
4848
<artifactId>osc-sdk-java</artifactId>
49-
<version>0.2.0</version>
49+
<version>0.3.0</version>
5050
<scope>compile</scope>
5151
</dependency>
5252
```
@@ -62,7 +62,7 @@ Add this dependency to your project's build file:
6262
}
6363
6464
dependencies {
65-
implementation "io.github.outscale:osc-sdk-java:0.2.0"
65+
implementation "io.github.outscale:osc-sdk-java:0.3.0"
6666
}
6767
```
6868

@@ -76,7 +76,7 @@ mvn clean package
7676

7777
Then manually install the following JARs:
7878

79-
* `target/osc-sdk-java-0.2.0.jar`
79+
* `target/osc-sdk-java-0.3.0.jar`
8080
* `target/lib/*.jar`
8181

8282
## Getting Started

api_version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.25.0
1+
1.26.0

docs/BsuCreated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Information about the created BSU volume.
99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
1111
|**deleteOnVmDeletion** | **Boolean** | If true, the volume is deleted when terminating the VM. If false, the volume is not deleted when terminating the VM. | [optional] |
12-
|**linkDate** | **OffsetDateTime** | The time and date of attachment of the volume to the VM. | [optional] |
12+
|**linkDate** | **OffsetDateTime** | The date and time of attachment of the volume to the VM, in ISO 8601 date-time format. | [optional] |
1313
|**state** | **String** | The state of the volume. | [optional] |
1414
|**volumeId** | **String** | The ID of the volume. | [optional] |
1515

docs/CatalogApi.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.eu-west-2.outscale.com/api/v1*
55
| Method | HTTP request | Description |
66
|------------- | ------------- | -------------|
77
| [**readCatalog**](CatalogApi.md#readCatalog) | **POST** /ReadCatalog | |
8+
| [**readCatalogs**](CatalogApi.md#readCatalogs) | **POST** /ReadCatalogs | |
89

910

1011
<a name="readCatalog"></a>
@@ -76,3 +77,72 @@ public class Example {
7677
|-------------|-------------|------------------|
7778
| **200** | The HTTP 200 response (OK). | - |
7879

80+
<a name="readCatalogs"></a>
81+
# **readCatalogs**
82+
> ReadCatalogsResponse readCatalogs(readCatalogsRequest)
83+
84+
85+
86+
### Example
87+
```java
88+
// Import classes:
89+
import io.github.outscale.osc_sdk_java.client.ApiClient;
90+
import io.github.outscale.osc_sdk_java.client.ApiException;
91+
import io.github.outscale.osc_sdk_java.client.Configuration;
92+
import io.github.outscale.osc_sdk_java.client.auth.*;
93+
import io.github.outscale.osc_sdk_java.client.models.*;
94+
import io.github.outscale.osc_sdk_java.client.api.CatalogApi;
95+
96+
public class Example {
97+
public static void main(String[] args) {
98+
ApiClient defaultClient = Configuration.getDefaultApiClient();
99+
defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
100+
// Configure AWS Signature V4 authorization
101+
defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
102+
103+
// Configure API key authorization: ApiKeyAuth
104+
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
105+
ApiKeyAuth.setApiKey("YOUR API KEY");
106+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
107+
//ApiKeyAuth.setApiKeyPrefix("Token");
108+
109+
CatalogApi apiInstance = new CatalogApi(defaultClient);
110+
ReadCatalogsRequest readCatalogsRequest = new ReadCatalogsRequest(); // ReadCatalogsRequest |
111+
try {
112+
ReadCatalogsResponse result = apiInstance.readCatalogs(readCatalogsRequest);
113+
System.out.println(result);
114+
} catch (ApiException e) {
115+
System.err.println("Exception when calling CatalogApi#readCatalogs");
116+
System.err.println("Status code: " + e.getCode());
117+
System.err.println("Reason: " + e.getResponseBody());
118+
System.err.println("Response headers: " + e.getResponseHeaders());
119+
e.printStackTrace();
120+
}
121+
}
122+
}
123+
```
124+
125+
### Parameters
126+
127+
| Name | Type | Description | Notes |
128+
|------------- | ------------- | ------------- | -------------|
129+
| **readCatalogsRequest** | [**ReadCatalogsRequest**](ReadCatalogsRequest.md)| | [optional] |
130+
131+
### Return type
132+
133+
[**ReadCatalogsResponse**](ReadCatalogsResponse.md)
134+
135+
### Authorization
136+
137+
[ApiKeyAuth](../README.md#ApiKeyAuth)
138+
139+
### HTTP request headers
140+
141+
- **Content-Type**: application/json
142+
- **Accept**: application/json
143+
144+
### HTTP response details
145+
| Status code | Description | Response headers |
146+
|-------------|-------------|------------------|
147+
| **200** | The HTTP 200 response (OK). | - |
148+

0 commit comments

Comments
 (0)