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.APIcreateUserExternalPrincipalRequest
class	ExperimentalApi.APIdeleteUserExternalPrincipalRequest
class	ExperimentalApi.APIexternalPrincipalLoginRequest
class	ExperimentalApi.APIgetExternalPrincipalRequest
class	ExperimentalApi.APIhardResetBranchRequest
class	ExperimentalApi.APIlistUserExternalPrincipalsRequest
class	ExperimentalApi.APIstsLoginRequest

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).
ExperimentalApi.APIcreateUserExternalPrincipalRequest	createUserExternalPrincipal(String userId, String principalId)	attach external principal to user
ExperimentalApi.APIdeleteUserExternalPrincipalRequest	deleteUserExternalPrincipal(String userId, String principalId)	delete external principal from user
ExperimentalApi.APIexternalPrincipalLoginRequest	externalPrincipalLogin()	perform a login using an external authenticator
ApiClient	getApiClient()
String	getCustomBaseUrl()
ExperimentalApi.APIgetExternalPrincipalRequest	getExternalPrincipal(String principalId)	describe external principal by id
int	getHostIndex()
ExperimentalApi.APIhardResetBranchRequest	hardResetBranch(String repository, String branch, String ref)	hard reset branch Relocate branch to refer to ref.
ExperimentalApi.APIlistUserExternalPrincipalsRequest	listUserExternalPrincipals(String userId)	list user external policies attached to a user
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
ExperimentalApi.APIstsLoginRequest	stsLogin(StsAuthRequest stsAuthRequest)	perform a login with STS

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	-

createUserExternalPrincipal

public ExperimentalApi.APIcreateUserExternalPrincipalRequest createUserExternalPrincipal(String userId,
                                                                                         String principalId)

attach external principal to user

Parameters:

userId - (required)

principalId - (required)

Returns:

APIcreateUserExternalPrincipalRequest

Http Response Details:

Status Code	Description	Response Headers
201	external principal attached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

deleteUserExternalPrincipal

public ExperimentalApi.APIdeleteUserExternalPrincipalRequest deleteUserExternalPrincipal(String userId,
                                                                                         String principalId)

delete external principal from user

Parameters:

userId - (required)

principalId - (required)

Returns:

APIdeleteUserExternalPrincipalRequest

Http Response Details:

Status Code	Description	Response Headers
204	external principal detached successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

externalPrincipalLogin

public ExperimentalApi.APIexternalPrincipalLoginRequest externalPrincipalLogin()

perform a login using an external authenticator

Returns:

APIexternalPrincipalLoginRequest

Http Response Details:

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

getExternalPrincipal

public ExperimentalApi.APIgetExternalPrincipalRequest getExternalPrincipal(String principalId)

describe external principal by id

Parameters:

principalId - (required)

Returns:

APIgetExternalPrincipalRequest

Http Response Details:

Status Code	Description	Response Headers
200	external principal	-
401	Unauthorized	-
404	Resource Not Found	-
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	-

listUserExternalPrincipals

public ExperimentalApi.APIlistUserExternalPrincipalsRequest listUserExternalPrincipals(String userId)

list user external policies attached to a user

Parameters:

userId - (required)

Returns:

APIlistUserExternalPrincipalsRequest

Http Response Details:

Status Code	Description	Response Headers
200	external principals list	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

stsLogin

public ExperimentalApi.APIstsLoginRequest stsLogin(StsAuthRequest stsAuthRequest)

perform a login with STS

Parameters:

stsAuthRequest - (required)

Returns:

APIstsLoginRequest

Http Response Details:

Status Code	Description	Response Headers
200	successful STS login	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-