Package io.lakefs.clients.sdk

Class ObjectsApi

java.lang.Object

io.lakefs.clients.sdk.ObjectsApi

public class ObjectsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ObjectsApi.APIcopyObjectRequest
class	ObjectsApi.APIdeleteObjectRequest
class	ObjectsApi.APIdeleteObjectsRequest
class	ObjectsApi.APIgetObjectRequest
class	ObjectsApi.APIgetUnderlyingPropertiesRequest
class	ObjectsApi.APIheadObjectRequest
class	ObjectsApi.APIlistObjectsRequest
class	ObjectsApi.APIstatObjectRequest
class	ObjectsApi.APIuploadObjectRequest

Constructor Summary

Constructors

Constructor	Description
ObjectsApi()
ObjectsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ObjectsApi.APIcopyObjectRequest	copyObject(String repository, String branch, String destPath, ObjectCopyCreation objectCopyCreation)	create a copy of an object
ObjectsApi.APIdeleteObjectRequest	deleteObject(String repository, String branch, String path)	delete object.
ObjectsApi.APIdeleteObjectsRequest	deleteObjects(String repository, String branch, PathList pathList)	delete objects.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
ObjectsApi.APIgetObjectRequest	getObject(String repository, String ref, String path)	get object content
ObjectsApi.APIgetUnderlyingPropertiesRequest	getUnderlyingProperties(String repository, String ref, String path)	get object properties on underlying storage
ObjectsApi.APIheadObjectRequest	headObject(String repository, String ref, String path)	check if object exists
ObjectsApi.APIlistObjectsRequest	listObjects(String repository, String ref)	list objects under a given prefix
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
ObjectsApi.APIstatObjectRequest	statObject(String repository, String ref, String path)	get object metadata
ObjectsApi.APIuploadObjectRequest	uploadObject(String repository, String branch, String path)

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)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

copyObject

public ObjectsApi.APIcopyObjectRequest copyObject(String repository,
                                                  String branch,
                                                  String destPath,
                                                  ObjectCopyCreation objectCopyCreation)

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:

APIcopyObjectRequest

Http Response Details:

Status Code	Description	Response Headers
201	Copy object response	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteObject

public ObjectsApi.APIdeleteObjectRequest deleteObject(String repository,
                                                      String branch,
                                                      String path)

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

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

Returns:

APIdeleteObjectRequest

Http Response Details:

Status Code	Description	Response Headers
204	object deleted successfully	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteObjects

public ObjectsApi.APIdeleteObjectsRequest deleteObjects(String repository,
                                                        String branch,
                                                        PathList pathList)

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

Parameters:

repository - (required)

branch - (required)

pathList - (required)

Returns:

APIdeleteObjectsRequest

Http Response Details:

Status Code	Description	Response Headers
200	Delete objects response	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getObject

public ObjectsApi.APIgetObjectRequest getObject(String repository,
                                                String ref,
                                                String path)

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:

APIgetObjectRequest

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	-
420	too many requests	-
0	Internal Server Error	-

getUnderlyingProperties

public ObjectsApi.APIgetUnderlyingPropertiesRequest getUnderlyingProperties(String repository,
                                                                            String ref,
                                                                            String path)

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:

APIgetUnderlyingPropertiesRequest

Http Response Details:

Status Code	Description	Response Headers
200	object metadata on underlying storage	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

headObject

public ObjectsApi.APIheadObjectRequest headObject(String repository,
                                                  String ref,
                                                  String path)

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)

Returns:

APIheadObjectRequest

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	-
420	too many requests	-
0	internal server error	-

listObjects

public ObjectsApi.APIlistObjectsRequest listObjects(String repository,
                                                    String ref)

list objects under a given prefix

Parameters:

repository - (required)

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

Returns:

APIlistObjectsRequest

Http Response Details:

Status Code	Description	Response Headers
200	object listing	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

statObject

public ObjectsApi.APIstatObjectRequest statObject(String repository,
                                                  String ref,
                                                  String path)

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)

Returns:

APIstatObjectRequest

Http Response Details:

Status Code	Description	Response Headers
200	object metadata	-
401	Unauthorized	-
404	Resource Not Found	-
400	Bad Request	-
410	object gone (but partial metadata may be available)	-
420	too many requests	-
0	Internal Server Error	-

uploadObject

public ObjectsApi.APIuploadObjectRequest uploadObject(String repository,
                                                      String branch,
                                                      String path)

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

Returns:

APIuploadObjectRequest

Http Response Details:

Status Code	Description	Response Headers
201	object metadata	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed	-
420	too many requests	-
0	Internal Server Error	-