Package com.decisionbrain.optimserver.client.java.api.generated

Class BucketApi

  • Direct Known Subclasses:
    BucketApi
    @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-03-11T15:59:51.048040Z[Etc/UTC]")
public abstract class BucketApi
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      BucketApi​(ApiClient apiClient)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.decisionbrain.optimserver.master.model.BucketDefinition createBucket​(com.decisionbrain.optimserver.master.model.BucketCreation bucketCreation)
      Creates a new Bucket, and returns its ID for later use.
      ApiResponse<com.decisionbrain.optimserver.master.model.BucketDefinition> createBucketWithHttpInfo​(com.decisionbrain.optimserver.master.model.BucketCreation bucketCreation)
      Creates a new Bucket, and returns its ID for later use.
      java.lang.String deleteBucket​(java.lang.String bucketId)
      Deletes this bucket.
      ApiResponse<java.lang.String> deleteBucketWithHttpInfo​(java.lang.String bucketId)
      Deletes this bucket.
      com.decisionbrain.optimserver.master.model.Bucket getBucket​(java.lang.String bucketId)
      Return a bucket object.
      java.io.InputStream getBucketContent​(java.lang.String bucketId)
      Returns the content of the requested bucket.
      ApiResponse<java.io.InputStream> getBucketContentWithHttpInfo​(java.lang.String bucketId)
      Returns the content of the requested bucket.
      com.decisionbrain.optimserver.master.model.BucketDefinition getBucketDefinition​(java.lang.String bucketId)
      Return a bucket definition object.
      ApiResponse<com.decisionbrain.optimserver.master.model.BucketDefinition> getBucketDefinitionWithHttpInfo​(java.lang.String bucketId)
      Return a bucket definition object.
      java.util.List<com.decisionbrain.optimserver.master.model.BucketDefinition> getBuckets()
      Returns requested bucket definitions.
      java.io.InputStream getBucketsContent​(java.util.List<java.lang.String> bucketIds)
      Returns an archive containing the compressed content of requested buckets.
      ApiResponse<java.io.InputStream> getBucketsContentWithHttpInfo​(java.util.List<java.lang.String> bucketIds)
      Returns an archive containing the compressed content of requested buckets.
      ApiResponse<java.util.List<com.decisionbrain.optimserver.master.model.BucketDefinition>> getBucketsWithHttpInfo()
      Returns requested bucket definitions.
      ApiResponse<com.decisionbrain.optimserver.master.model.Bucket> getBucketWithHttpInfo​(java.lang.String bucketId)
      Return a bucket object.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BucketApi

        public BucketApi​(ApiClient apiClient)

    • Method Detail

      • createBucket

        public com.decisionbrain.optimserver.master.model.BucketDefinition createBucket​(com.decisionbrain.optimserver.master.model.BucketCreation bucketCreation)
                                                                         throws ApiException
        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.
        Parameters:
        bucketCreation - (required)
        Returns:
        BucketDefinition
        Throws:
        ApiException - if fails to make API call

      • createBucketWithHttpInfo

        public ApiResponse<com.decisionbrain.optimserver.master.model.BucketDefinition> createBucketWithHttpInfo​(com.decisionbrain.optimserver.master.model.BucketCreation bucketCreation)
                                                                                                  throws ApiException
        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.
        Parameters:
        bucketCreation - (required)
        Returns:
        ApiResponse<BucketDefinition>
        Throws:
        ApiException - if fails to make API call

      • deleteBucket

        public java.lang.String deleteBucket​(java.lang.String bucketId)
                              throws ApiException
        Deletes this bucket. This API is to be called to delete a bucket. It cannot be undone.
        Parameters:
        bucketId - (required)
        Returns:
        String
        Throws:
        ApiException - if fails to make API call

      • deleteBucketWithHttpInfo

        public ApiResponse<java.lang.String> deleteBucketWithHttpInfo​(java.lang.String bucketId)
                                                       throws ApiException
        Deletes this bucket. This API is to be called to delete a bucket. It cannot be undone.
        Parameters:
        bucketId - (required)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - if fails to make API call

      • getBucket

        public com.decisionbrain.optimserver.master.model.Bucket getBucket​(java.lang.String bucketId)
                                                            throws ApiException
        Return a bucket object. This API is to be called to get a bucket, including bucket definition and bucket data.
        Parameters:
        bucketId - (required)
        Returns:
        Bucket
        Throws:
        ApiException - if fails to make API call

      • getBucketWithHttpInfo

        public ApiResponse<com.decisionbrain.optimserver.master.model.Bucket> getBucketWithHttpInfo​(java.lang.String bucketId)
                                                                                     throws ApiException
        Return a bucket object. This API is to be called to get a bucket, including bucket definition and bucket data.
        Parameters:
        bucketId - (required)
        Returns:
        ApiResponse<Bucket>
        Throws:
        ApiException - if fails to make API call

      • getBucketContent

        public java.io.InputStream getBucketContent​(java.lang.String bucketId)
                                     throws ApiException
        Returns the content of the requested bucket. Returns the content of the requested bucket.
        Parameters:
        bucketId - (required)
        Returns:
        java.io.InputStream
        Throws:
        ApiException - if fails to make API call

      • getBucketContentWithHttpInfo

        public ApiResponse<java.io.InputStream> getBucketContentWithHttpInfo​(java.lang.String bucketId)
                                                              throws ApiException
        Returns the content of the requested bucket. Returns the content of the requested bucket.
        Parameters:
        bucketId - (required)
        Returns:
        ApiResponse<java.io.InputStream>
        Throws:
        ApiException - if fails to make API call

      • getBucketDefinition

        public com.decisionbrain.optimserver.master.model.BucketDefinition getBucketDefinition​(java.lang.String bucketId)
                                                                                throws ApiException
        Return a bucket definition object. This API is to be called to get a bucket definition (without bucket data).
        Parameters:
        bucketId - (required)
        Returns:
        BucketDefinition
        Throws:
        ApiException - if fails to make API call

      • getBucketDefinitionWithHttpInfo

        public ApiResponse<com.decisionbrain.optimserver.master.model.BucketDefinition> getBucketDefinitionWithHttpInfo​(java.lang.String bucketId)
                                                                                                         throws ApiException
        Return a bucket definition object. This API is to be called to get a bucket definition (without bucket data).
        Parameters:
        bucketId - (required)
        Returns:
        ApiResponse<BucketDefinition>
        Throws:
        ApiException - if fails to make API call

      • getBuckets

        public java.util.List<com.decisionbrain.optimserver.master.model.BucketDefinition> getBuckets()
                                                                                       throws ApiException
        Returns requested bucket definitions. This API allows you to retrieve bucket definitions (without the content) from the system.
        Returns:
        List<BucketDefinition>
        Throws:
        ApiException - if fails to make API call

      • getBucketsWithHttpInfo

        public ApiResponse<java.util.List<com.decisionbrain.optimserver.master.model.BucketDefinition>> getBucketsWithHttpInfo()
                                                                                                                throws ApiException
        Returns requested bucket definitions. This API allows you to retrieve bucket definitions (without the content) from the system.
        Returns:
        ApiResponse<List<BucketDefinition>>
        Throws:
        ApiException - if fails to make API call

      • getBucketsContent

        public java.io.InputStream getBucketsContent​(java.util.List<java.lang.String> bucketIds)
                                      throws ApiException
        Returns an archive containing the compressed content of requested buckets. Returns an archive containing the compressed content of requested buckets.
        Parameters:
        bucketIds - (required)
        Returns:
        java.io.InputStream
        Throws:
        ApiException - if fails to make API call

      • getBucketsContentWithHttpInfo

        public ApiResponse<java.io.InputStream> getBucketsContentWithHttpInfo​(java.util.List<java.lang.String> bucketIds)
                                                               throws ApiException
        Returns an archive containing the compressed content of requested buckets. Returns an archive containing the compressed content of requested buckets.
        Parameters:
        bucketIds - (required)
        Returns:
        ApiResponse<java.io.InputStream>
        Throws:
        ApiException - if fails to make API call