Package io.lakefs.clients.sdk

Class ExperimentalApi

java.lang.Object

io.lakefs.clients.sdk.ExperimentalApi

public class ExperimentalApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExperimentalApi.APIabortPresignMultipartUploadRequest
class	ExperimentalApi.APIcompletePresignMultipartUploadRequest
class	ExperimentalApi.APIcreatePresignMultipartUploadRequest
class	ExperimentalApi.APIgetOtfDiffsRequest
class	ExperimentalApi.APIhardResetBranchRequest
class	ExperimentalApi.APIotfDiffRequest

Constructor Summary

Constructors

Constructor	Description
ExperimentalApi()
ExperimentalApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ExperimentalApi.APIabortPresignMultipartUploadRequest	abortPresignMultipartUpload(String repository, String branch, String uploadId, String path)	Abort a presign multipart upload Aborts a presign multipart upload.
ExperimentalApi.APIcompletePresignMultipartUploadRequest	completePresignMultipartUpload(String repository, String branch, String uploadId, String path)	Complete a presign multipart upload request Completes a presign multipart upload by assembling the uploaded parts.
ExperimentalApi.APIcreatePresignMultipartUploadRequest	createPresignMultipartUpload(String repository, String branch, String path)	Initiate a multipart upload Initiates a multipart upload and returns an upload ID with presigned URLs for each part (optional).
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
ExperimentalApi.APIgetOtfDiffsRequest	getOtfDiffs()	get the available Open Table Format diffs
ExperimentalApi.APIhardResetBranchRequest	hardResetBranch(String repository, String branch, String ref)	hard reset branch Relocate branch to refer to ref.
ExperimentalApi.APIotfDiffRequest	otfDiff(String repository, String leftRef, String rightRef, String tablePath, String type)	perform otf diff
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

ExperimentalApi

public ExperimentalApi()

ExperimentalApi

public ExperimentalApi(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)

abortPresignMultipartUpload

public ExperimentalApi.APIabortPresignMultipartUploadRequest abortPresignMultipartUpload(String repository,
                                                                                         String branch,
                                                                                         String uploadId,
                                                                                         String path)

Abort a presign multipart upload Aborts a presign multipart upload.

Parameters:

repository - (required)

branch - (required)

uploadId - (required)

path - relative to the branch (required)

Returns:

APIabortPresignMultipartUploadRequest

Http Response Details:

Status Code	Description	Response Headers
204	Presign multipart upload aborted	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

completePresignMultipartUpload

public ExperimentalApi.APIcompletePresignMultipartUploadRequest completePresignMultipartUpload(String repository,
                                                                                               String branch,
                                                                                               String uploadId,
                                                                                               String path)

Complete a presign multipart upload request Completes a presign multipart upload by assembling the uploaded parts.

Parameters:

repository - (required)

branch - (required)

uploadId - (required)

path - relative to the branch (required)

Returns:

APIcompletePresignMultipartUploadRequest

Http Response Details:

Status Code	Description	Response Headers
200	Presign multipart upload completed	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
409	conflict with a commit, try here	-
420	too many requests	-
0	Internal Server Error	-

createPresignMultipartUpload

public ExperimentalApi.APIcreatePresignMultipartUploadRequest createPresignMultipartUpload(String repository,
                                                                                           String branch,
                                                                                           String path)

Initiate a multipart upload Initiates a multipart upload and returns an upload ID with presigned URLs for each part (optional). Part numbers starts with 1. Each part except the last one has minimum size depends on the underlying blockstore implementation. For example working with S3 blockstore, minimum size is 5MB (excluding the last part).

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

Returns:

APIcreatePresignMultipartUploadRequest

Http Response Details:

Status Code	Description	Response Headers
201	Presign multipart upload initiated	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getOtfDiffs

public ExperimentalApi.APIgetOtfDiffsRequest getOtfDiffs()

get the available Open Table Format diffs

Returns:

APIgetOtfDiffsRequest

Http Response Details:

Status Code	Description	Response Headers
200	available Open Table Format diffs	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

hardResetBranch

public ExperimentalApi.APIhardResetBranchRequest hardResetBranch(String repository,
                                                                 String branch,
                                                                 String ref)

hard reset branch Relocate branch to refer to ref. Branch must not contain uncommitted data.

Parameters:

repository - (required)

branch - (required)

ref - After reset, branch will point at this reference. (required)

Returns:

APIhardResetBranchRequest

Http Response Details:

Status Code	Description	Response Headers
204	reset successful	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

otfDiff

public ExperimentalApi.APIotfDiffRequest otfDiff(String repository,
                                                 String leftRef,
                                                 String rightRef,
                                                 String tablePath,
                                                 String type)

perform otf diff

Parameters:

repository - (required)

leftRef - (required)

rightRef - (required)

tablePath - a path to the table location under the specified ref. (required)

type - the type of otf (required)

Returns:

APIotfDiffRequest

Http Response Details:

Status Code	Description	Response Headers
200	diff list	-
401	Unauthorized	-
404	Resource Not Found	-
412	Precondition Failed	-
420	too many requests	-
0	Internal Server Error	-