All URIs are relative to the master’s API URL
| Method | HTTP request | Description |
|---|---|---|
| createBucket | POST /buckets | Creates a new Bucket, and returns its ID for later use. |
| deleteBucket | DELETE /buckets/{bucketId} | Deletes this bucket. |
| getBucket | GET /buckets/{bucketId} | Return a bucket object. |
| getBucketContent | GET /buckets/{bucketId}/content | Returns the content of the requested bucket. |
| getBucketDefinition | GET /buckets/{bucketId}/definition | Return a bucket definition object. |
| getBuckets | GET /buckets | Returns requested bucket definitions. |
| getBucketsContent | GET /buckets/content | Returns an archive containing the compressed content of requested buckets. |
BucketDefinition createBucket(bucketCreation)
Creates a new Bucket, and returns its ID for later use.
This API creates a new Bucket. The returned ID will be used in further jobs requests, to specify job parameters.
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
BucketCreation bucketCreation = new BucketCreation(); // BucketCreation |
try {
BucketDefinition result = apiInstance.createBucket(bucketCreation);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#createBucket");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| bucketCreation | BucketCreation |
No authorization required
String deleteBucket(bucketId)
Deletes this bucket.
This API is to be called to delete a bucket. It cannot be undone.
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
String bucketId = "bucketId_example"; // String |
try {
String result = apiInstance.deleteBucket(bucketId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#deleteBucket");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| bucketId | String |
String
No authorization required
Bucket getBucket(bucketId)
Return a bucket object.
This API is to be called to get a bucket, including bucket definition and bucket data.
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
String bucketId = "bucketId_example"; // String |
try {
Bucket result = apiInstance.getBucket(bucketId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#getBucket");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| bucketId | String |
No authorization required
File getBucketContent(bucketId)
Returns the content of the requested bucket.
Returns the content of the requested bucket.
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
String bucketId = "bucketId_example"; // String |
try {
File result = apiInstance.getBucketContent(bucketId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#getBucketContent");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| bucketId | String |
File
No authorization required
BucketDefinition getBucketDefinition(bucketId)
Return a bucket definition object.
This API is to be called to get a bucket definition (without bucket data).
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
String bucketId = "bucketId_example"; // String |
try {
BucketDefinition result = apiInstance.getBucketDefinition(bucketId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#getBucketDefinition");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| bucketId | String |
No authorization required
List<BucketDefinition> getBuckets()
Returns requested bucket definitions.
This API allows you to retrieve bucket definitions (without the content) from the system.
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
try {
List<BucketDefinition> result = apiInstance.getBuckets();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#getBuckets");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
File getBucketsContent(bucketIds)
Returns an archive containing the compressed content of requested buckets.
Returns an archive containing the compressed content of requested buckets.
// Import classes:
//import com.decisionbrain.optimserver.client.java.jersey2.ApiException;
//import com.decisionbrain.optimserver.client.java.jersey2.api.BucketApi;
BucketApi apiInstance = new BucketApi();
List<String> bucketIds = Arrays.asList(); // List<String> |
try {
File result = apiInstance.getBucketsContent(bucketIds);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling BucketApi#getBucketsContent");
e.printStackTrace();
}
| Name | Type | Description | Notes |
|---|---|---|---|
| bucketIds | List<String> |
File
No authorization required