Package io.lakefs.clients.sdk

Class ObjectsApi.APIgetObjectRequest

java.lang.Object

io.lakefs.clients.sdk.ObjectsApi.APIgetObjectRequest

Enclosing class:

ObjectsApi

public class ObjectsApi.APIgetObjectRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for getObject
File	execute()	Execute getObject request
okhttp3.Call	executeAsync(ApiCallback<File> _callback)	Execute getObject request (asynchronously)
ApiResponse<File>	executeWithHttpInfo()	Execute getObject request with HTTP info returned
ObjectsApi.APIgetObjectRequest	presign(Boolean presign)	Set presign
ObjectsApi.APIgetObjectRequest	range(String range)	Set range

Methods inherited from class java.lang.Object

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

Method Detail

range

public ObjectsApi.APIgetObjectRequest range(String range)

Set range

Parameters:

range - Byte range to retrieve (optional)

Returns:

APIgetObjectRequest

presign

public ObjectsApi.APIgetObjectRequest presign(Boolean presign)

Set presign

Parameters:

presign - (optional)

Returns:

APIgetObjectRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getObject

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

execute

public File execute()
             throws ApiException

Execute getObject request

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

executeWithHttpInfo

public ApiResponse<File> executeWithHttpInfo()
                                      throws ApiException

Execute getObject request with HTTP info returned

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

executeAsync

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

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