Package io.lakefs.clients.api

Class StagingApi

java.lang.Object

io.lakefs.clients.api.StagingApi

public class StagingApi
extends Object

Constructor Summary

Constructors

Constructor	Description
StagingApi()
StagingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
StagingLocation	getPhysicalAddress(String repository, String branch, String path, Boolean presign)	get a physical address and a return token to write object to underlying storage
okhttp3.Call	getPhysicalAddressAsync(String repository, String branch, String path, Boolean presign, ApiCallback<StagingLocation> _callback)	get a physical address and a return token to write object to underlying storage (asynchronously)
okhttp3.Call	getPhysicalAddressCall(String repository, String branch, String path, Boolean presign, ApiCallback _callback)	Build call for getPhysicalAddress
ApiResponse<StagingLocation>	getPhysicalAddressWithHttpInfo(String repository, String branch, String path, Boolean presign)	get a physical address and a return token to write object to underlying storage
ObjectStats	linkPhysicalAddress(String repository, String branch, String path, StagingMetadata stagingMetadata)	associate staging on this physical address with a path If the supplied token matches the current staging token, associate the object as the physical address with the supplied path.
okhttp3.Call	linkPhysicalAddressAsync(String repository, String branch, String path, StagingMetadata stagingMetadata, ApiCallback<ObjectStats> _callback)	associate staging on this physical address with a path (asynchronously) If the supplied token matches the current staging token, associate the object as the physical address with the supplied path.
okhttp3.Call	linkPhysicalAddressCall(String repository, String branch, String path, StagingMetadata stagingMetadata, ApiCallback _callback)	Build call for linkPhysicalAddress
ApiResponse<ObjectStats>	linkPhysicalAddressWithHttpInfo(String repository, String branch, String path, StagingMetadata stagingMetadata)	associate staging on this physical address with a path If the supplied token matches the current staging token, associate the object as the physical address with the supplied path.
void	setApiClient(ApiClient apiClient)
void	updateBranchToken(String repository, String branch, UpdateToken updateToken)	modify branch staging token
okhttp3.Call	updateBranchTokenAsync(String repository, String branch, UpdateToken updateToken, ApiCallback<Void> _callback)	modify branch staging token (asynchronously)
okhttp3.Call	updateBranchTokenCall(String repository, String branch, UpdateToken updateToken, ApiCallback _callback)	Build call for updateBranchToken
ApiResponse<Void>	updateBranchTokenWithHttpInfo(String repository, String branch, UpdateToken updateToken)	modify branch staging token

Methods inherited from class java.lang.Object

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

Constructor Detail

StagingApi

public StagingApi()

StagingApi

public StagingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getPhysicalAddressCall

public okhttp3.Call getPhysicalAddressCall(String repository,
                                           String branch,
                                           String path,
                                           Boolean presign,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getPhysicalAddress

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

presign - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	physical address for staging area	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getPhysicalAddress

public StagingLocation getPhysicalAddress(String repository,
                                          String branch,
                                          String path,
                                          Boolean presign)
                                   throws ApiException

get a physical address and a return token to write object to underlying storage

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

presign - (optional)

Returns:

StagingLocation

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	physical address for staging area	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getPhysicalAddressWithHttpInfo

public ApiResponse<StagingLocation> getPhysicalAddressWithHttpInfo(String repository,
                                                                   String branch,
                                                                   String path,
                                                                   Boolean presign)
                                                            throws ApiException

get a physical address and a return token to write object to underlying storage

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

presign - (optional)

Returns:

ApiResponse<StagingLocation>

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	physical address for staging area	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getPhysicalAddressAsync

public okhttp3.Call getPhysicalAddressAsync(String repository,
                                            String branch,
                                            String path,
                                            Boolean presign,
                                            ApiCallback<StagingLocation> _callback)
                                     throws ApiException

get a physical address and a return token to write object to underlying storage (asynchronously)

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

presign - (optional)

_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	physical address for staging area	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

linkPhysicalAddressCall

public okhttp3.Call linkPhysicalAddressCall(String repository,
                                            String branch,
                                            String path,
                                            StagingMetadata stagingMetadata,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for linkPhysicalAddress

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

stagingMetadata - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	object metadata	-
400	Validation Error	-
401	Unauthorized	-
404	Internal Server Error	-
409	conflict with a commit, try here	-
0	Internal Server Error	-

linkPhysicalAddress

public ObjectStats linkPhysicalAddress(String repository,
                                       String branch,
                                       String path,
                                       StagingMetadata stagingMetadata)
                                throws ApiException

associate staging on this physical address with a path If the supplied token matches the current staging token, associate the object as the physical address with the supplied path. Otherwise, if staging has been committed and the token has expired, return a conflict and hint where to place the object to try again. Caller should copy the object to the new physical address and PUT again with the new staging token. (No need to back off, this is due to losing the race against a concurrent commit operation.)

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

stagingMetadata - (required)

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
200	object metadata	-
400	Validation Error	-
401	Unauthorized	-
404	Internal Server Error	-
409	conflict with a commit, try here	-
0	Internal Server Error	-

linkPhysicalAddressWithHttpInfo

public ApiResponse<ObjectStats> linkPhysicalAddressWithHttpInfo(String repository,
                                                                String branch,
                                                                String path,
                                                                StagingMetadata stagingMetadata)
                                                         throws ApiException

associate staging on this physical address with a path If the supplied token matches the current staging token, associate the object as the physical address with the supplied path. Otherwise, if staging has been committed and the token has expired, return a conflict and hint where to place the object to try again. Caller should copy the object to the new physical address and PUT again with the new staging token. (No need to back off, this is due to losing the race against a concurrent commit operation.)

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

stagingMetadata - (required)

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
200	object metadata	-
400	Validation Error	-
401	Unauthorized	-
404	Internal Server Error	-
409	conflict with a commit, try here	-
0	Internal Server Error	-

linkPhysicalAddressAsync

public okhttp3.Call linkPhysicalAddressAsync(String repository,
                                             String branch,
                                             String path,
                                             StagingMetadata stagingMetadata,
                                             ApiCallback<ObjectStats> _callback)
                                      throws ApiException

associate staging on this physical address with a path (asynchronously) If the supplied token matches the current staging token, associate the object as the physical address with the supplied path. Otherwise, if staging has been committed and the token has expired, return a conflict and hint where to place the object to try again. Caller should copy the object to the new physical address and PUT again with the new staging token. (No need to back off, this is due to losing the race against a concurrent commit operation.)

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

stagingMetadata - (required)

_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 metadata	-
400	Validation Error	-
401	Unauthorized	-
404	Internal Server Error	-
409	conflict with a commit, try here	-
0	Internal Server Error	-

updateBranchTokenCall

public okhttp3.Call updateBranchTokenCall(String repository,
                                          String branch,
                                          UpdateToken updateToken,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for updateBranchToken

Parameters:

repository - (required)

branch - (required)

updateToken - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	branch updated successfully	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
0	Internal Server Error	-

updateBranchToken

public void updateBranchToken(String repository,
                              String branch,
                              UpdateToken updateToken)
                       throws ApiException

modify branch staging token

Parameters:

repository - (required)

branch - (required)

updateToken - (required)

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
204	branch updated successfully	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
0	Internal Server Error	-

updateBranchTokenWithHttpInfo

public ApiResponse<Void> updateBranchTokenWithHttpInfo(String repository,
                                                       String branch,
                                                       UpdateToken updateToken)
                                                throws ApiException

modify branch staging token

Parameters:

repository - (required)

branch - (required)

updateToken - (required)

Returns:

ApiResponse<Void>

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
204	branch updated successfully	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
0	Internal Server Error	-

updateBranchTokenAsync

public okhttp3.Call updateBranchTokenAsync(String repository,
                                           String branch,
                                           UpdateToken updateToken,
                                           ApiCallback<Void> _callback)
                                    throws ApiException

modify branch staging token (asynchronously)

Parameters:

repository - (required)

branch - (required)

updateToken - (required)

_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
204	branch updated successfully	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
0	Internal Server Error	-