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)	generate an address to which the client can upload an object
okhttp3.Call	getPhysicalAddressAsync(String repository, String branch, String path, Boolean presign, ApiCallback<StagingLocation> _callback)	generate an address to which the client can upload an object (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)	generate an address to which the client can upload an object
ObjectStats	linkPhysicalAddress(String repository, String branch, String path, StagingMetadata stagingMetadata)	associate staging on this physical address with a path Link the physical address with the path in lakeFS, creating an uncommitted change.
okhttp3.Call	linkPhysicalAddressAsync(String repository, String branch, String path, StagingMetadata stagingMetadata, ApiCallback<ObjectStats> _callback)	associate staging on this physical address with a path (asynchronously) Link the physical address with the path in lakeFS, creating an uncommitted change.
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 Link the physical address with the path in lakeFS, creating an uncommitted change.
void	setApiClient(ApiClient apiClient)

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

getPhysicalAddress

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

generate an address to which the client can upload an object

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

getPhysicalAddressWithHttpInfo

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

generate an address to which the client can upload an object

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

getPhysicalAddressAsync

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

generate an address to which the client can upload an object (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	-
420	too many requests	-
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	-
420	too many requests	-
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 Link the physical address with the path in lakeFS, creating an uncommitted change. The given address can be one generated by getPhysicalAddress, or an address outside the repository's storage namespace.

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	-
420	too many requests	-
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 Link the physical address with the path in lakeFS, creating an uncommitted change. The given address can be one generated by getPhysicalAddress, or an address outside the repository's storage namespace.

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	-
420	too many requests	-
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) Link the physical address with the path in lakeFS, creating an uncommitted change. The given address can be one generated by getPhysicalAddress, or an address outside the repository's storage namespace.

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