Package io.lakefs.clients.api

Class ObjectsApi

  • public class ObjectsApi
extends Object

    • Constructor Detail

      • ObjectsApi

        public ObjectsApi()

      • ObjectsApi

        public ObjectsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • deleteObjectCall

        public okhttp3.Call deleteObjectCall​(String repository,
                                     String branch,
                                     String path,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for deleteObject
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 object deleted successfully -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObject

        public void deleteObject​(String repository,
                         String branch,
                         String path)
                  throws ApiException
        delete object
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 object deleted successfully -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObjectWithHttpInfo

        public ApiResponse<Void> deleteObjectWithHttpInfo​(String repository,
                                                  String branch,
                                                  String path)
                                           throws ApiException
        delete object
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        204 object deleted successfully -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObjectAsync

        public okhttp3.Call deleteObjectAsync​(String repository,
                                      String branch,
                                      String path,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        delete object (asynchronously)
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        204 object deleted successfully -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObjectsCall

        public okhttp3.Call deleteObjectsCall​(String repository,
                                      String branch,
                                      PathList pathList,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for deleteObjects
        Parameters:
        repository - (required)
        branch - (required)
        pathList - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Delete objects response -
        204 all requested objects successfully deleted -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObjects

        public ObjectErrorList deleteObjects​(String repository,
                                     String branch,
                                     PathList pathList)
                              throws ApiException
        delete objects
        Parameters:
        repository - (required)
        branch - (required)
        pathList - (required)
        Returns:
        ObjectErrorList
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Delete objects response -
        204 all requested objects successfully deleted -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObjectsWithHttpInfo

        public ApiResponse<ObjectErrorList> deleteObjectsWithHttpInfo​(String repository,
                                                              String branch,
                                                              PathList pathList)
                                                       throws ApiException
        delete objects
        Parameters:
        repository - (required)
        branch - (required)
        pathList - (required)
        Returns:
        ApiResponse<ObjectErrorList>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Delete objects response -
        204 all requested objects successfully deleted -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • deleteObjectsAsync

        public okhttp3.Call deleteObjectsAsync​(String repository,
                                       String branch,
                                       PathList pathList,
                                       ApiCallback<ObjectErrorList> _callback)
                                throws ApiException
        delete objects (asynchronously)
        Parameters:
        repository - (required)
        branch - (required)
        pathList - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Delete objects response -
        204 all requested objects successfully deleted -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • getObjectCall

        public okhttp3.Call getObjectCall​(String repository,
                                  String ref,
                                  String path,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for getObject
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the ref (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object content * Content-Length -
        * Last-Modified -
        * ETag -
        * Content-Disposition -
        401 Unauthorized -
        404 Resource Not Found -
        410 object expired -
        0 Internal Server Error -

      • getObject

        public File getObject​(String repository,
                      String ref,
                      String path)
               throws ApiException
        get object content
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the ref (required)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object content * Content-Length -
        * Last-Modified -
        * ETag -
        * Content-Disposition -
        401 Unauthorized -
        404 Resource Not Found -
        410 object expired -
        0 Internal Server Error -

      • getObjectWithHttpInfo

        public ApiResponse<File> getObjectWithHttpInfo​(String repository,
                                               String ref,
                                               String path)
                                        throws ApiException
        get object content
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the ref (required)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object content * Content-Length -
        * Last-Modified -
        * ETag -
        * Content-Disposition -
        401 Unauthorized -
        404 Resource Not Found -
        410 object expired -
        0 Internal Server Error -

      • getObjectAsync

        public okhttp3.Call getObjectAsync​(String repository,
                                   String ref,
                                   String path,
                                   ApiCallback<File> _callback)
                            throws ApiException
        get object content (asynchronously)
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the ref (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object content * Content-Length -
        * Last-Modified -
        * ETag -
        * Content-Disposition -
        401 Unauthorized -
        404 Resource Not Found -
        410 object expired -
        0 Internal Server Error -

      • getUnderlyingPropertiesCall

        public okhttp3.Call getUnderlyingPropertiesCall​(String repository,
                                                String ref,
                                                String path,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getUnderlyingProperties
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata on underlying storage -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • getUnderlyingProperties

        public UnderlyingObjectProperties getUnderlyingProperties​(String repository,
                                                          String ref,
                                                          String path)
                                                   throws ApiException
        get object properties on underlying storage
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        Returns:
        UnderlyingObjectProperties
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata on underlying storage -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • getUnderlyingPropertiesWithHttpInfo

        public ApiResponse<UnderlyingObjectProperties> getUnderlyingPropertiesWithHttpInfo​(String repository,
                                                                                   String ref,
                                                                                   String path)
                                                                            throws ApiException
        get object properties on underlying storage
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        Returns:
        ApiResponse<UnderlyingObjectProperties>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata on underlying storage -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • getUnderlyingPropertiesAsync

        public okhttp3.Call getUnderlyingPropertiesAsync​(String repository,
                                                 String ref,
                                                 String path,
                                                 ApiCallback<UnderlyingObjectProperties> _callback)
                                          throws ApiException
        get object properties on underlying storage (asynchronously)
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata on underlying storage -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • listObjectsCall

        public okhttp3.Call listObjectsCall​(String repository,
                                    String ref,
                                    Boolean userMetadata,
                                    String after,
                                    Integer amount,
                                    String delimiter,
                                    String prefix,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for listObjects
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        userMetadata - (optional, default to true)
        after - return items after this value (optional)
        amount - how many items to return (optional, default to 100)
        delimiter - delimiter used to group common prefixes by (optional)
        prefix - return items prefixed with this value (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object listing -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • listObjects

        public ObjectStatsList listObjects​(String repository,
                                   String ref,
                                   Boolean userMetadata,
                                   String after,
                                   Integer amount,
                                   String delimiter,
                                   String prefix)
                            throws ApiException
        list objects under a given prefix
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        userMetadata - (optional, default to true)
        after - return items after this value (optional)
        amount - how many items to return (optional, default to 100)
        delimiter - delimiter used to group common prefixes by (optional)
        prefix - return items prefixed with this value (optional)
        Returns:
        ObjectStatsList
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object listing -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • listObjectsWithHttpInfo

        public ApiResponse<ObjectStatsList> listObjectsWithHttpInfo​(String repository,
                                                            String ref,
                                                            Boolean userMetadata,
                                                            String after,
                                                            Integer amount,
                                                            String delimiter,
                                                            String prefix)
                                                     throws ApiException
        list objects under a given prefix
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        userMetadata - (optional, default to true)
        after - return items after this value (optional)
        amount - how many items to return (optional, default to 100)
        delimiter - delimiter used to group common prefixes by (optional)
        prefix - return items prefixed with this value (optional)
        Returns:
        ApiResponse<ObjectStatsList>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object listing -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • listObjectsAsync

        public okhttp3.Call listObjectsAsync​(String repository,
                                     String ref,
                                     Boolean userMetadata,
                                     String after,
                                     Integer amount,
                                     String delimiter,
                                     String prefix,
                                     ApiCallback<ObjectStatsList> _callback)
                              throws ApiException
        list objects under a given prefix (asynchronously)
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        userMetadata - (optional, default to true)
        after - return items after this value (optional)
        amount - how many items to return (optional, default to 100)
        delimiter - delimiter used to group common prefixes by (optional)
        prefix - return items prefixed with this value (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object listing -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • stageObjectCall

        public okhttp3.Call stageObjectCall​(String repository,
                                    String branch,
                                    String path,
                                    ObjectStageCreation objectStageCreation,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for stageObject
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        objectStageCreation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • stageObject

        public ObjectStats stageObject​(String repository,
                               String branch,
                               String path,
                               ObjectStageCreation objectStageCreation)
                        throws ApiException
        stage an object's metadata for the given branch
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        objectStageCreation - (required)
        Returns:
        ObjectStats
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • stageObjectWithHttpInfo

        public ApiResponse<ObjectStats> stageObjectWithHttpInfo​(String repository,
                                                        String branch,
                                                        String path,
                                                        ObjectStageCreation objectStageCreation)
                                                 throws ApiException
        stage an object's metadata for the given branch
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        objectStageCreation - (required)
        Returns:
        ApiResponse<ObjectStats>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • stageObjectAsync

        public okhttp3.Call stageObjectAsync​(String repository,
                                     String branch,
                                     String path,
                                     ObjectStageCreation objectStageCreation,
                                     ApiCallback<ObjectStats> _callback)
                              throws ApiException
        stage an object's metadata for the given branch (asynchronously)
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        objectStageCreation - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        0 Internal Server Error -

      • statObjectCall

        public okhttp3.Call statObjectCall​(String repository,
                                   String ref,
                                   String path,
                                   Boolean userMetadata,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for statObject
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        userMetadata - (optional, default to true)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata -
        401 Unauthorized -
        404 Resource Not Found -
        410 object gone (but partial metadata may be available) -
        0 Internal Server Error -

      • statObject

        public ObjectStats statObject​(String repository,
                              String ref,
                              String path,
                              Boolean userMetadata)
                       throws ApiException
        get object metadata
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        userMetadata - (optional, default to true)
        Returns:
        ObjectStats
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata -
        401 Unauthorized -
        404 Resource Not Found -
        410 object gone (but partial metadata may be available) -
        0 Internal Server Error -

      • statObjectWithHttpInfo

        public ApiResponse<ObjectStats> statObjectWithHttpInfo​(String repository,
                                                       String ref,
                                                       String path,
                                                       Boolean userMetadata)
                                                throws ApiException
        get object metadata
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        userMetadata - (optional, default to true)
        Returns:
        ApiResponse<ObjectStats>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata -
        401 Unauthorized -
        404 Resource Not Found -
        410 object gone (but partial metadata may be available) -
        0 Internal Server Error -

      • statObjectAsync

        public okhttp3.Call statObjectAsync​(String repository,
                                    String ref,
                                    String path,
                                    Boolean userMetadata,
                                    ApiCallback<ObjectStats> _callback)
                             throws ApiException
        get object metadata (asynchronously)
        Parameters:
        repository - (required)
        ref - a reference (could be either a branch or a commit ID) (required)
        path - relative to the branch (required)
        userMetadata - (optional, default to true)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 object metadata -
        401 Unauthorized -
        404 Resource Not Found -
        410 object gone (but partial metadata may be available) -
        0 Internal Server Error -

      • uploadObjectCall

        public okhttp3.Call uploadObjectCall​(String repository,
                                     String branch,
                                     String path,
                                     String storageClass,
                                     String ifNoneMatch,
                                     File content,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for uploadObject
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        storageClass - (optional)
        ifNoneMatch - Currently supports only \"*\" to allow uploading an object only if one doesn't exist yet (optional)
        content - Only a single file per upload which must be named \\\"content\\\". (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        412 Precondition Failed -
        0 Internal Server Error -

      • uploadObject

        public ObjectStats uploadObject​(String repository,
                                String branch,
                                String path,
                                String storageClass,
                                String ifNoneMatch,
                                File content)
                         throws ApiException
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        storageClass - (optional)
        ifNoneMatch - Currently supports only \"*\" to allow uploading an object only if one doesn't exist yet (optional)
        content - Only a single file per upload which must be named \\\"content\\\". (optional)
        Returns:
        ObjectStats
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        412 Precondition Failed -
        0 Internal Server Error -

      • uploadObjectWithHttpInfo

        public ApiResponse<ObjectStats> uploadObjectWithHttpInfo​(String repository,
                                                         String branch,
                                                         String path,
                                                         String storageClass,
                                                         String ifNoneMatch,
                                                         File content)
                                                  throws ApiException
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        storageClass - (optional)
        ifNoneMatch - Currently supports only \"*\" to allow uploading an object only if one doesn't exist yet (optional)
        content - Only a single file per upload which must be named \\\"content\\\". (optional)
        Returns:
        ApiResponse<ObjectStats>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        412 Precondition Failed -
        0 Internal Server Error -

      • uploadObjectAsync

        public okhttp3.Call uploadObjectAsync​(String repository,
                                      String branch,
                                      String path,
                                      String storageClass,
                                      String ifNoneMatch,
                                      File content,
                                      ApiCallback<ObjectStats> _callback)
                               throws ApiException
        (asynchronously)
        Parameters:
        repository - (required)
        branch - (required)
        path - relative to the branch (required)
        storageClass - (optional)
        ifNoneMatch - Currently supports only \"*\" to allow uploading an object only if one doesn't exist yet (optional)
        content - Only a single file per upload which must be named \\\"content\\\". (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        201 object metadata -
        400 Validation Error -
        401 Unauthorized -
        404 Resource Not Found -
        412 Precondition Failed -
        0 Internal Server Error -