Package io.lakefs.clients.sdk

Class InternalApi

java.lang.Object

io.lakefs.clients.sdk.InternalApi

public class InternalApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	InternalApi.APIcreateBranchProtectionRulePreflightRequest
class	InternalApi.APIcreateCommitRecordRequest
class	InternalApi.APIcreateSymlinkFileRequest
class	InternalApi.APIdeleteRepositoryMetadataRequest
class	InternalApi.APIdumpRefsRequest
class	InternalApi.APIgetAuthCapabilitiesRequest
class	InternalApi.APIgetGarbageCollectionConfigRequest
class	InternalApi.APIgetLakeFSVersionRequest
class	InternalApi.APIgetSetupStateRequest
class	InternalApi.APIgetStorageConfigRequest
class	InternalApi.APIgetUsageReportSummaryRequest
class	InternalApi.APIinternalCreateBranchProtectionRuleRequest
class	InternalApi.APIinternalDeleteBranchProtectionRuleRequest
class	InternalApi.APIinternalDeleteGarbageCollectionRulesRequest
class	InternalApi.APIinternalGetBranchProtectionRulesRequest
class	InternalApi.APIinternalGetGarbageCollectionRulesRequest
class	InternalApi.APIinternalSetGarbageCollectionRulesRequest
class	InternalApi.APIpostStatsEventsRequest
class	InternalApi.APIprepareGarbageCollectionCommitsRequest
class	InternalApi.APIprepareGarbageCollectionUncommittedRequest
class	InternalApi.APIrestoreRefsRequest
class	InternalApi.APIsetGarbageCollectionRulesPreflightRequest
class	InternalApi.APIsetRepositoryMetadataRequest
class	InternalApi.APIsetupCommPrefsRequest
class	InternalApi.APIsetupRequest
class	InternalApi.APIstageObjectRequest
class	InternalApi.APIuploadObjectPreflightRequest

Constructor Summary

Constructors

Constructor	Description
InternalApi()
InternalApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
InternalApi.APIcreateBranchProtectionRulePreflightRequest	createBranchProtectionRulePreflight(String repository)
InternalApi.APIcreateCommitRecordRequest	createCommitRecord(String repository, CommitRecordCreation commitRecordCreation)	create commit record
InternalApi.APIcreateSymlinkFileRequest	createSymlinkFile(String repository, String branch)	creates symlink files corresponding to the given directory
InternalApi.APIdeleteRepositoryMetadataRequest	deleteRepositoryMetadata(String repository, RepositoryMetadataKeys repositoryMetadataKeys)	delete repository metadata Delete specified keys from the repository's metadata.
InternalApi.APIdumpRefsRequest	dumpRefs(String repository)	Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations
ApiClient	getApiClient()
InternalApi.APIgetAuthCapabilitiesRequest	getAuthCapabilities()	list authentication capabilities supported
String	getCustomBaseUrl()
InternalApi.APIgetGarbageCollectionConfigRequest	getGarbageCollectionConfig()	get information of gc settings
int	getHostIndex()
InternalApi.APIgetLakeFSVersionRequest	getLakeFSVersion()	Deprecated.
InternalApi.APIgetSetupStateRequest	getSetupState()	check if the lakeFS installation is already set up
InternalApi.APIgetStorageConfigRequest	getStorageConfig()	Deprecated.
InternalApi.APIgetUsageReportSummaryRequest	getUsageReportSummary()	get usage report summary
InternalApi.APIinternalCreateBranchProtectionRuleRequest	internalCreateBranchProtectionRule(String repository, BranchProtectionRule branchProtectionRule)	Deprecated.
InternalApi.APIinternalDeleteBranchProtectionRuleRequest	internalDeleteBranchProtectionRule(String repository, InternalDeleteBranchProtectionRuleRequest internalDeleteBranchProtectionRuleRequest)	Deprecated.
InternalApi.APIinternalDeleteGarbageCollectionRulesRequest	internalDeleteGarbageCollectionRules(String repository)	Deprecated.
InternalApi.APIinternalGetBranchProtectionRulesRequest	internalGetBranchProtectionRules(String repository)	Deprecated.
InternalApi.APIinternalGetGarbageCollectionRulesRequest	internalGetGarbageCollectionRules(String repository)	Deprecated.
InternalApi.APIinternalSetGarbageCollectionRulesRequest	internalSetGarbageCollectionRules(String repository, GarbageCollectionRules garbageCollectionRules)	Deprecated.
InternalApi.APIpostStatsEventsRequest	postStatsEvents(StatsEventsList statsEventsList)	post stats events, this endpoint is meant for internal use only
InternalApi.APIprepareGarbageCollectionCommitsRequest	prepareGarbageCollectionCommits(String repository)	save lists of active commits for garbage collection
InternalApi.APIprepareGarbageCollectionUncommittedRequest	prepareGarbageCollectionUncommitted(String repository)	save repository uncommitted metadata for garbage collection
InternalApi.APIrestoreRefsRequest	restoreRefs(String repository, RefsRestore refsRestore)	Restore repository refs (tags, commits, branches) from object store.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
InternalApi.APIsetGarbageCollectionRulesPreflightRequest	setGarbageCollectionRulesPreflight(String repository)
void	setHostIndex(int hostIndex)
InternalApi.APIsetRepositoryMetadataRequest	setRepositoryMetadata(String repository, RepositoryMetadataSet repositoryMetadataSet)	set repository metadata Set repository metadata.
InternalApi.APIsetupRequest	setup(Setup setup)	setup lakeFS and create a first user
InternalApi.APIsetupCommPrefsRequest	setupCommPrefs(CommPrefsInput commPrefsInput)	setup communications preferences
InternalApi.APIstageObjectRequest	stageObject(String repository, String branch, String path, ObjectStageCreation objectStageCreation)	Deprecated.
InternalApi.APIuploadObjectPreflightRequest	uploadObjectPreflight(String repository, String branch, String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalApi

public InternalApi()

InternalApi

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

createBranchProtectionRulePreflight

public InternalApi.APIcreateBranchProtectionRulePreflightRequest createBranchProtectionRulePreflight(String repository)

Parameters:

repository - (required)

Returns:

APIcreateBranchProtectionRulePreflightRequest

Http Response Details:

Status Code	Description	Response Headers
204	User has permissions to create a branch protection rule in this repository	-
401	Unauthorized	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

createCommitRecord

public InternalApi.APIcreateCommitRecordRequest createCommitRecord(String repository,
                                                                   CommitRecordCreation commitRecordCreation)

create commit record

Parameters:

repository - (required)

commitRecordCreation - (required)

Returns:

APIcreateCommitRecordRequest

Http Response Details:

Status Code	Description	Response Headers
204	commit record created	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

createSymlinkFile

public InternalApi.APIcreateSymlinkFileRequest createSymlinkFile(String repository,
                                                                 String branch)

creates symlink files corresponding to the given directory

Parameters:

repository - (required)

branch - (required)

Returns:

APIcreateSymlinkFileRequest

Http Response Details:

Status Code	Description	Response Headers
201	location created	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

deleteRepositoryMetadata

public InternalApi.APIdeleteRepositoryMetadataRequest deleteRepositoryMetadata(String repository,
                                                                               RepositoryMetadataKeys repositoryMetadataKeys)

delete repository metadata Delete specified keys from the repository's metadata.

Parameters:

repository - (required)

repositoryMetadataKeys - (required)

Returns:

APIdeleteRepositoryMetadataRequest

Http Response Details:

Status Code	Description	Response Headers
204	repository metadata keys deleted successfully	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

dumpRefs

public InternalApi.APIdumpRefsRequest dumpRefs(String repository)

Dump repository refs (tags, commits, branches) to object store Deprecated: a new API will introduce long running operations

Parameters:

repository - (required)

Returns:

APIdumpRefsRequest

Http Response Details:

Status Code	Description	Response Headers
201	refs dump	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getAuthCapabilities

public InternalApi.APIgetAuthCapabilitiesRequest getAuthCapabilities()

list authentication capabilities supported

Returns:

APIgetAuthCapabilitiesRequest

Http Response Details:

Status Code	Description	Response Headers
200	auth capabilities	-
420	too many requests	-
0	Internal Server Error	-

getGarbageCollectionConfig

public InternalApi.APIgetGarbageCollectionConfigRequest getGarbageCollectionConfig()

get information of gc settings

Returns:

APIgetGarbageCollectionConfigRequest

Http Response Details:

Status Code	Description	Response Headers
200	lakeFS garbage collection config	-
401	Unauthorized	-

getLakeFSVersion

@Deprecated
public InternalApi.APIgetLakeFSVersionRequest getLakeFSVersion()

Deprecated.

get version of lakeFS server

Returns:

APIgetLakeFSVersionRequest

Http Response Details:

Status Code	Description	Response Headers
200	lakeFS version	-
401	Unauthorized	-

getSetupState

public InternalApi.APIgetSetupStateRequest getSetupState()

check if the lakeFS installation is already set up

Returns:

APIgetSetupStateRequest

Http Response Details:

Status Code	Description	Response Headers
200	lakeFS setup state	-
420	too many requests	-
0	Internal Server Error	-

getStorageConfig

@Deprecated
public InternalApi.APIgetStorageConfigRequest getStorageConfig()

Deprecated.

retrieve lakeFS storage configuration

Returns:

APIgetStorageConfigRequest

Http Response Details:

Status Code	Description	Response Headers
200	lakeFS storage configuration	-
401	Unauthorized	-

getUsageReportSummary

public InternalApi.APIgetUsageReportSummaryRequest getUsageReportSummary()

get usage report summary

Returns:

APIgetUsageReportSummaryRequest

Http Response Details:

Status Code	Description	Response Headers
200	Usage report	-
400	Bad Request	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

internalCreateBranchProtectionRule

@Deprecated
public InternalApi.APIinternalCreateBranchProtectionRuleRequest internalCreateBranchProtectionRule(String repository,
                                                                                                   BranchProtectionRule branchProtectionRule)

Deprecated.

Parameters:

repository - (required)

branchProtectionRule - (required)

Returns:

APIinternalCreateBranchProtectionRuleRequest

Http Response Details:

Status Code	Description	Response Headers
204	branch protection rule created successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

internalDeleteBranchProtectionRule

@Deprecated
public InternalApi.APIinternalDeleteBranchProtectionRuleRequest internalDeleteBranchProtectionRule(String repository,
                                                                                                   InternalDeleteBranchProtectionRuleRequest internalDeleteBranchProtectionRuleRequest)

Deprecated.

Parameters:

repository - (required)

internalDeleteBranchProtectionRuleRequest - (required)

Returns:

APIinternalDeleteBranchProtectionRuleRequest

Http Response Details:

Status Code	Description	Response Headers
204	branch protection rule deleted successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

internalDeleteGarbageCollectionRules

@Deprecated
public InternalApi.APIinternalDeleteGarbageCollectionRulesRequest internalDeleteGarbageCollectionRules(String repository)

Deprecated.

Parameters:

repository - (required)

Returns:

APIinternalDeleteGarbageCollectionRulesRequest

Http Response Details:

Status Code	Description	Response Headers
204	deleted garbage collection rules successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

internalGetBranchProtectionRules

@Deprecated
public InternalApi.APIinternalGetBranchProtectionRulesRequest internalGetBranchProtectionRules(String repository)

Deprecated.

get branch protection rules

Parameters:

repository - (required)

Returns:

APIinternalGetBranchProtectionRulesRequest

Http Response Details:

Status Code	Description	Response Headers
200	branch protection rules	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

internalGetGarbageCollectionRules

@Deprecated
public InternalApi.APIinternalGetGarbageCollectionRulesRequest internalGetGarbageCollectionRules(String repository)

Deprecated.

Parameters:

repository - (required)

Returns:

APIinternalGetGarbageCollectionRulesRequest

Http Response Details:

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

internalSetGarbageCollectionRules

@Deprecated
public InternalApi.APIinternalSetGarbageCollectionRulesRequest internalSetGarbageCollectionRules(String repository,
                                                                                                 GarbageCollectionRules garbageCollectionRules)

Deprecated.

Parameters:

repository - (required)

garbageCollectionRules - (required)

Returns:

APIinternalSetGarbageCollectionRulesRequest

Http Response Details:

Status Code	Description	Response Headers
204	set garbage collection rules successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

postStatsEvents

public InternalApi.APIpostStatsEventsRequest postStatsEvents(StatsEventsList statsEventsList)

post stats events, this endpoint is meant for internal use only

Parameters:

statsEventsList - (required)

Returns:

APIpostStatsEventsRequest

Http Response Details:

Status Code	Description	Response Headers
204	reported successfully	-
400	Bad Request	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

prepareGarbageCollectionCommits

public InternalApi.APIprepareGarbageCollectionCommitsRequest prepareGarbageCollectionCommits(String repository)

save lists of active commits for garbage collection

Parameters:

repository - (required)

Returns:

APIprepareGarbageCollectionCommitsRequest

Http Response Details:

Status Code	Description	Response Headers
201	paths to commit dataset	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

prepareGarbageCollectionUncommitted

public InternalApi.APIprepareGarbageCollectionUncommittedRequest prepareGarbageCollectionUncommitted(String repository)

save repository uncommitted metadata for garbage collection

Parameters:

repository - (required)

Returns:

APIprepareGarbageCollectionUncommittedRequest

Http Response Details:

Status Code	Description	Response Headers
201	paths to commit dataset	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

restoreRefs

public InternalApi.APIrestoreRefsRequest restoreRefs(String repository,
                                                     RefsRestore refsRestore)

Restore repository refs (tags, commits, branches) from object store. Deprecated: a new API will introduce long running operations

Parameters:

repository - (required)

refsRestore - (required)

Returns:

APIrestoreRefsRequest

Http Response Details:

Status Code	Description	Response Headers
200	refs successfully loaded	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

setGarbageCollectionRulesPreflight

public InternalApi.APIsetGarbageCollectionRulesPreflightRequest setGarbageCollectionRulesPreflight(String repository)

Parameters:

repository - (required)

Returns:

APIsetGarbageCollectionRulesPreflightRequest

Http Response Details:

Status Code	Description	Response Headers
204	User has permissions to set garbage collection rules on this repository	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

setRepositoryMetadata

public InternalApi.APIsetRepositoryMetadataRequest setRepositoryMetadata(String repository,
                                                                         RepositoryMetadataSet repositoryMetadataSet)

set repository metadata Set repository metadata. This will only add or update the provided keys, and will not remove any existing keys.

Parameters:

repository - (required)

repositoryMetadataSet - (required)

Returns:

APIsetRepositoryMetadataRequest

Http Response Details:

Status Code	Description	Response Headers
204	repository metadata set successfully	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

setup

public InternalApi.APIsetupRequest setup(Setup setup)

setup lakeFS and create a first user

Parameters:

setup - (required)

Returns:

APIsetupRequest

Http Response Details:

Status Code	Description	Response Headers
200	user created successfully	-
400	Bad Request	-
409	setup was already called	-
420	too many requests	-
0	Internal Server Error	-

setupCommPrefs

public InternalApi.APIsetupCommPrefsRequest setupCommPrefs(CommPrefsInput commPrefsInput)

setup communications preferences

Parameters:

commPrefsInput - (required)

Returns:

APIsetupCommPrefsRequest

Http Response Details:

Status Code	Description	Response Headers
200	communication preferences saved successfully	-
409	setup was already completed	-
412	wrong setup state for this operation	-
420	too many requests	-
0	Internal Server Error	-

stageObject

@Deprecated
public InternalApi.APIstageObjectRequest stageObject(String repository,
                                                     String branch,
                                                     String path,
                                                     ObjectStageCreation objectStageCreation)

Deprecated.

stage an object's metadata for the given branch

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

objectStageCreation - (required)

Returns:

APIstageObjectRequest

Http Response Details:

Status Code	Description	Response Headers
201	object metadata	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

uploadObjectPreflight

public InternalApi.APIuploadObjectPreflightRequest uploadObjectPreflight(String repository,
                                                                         String branch,
                                                                         String path)

Parameters:

repository - (required)

branch - (required)

path - relative to the branch (required)

Returns:

APIuploadObjectPreflightRequest

Http Response Details:

Status Code	Description	Response Headers
204	User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-