Package io.lakefs.clients.sdk

Class StagingApi

java.lang.Object

io.lakefs.clients.sdk.StagingApi

public class StagingApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StagingApi.APIgetPhysicalAddressRequest
class	StagingApi.APIlinkPhysicalAddressRequest

Constructor Summary

Constructors

Constructor	Description
StagingApi()
StagingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
StagingApi.APIgetPhysicalAddressRequest	getPhysicalAddress(String repository, String branch, String path)	generate an address to which the client can upload an object
StagingApi.APIlinkPhysicalAddressRequest	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.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

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)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getPhysicalAddress

public StagingApi.APIgetPhysicalAddressRequest getPhysicalAddress(String repository,
                                                                  String branch,
                                                                  String path)

generate an address to which the client can upload an object

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

Returns:

APIgetPhysicalAddressRequest

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	-

linkPhysicalAddress

public StagingApi.APIlinkPhysicalAddressRequest 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. 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:

APIlinkPhysicalAddressRequest

Http Response Details:

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