Package io.lakefs.clients.sdk

Class ObjectsApi.APIuploadObjectRequest

java.lang.Object

io.lakefs.clients.sdk.ObjectsApi.APIuploadObjectRequest

Enclosing class:

ObjectsApi

public class ObjectsApi.APIuploadObjectRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for uploadObject
ObjectsApi.APIuploadObjectRequest	content(File content)	Set content
ObjectStats	execute()	Execute uploadObject request
okhttp3.Call	executeAsync(ApiCallback<ObjectStats> _callback)	Execute uploadObject request (asynchronously)
ApiResponse<ObjectStats>	executeWithHttpInfo()	Execute uploadObject request with HTTP info returned
ObjectsApi.APIuploadObjectRequest	force(Boolean force)	Set force
ObjectsApi.APIuploadObjectRequest	ifNoneMatch(String ifNoneMatch)	Set ifNoneMatch
ObjectsApi.APIuploadObjectRequest	storageClass(String storageClass)	Set storageClass

Methods inherited from class java.lang.Object

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

Method Detail

storageClass

public ObjectsApi.APIuploadObjectRequest storageClass(String storageClass)

Set storageClass

Parameters:

storageClass - Deprecated, this capability will not be supported in future releases. (optional)

Returns:

APIuploadObjectRequest

ifNoneMatch

public ObjectsApi.APIuploadObjectRequest ifNoneMatch(String ifNoneMatch)

Set ifNoneMatch

Parameters:

ifNoneMatch - Currently supports only \"*\" to allow uploading an object only if one doesn't exist yet. Deprecated, this capability will not be supported in future releases. (optional)

Returns:

APIuploadObjectRequest

force

public ObjectsApi.APIuploadObjectRequest force(Boolean force)

Set force

Parameters:

force - (optional, default to false)

Returns:

APIuploadObjectRequest

content

public ObjectsApi.APIuploadObjectRequest content(File content)

Set content

Parameters:

content - Only a single file per upload which must be named \\\"content\\\". (optional)

Returns:

APIuploadObjectRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for uploadObject

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

execute

public ObjectStats execute()
                    throws ApiException

Execute uploadObject request

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

executeWithHttpInfo

public ApiResponse<ObjectStats> executeWithHttpInfo()
                                             throws ApiException

Execute uploadObject request with HTTP info returned

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

executeAsync

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

Execute uploadObject 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
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	-