Package io.lakefs.clients.sdk

Class ObjectsApi.APIlistObjectsRequest

java.lang.Object

io.lakefs.clients.sdk.ObjectsApi.APIlistObjectsRequest

Enclosing class:

ObjectsApi

public class ObjectsApi.APIlistObjectsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
ObjectsApi.APIlistObjectsRequest	after(String after)	Set after
ObjectsApi.APIlistObjectsRequest	amount(Integer amount)	Set amount
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listObjects
ObjectsApi.APIlistObjectsRequest	delimiter(String delimiter)	Set delimiter
ObjectStatsList	execute()	Execute listObjects request
okhttp3.Call	executeAsync(ApiCallback<ObjectStatsList> _callback)	Execute listObjects request (asynchronously)
ApiResponse<ObjectStatsList>	executeWithHttpInfo()	Execute listObjects request with HTTP info returned
ObjectsApi.APIlistObjectsRequest	prefix(String prefix)	Set prefix
ObjectsApi.APIlistObjectsRequest	presign(Boolean presign)	Set presign
ObjectsApi.APIlistObjectsRequest	userMetadata(Boolean userMetadata)	Set userMetadata

Methods inherited from class java.lang.Object

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

Method Detail

userMetadata

public ObjectsApi.APIlistObjectsRequest userMetadata(Boolean userMetadata)

Set userMetadata

Parameters:

userMetadata - (optional, default to true)

Returns:

APIlistObjectsRequest

presign

public ObjectsApi.APIlistObjectsRequest presign(Boolean presign)

Set presign

Parameters:

presign - (optional)

Returns:

APIlistObjectsRequest

after

public ObjectsApi.APIlistObjectsRequest after(String after)

Set after

Parameters:

after - return items after this value (optional)

Returns:

APIlistObjectsRequest

amount

public ObjectsApi.APIlistObjectsRequest amount(Integer amount)

Set amount

Parameters:

amount - how many items to return (optional, default to 100)

Returns:

APIlistObjectsRequest

delimiter

public ObjectsApi.APIlistObjectsRequest delimiter(String delimiter)

Set delimiter

Parameters:

delimiter - delimiter used to group common prefixes by (optional)

Returns:

APIlistObjectsRequest

prefix

public ObjectsApi.APIlistObjectsRequest prefix(String prefix)

Set prefix

Parameters:

prefix - return items prefixed with this value (optional)

Returns:

APIlistObjectsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listObjects

Parameters:

_callback - ApiCallback API callback

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

execute

public ObjectStatsList execute()
                        throws ApiException

Execute listObjects request

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

executeWithHttpInfo

public ApiResponse<ObjectStatsList> executeWithHttpInfo()
                                                 throws ApiException

Execute listObjects request with HTTP info returned

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

executeAsync

public okhttp3.Call executeAsync(ApiCallback<ObjectStatsList> _callback)
                          throws ApiException

Execute listObjects request (asynchronously)

Parameters:

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