Package io.lakefs.clients.sdk

Class ObjectsApi.APIdeleteObjectsRequest

java.lang.Object

io.lakefs.clients.sdk.ObjectsApi.APIdeleteObjectsRequest

Enclosing class:

ObjectsApi

public class ObjectsApi.APIdeleteObjectsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for deleteObjects
ObjectErrorList	execute()	Execute deleteObjects request
okhttp3.Call	executeAsync(ApiCallback<ObjectErrorList> _callback)	Execute deleteObjects request (asynchronously)
ApiResponse<ObjectErrorList>	executeWithHttpInfo()	Execute deleteObjects request with HTTP info returned
ObjectsApi.APIdeleteObjectsRequest	force(Boolean force)	Set force

Methods inherited from class java.lang.Object

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

Method Detail

force

public ObjectsApi.APIdeleteObjectsRequest force(Boolean force)

Set force

Parameters:

force - (optional, default to false)

Returns:

APIdeleteObjectsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for deleteObjects

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	Delete objects response	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

execute

public ObjectErrorList execute()
                        throws ApiException

Execute deleteObjects request

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	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

executeWithHttpInfo

public ApiResponse<ObjectErrorList> executeWithHttpInfo()
                                                 throws ApiException

Execute deleteObjects request with HTTP info returned

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	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

executeAsync

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

Execute deleteObjects 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	Delete objects response	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-