java.lang.Object
- io.lakefs.clients.api.ObjectsApi

```
public class ObjectsApi
extends Object
```

Constructor Summary

Constructors
Constructor Description

ObjectsApi()

ObjectsApi(ApiClient apiClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ObjectStats`	`copyObject(String repository, String branch, String destPath, ObjectCopyCreation objectCopyCreation)`	create a copy of an object
`okhttp3.Call`	`copyObjectAsync(String repository, String branch, String destPath, ObjectCopyCreation objectCopyCreation, ApiCallback<ObjectStats> _callback)`	create a copy of an object (asynchronously)
`okhttp3.Call`	`copyObjectCall(String repository, String branch, String destPath, ObjectCopyCreation objectCopyCreation, ApiCallback _callback)`	Build call for copyObject
`ApiResponse<ObjectStats>`	`copyObjectWithHttpInfo(String repository, String branch, String destPath, ObjectCopyCreation objectCopyCreation)`	create a copy of an object
`void`	`deleteObject(String repository, String branch, String path)`	delete object.
`okhttp3.Call`	`deleteObjectAsync(String repository, String branch, String path, ApiCallback<Void> _callback)`	delete object.
`okhttp3.Call`	`deleteObjectCall(String repository, String branch, String path, ApiCallback _callback)`	Build call for deleteObject
`ObjectErrorList`	`deleteObjects(String repository, String branch, PathList pathList)`	delete objects.
`okhttp3.Call`	`deleteObjectsAsync(String repository, String branch, PathList pathList, ApiCallback<ObjectErrorList> _callback)`	delete objects.
`okhttp3.Call`	`deleteObjectsCall(String repository, String branch, PathList pathList, ApiCallback _callback)`	Build call for deleteObjects
`ApiResponse<ObjectErrorList>`	`deleteObjectsWithHttpInfo(String repository, String branch, PathList pathList)`	delete objects.
`ApiResponse<Void>`	`deleteObjectWithHttpInfo(String repository, String branch, String path)`	delete object.
`ApiClient`	`getApiClient()`
`File`	`getObject(String repository, String ref, String path, String range, Boolean presign)`	get object content
`okhttp3.Call`	`getObjectAsync(String repository, String ref, String path, String range, Boolean presign, ApiCallback<File> _callback)`	get object content (asynchronously)
`okhttp3.Call`	`getObjectCall(String repository, String ref, String path, String range, Boolean presign, ApiCallback _callback)`	Build call for getObject
`ApiResponse<File>`	`getObjectWithHttpInfo(String repository, String ref, String path, String range, Boolean presign)`	get object content
`UnderlyingObjectProperties`	`getUnderlyingProperties(String repository, String ref, String path)`	get object properties on underlying storage
`okhttp3.Call`	`getUnderlyingPropertiesAsync(String repository, String ref, String path, ApiCallback<UnderlyingObjectProperties> _callback)`	get object properties on underlying storage (asynchronously)
`okhttp3.Call`	`getUnderlyingPropertiesCall(String repository, String ref, String path, ApiCallback _callback)`	Build call for getUnderlyingProperties
`ApiResponse<UnderlyingObjectProperties>`	`getUnderlyingPropertiesWithHttpInfo(String repository, String ref, String path)`	get object properties on underlying storage
`void`	`headObject(String repository, String ref, String path, String range)`	check if object exists
`okhttp3.Call`	`headObjectAsync(String repository, String ref, String path, String range, ApiCallback<Void> _callback)`	check if object exists (asynchronously)
`okhttp3.Call`	`headObjectCall(String repository, String ref, String path, String range, ApiCallback _callback)`	Build call for headObject
`ApiResponse<Void>`	`headObjectWithHttpInfo(String repository, String ref, String path, String range)`	check if object exists
`ObjectStatsList`	`listObjects(String repository, String ref, Boolean userMetadata, Boolean presign, String after, Integer amount, String delimiter, String prefix)`	list objects under a given prefix
`okhttp3.Call`	`listObjectsAsync(String repository, String ref, Boolean userMetadata, Boolean presign, String after, Integer amount, String delimiter, String prefix, ApiCallback<ObjectStatsList> _callback)`	list objects under a given prefix (asynchronously)
`okhttp3.Call`	`listObjectsCall(String repository, String ref, Boolean userMetadata, Boolean presign, String after, Integer amount, String delimiter, String prefix, ApiCallback _callback)`	Build call for listObjects
`ApiResponse<ObjectStatsList>`	`listObjectsWithHttpInfo(String repository, String ref, Boolean userMetadata, Boolean presign, String after, Integer amount, String delimiter, String prefix)`	list objects under a given prefix
`void`	`setApiClient(ApiClient apiClient)`
`ObjectStats`	`stageObject(String repository, String branch, String path, ObjectStageCreation objectStageCreation)`	stage an object's metadata for the given branch
`okhttp3.Call`	`stageObjectAsync(String repository, String branch, String path, ObjectStageCreation objectStageCreation, ApiCallback<ObjectStats> _callback)`	stage an object's metadata for the given branch (asynchronously)
`okhttp3.Call`	`stageObjectCall(String repository, String branch, String path, ObjectStageCreation objectStageCreation, ApiCallback _callback)`	Build call for stageObject
`ApiResponse<ObjectStats>`	`stageObjectWithHttpInfo(String repository, String branch, String path, ObjectStageCreation objectStageCreation)`	stage an object's metadata for the given branch
`ObjectStats`	`statObject(String repository, String ref, String path, Boolean userMetadata, Boolean presign)`	get object metadata
`okhttp3.Call`	`statObjectAsync(String repository, String ref, String path, Boolean userMetadata, Boolean presign, ApiCallback<ObjectStats> _callback)`	get object metadata (asynchronously)
`okhttp3.Call`	`statObjectCall(String repository, String ref, String path, Boolean userMetadata, Boolean presign, ApiCallback _callback)`	Build call for statObject
`ApiResponse<ObjectStats>`	`statObjectWithHttpInfo(String repository, String ref, String path, Boolean userMetadata, Boolean presign)`	get object metadata
`ObjectStats`	`uploadObject(String repository, String branch, String path, String storageClass, String ifNoneMatch, File content)`
`okhttp3.Call`	`uploadObjectAsync(String repository, String branch, String path, String storageClass, String ifNoneMatch, File content, ApiCallback<ObjectStats> _callback)`	(asynchronously)
`okhttp3.Call`	`uploadObjectCall(String repository, String branch, String path, String storageClass, String ifNoneMatch, File content, ApiCallback _callback)`	Build call for uploadObject
`ApiResponse<ObjectStats>`	`uploadObjectWithHttpInfo(String repository, String branch, String path, String storageClass, String ifNoneMatch, File content)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectsApi
```
public ObjectsApi()
```

ObjectsApi

public ObjectsApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

copyObjectCall

public okhttp3.Call copyObjectCall(String repository,
                                   String branch,
                                   String destPath,
                                   ObjectCopyCreation objectCopyCreation,
                                   ApiCallback _callback)
                            throws ApiException

Build call for copyObject

Parameters:

repository - (required)

branch - destination branch for the copy (required)

destPath - destination path relative to the branch (required)

objectCopyCreation - (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	Copy object response	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

copyObject

public ObjectStats copyObject(String repository,
                              String branch,
                              String destPath,
                              ObjectCopyCreation objectCopyCreation)
                       throws ApiException

create a copy of an object

Parameters:

repository - (required)

branch - destination branch for the copy (required)

destPath - destination path relative to the branch (required)

objectCopyCreation - (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	Copy object response	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

copyObjectWithHttpInfo

public ApiResponse<ObjectStats> copyObjectWithHttpInfo(String repository,
                                                       String branch,
                                                       String destPath,
                                                       ObjectCopyCreation objectCopyCreation)
                                                throws ApiException

create a copy of an object

Parameters:

repository - (required)

branch - destination branch for the copy (required)

destPath - destination path relative to the branch (required)

objectCopyCreation - (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	Copy object response	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

copyObjectAsync

public okhttp3.Call copyObjectAsync(String repository,
                                    String branch,
                                    String destPath,
                                    ObjectCopyCreation objectCopyCreation,
                                    ApiCallback<ObjectStats> _callback)
                             throws ApiException

create a copy of an object (asynchronously)

Parameters:

repository - (required)

branch - destination branch for the copy (required)

destPath - destination path relative to the branch (required)

objectCopyCreation - (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	Copy object response	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

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. Missing objects will not return a NotFound error.

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. Missing objects will not return a NotFound error.

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. Missing objects will not return a NotFound error. (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	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

deleteObjects

public ObjectErrorList deleteObjects(String repository,
                                     String branch,
                                     PathList pathList)
                              throws ApiException

delete objects. Missing objects will not return a NotFound error.

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	-
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. Missing objects will not return a NotFound error.

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	-
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. Missing objects will not return a NotFound error. (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	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getObjectCall

public okhttp3.Call getObjectCall(String repository,
                                  String ref,
                                  String path,
                                  String range,
                                  Boolean presign,
                                  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)

range - Byte range to retrieve (optional)

presign - (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 content	* Content-Length - * Last-Modified - * ETag -
206	partial object content	* Content-Length - * Content-Range - * Last-Modified - * ETag -
302	Redirect to a pre-signed URL for the object	* Location - redirect to S3
401	Unauthorized	-
404	Resource Not Found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	Internal Server Error	-

getObject

public File getObject(String repository,
                      String ref,
                      String path,
                      String range,
                      Boolean presign)
               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)

range - Byte range to retrieve (optional)

presign - (optional)

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 -
206	partial object content	* Content-Length - * Content-Range - * Last-Modified - * ETag -
302	Redirect to a pre-signed URL for the object	* Location - redirect to S3
401	Unauthorized	-
404	Resource Not Found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	Internal Server Error	-

getObjectWithHttpInfo

public ApiResponse<File> getObjectWithHttpInfo(String repository,
                                               String ref,
                                               String path,
                                               String range,
                                               Boolean presign)
                                        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)

range - Byte range to retrieve (optional)

presign - (optional)

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 -
206	partial object content	* Content-Length - * Content-Range - * Last-Modified - * ETag -
302	Redirect to a pre-signed URL for the object	* Location - redirect to S3
401	Unauthorized	-
404	Resource Not Found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	Internal Server Error	-

getObjectAsync

public okhttp3.Call getObjectAsync(String repository,
                                   String ref,
                                   String path,
                                   String range,
                                   Boolean presign,
                                   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)

range - Byte range to retrieve (optional)

presign - (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 content	* Content-Length - * Last-Modified - * ETag -
206	partial object content	* Content-Length - * Content-Range - * Last-Modified - * ETag -
302	Redirect to a pre-signed URL for the object	* Location - redirect to S3
401	Unauthorized	-
404	Resource Not Found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
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	-

headObjectCall

public okhttp3.Call headObjectCall(String repository,
                                   String ref,
                                   String path,
                                   String range,
                                   ApiCallback _callback)
                            throws ApiException

Build call for headObject

Parameters:

repository - (required)

ref - a reference (could be either a branch or a commit ID) (required)

path - relative to the ref (required)

range - Byte range to retrieve (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 exists	* Content-Length - * Last-Modified - * ETag -
206	partial object content info	* Content-Length - * Content-Range - * Last-Modified - * ETag -
401	Unauthorized	-
404	object not found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	internal server error	-

headObject

public void headObject(String repository,
                       String ref,
                       String path,
                       String range)
                throws ApiException

check if object exists

Parameters:

repository - (required)

ref - a reference (could be either a branch or a commit ID) (required)

path - relative to the ref (required)

range - Byte range to retrieve (optional)

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 exists	* Content-Length - * Last-Modified - * ETag -
206	partial object content info	* Content-Length - * Content-Range - * Last-Modified - * ETag -
401	Unauthorized	-
404	object not found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	internal server error	-

headObjectWithHttpInfo

public ApiResponse<Void> headObjectWithHttpInfo(String repository,
                                                String ref,
                                                String path,
                                                String range)
                                         throws ApiException

check if object exists

Parameters:

repository - (required)

ref - a reference (could be either a branch or a commit ID) (required)

path - relative to the ref (required)

range - Byte range to retrieve (optional)

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
200	object exists	* Content-Length - * Last-Modified - * ETag -
206	partial object content info	* Content-Length - * Content-Range - * Last-Modified - * ETag -
401	Unauthorized	-
404	object not found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	internal server error	-

headObjectAsync

public okhttp3.Call headObjectAsync(String repository,
                                    String ref,
                                    String path,
                                    String range,
                                    ApiCallback<Void> _callback)
                             throws ApiException

check if object exists (asynchronously)

Parameters:

repository - (required)

ref - a reference (could be either a branch or a commit ID) (required)

path - relative to the ref (required)

range - Byte range to retrieve (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 exists	* Content-Length - * Last-Modified - * ETag -
206	partial object content info	* Content-Length - * Content-Range - * Last-Modified - * ETag -
401	Unauthorized	-
404	object not found	-
410	object expired	-
416	Requested Range Not Satisfiable	-
0	internal server error	-

listObjectsCall

public okhttp3.Call listObjectsCall(String repository,
                                    String ref,
                                    Boolean userMetadata,
                                    Boolean presign,
                                    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)

presign - (optional)

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,
                                   Boolean presign,
                                   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)

presign - (optional)

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,
                                                            Boolean presign,
                                                            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)

presign - (optional)

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,
                                     Boolean presign,
                                     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)

presign - (optional)

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,
                                   Boolean presign,
                                   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)

presign - (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 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,
                              Boolean presign)
                       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)

presign - (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
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,
                                                       Boolean presign)
                                                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)

presign - (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
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,
                                    Boolean presign,
                                    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)

presign - (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 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	-

Class ObjectsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ObjectsApi

ObjectsApi

Method Detail

getApiClient

setApiClient

copyObjectCall

copyObject

copyObjectWithHttpInfo

copyObjectAsync

deleteObjectCall

deleteObject

deleteObjectWithHttpInfo

deleteObjectAsync

deleteObjectsCall

deleteObjects

deleteObjectsWithHttpInfo

deleteObjectsAsync

getObjectCall

getObject

getObjectWithHttpInfo

getObjectAsync

getUnderlyingPropertiesCall

getUnderlyingProperties

getUnderlyingPropertiesWithHttpInfo

getUnderlyingPropertiesAsync

headObjectCall

headObject

headObjectWithHttpInfo

headObjectAsync

listObjectsCall

listObjects

listObjectsWithHttpInfo

listObjectsAsync

stageObjectCall

stageObject

stageObjectWithHttpInfo

stageObjectAsync

statObjectCall

statObject

statObjectWithHttpInfo

statObjectAsync

uploadObjectCall

uploadObject

uploadObjectWithHttpInfo

uploadObjectAsync