Package io.lakefs.clients.sdk

Class RepositoriesApi

java.lang.Object

io.lakefs.clients.sdk.RepositoriesApi

public class RepositoriesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RepositoriesApi.APIcreateRepositoryRequest
class	RepositoriesApi.APIdeleteGCRulesRequest
class	RepositoriesApi.APIdeleteRepositoryRequest
class	RepositoriesApi.APIdumpStatusRequest
class	RepositoriesApi.APIdumpSubmitRequest
class	RepositoriesApi.APIgetBranchProtectionRulesRequest
class	RepositoriesApi.APIgetGCRulesRequest
class	RepositoriesApi.APIgetRepositoryMetadataRequest
class	RepositoriesApi.APIgetRepositoryRequest
class	RepositoriesApi.APIlistRepositoriesRequest
class	RepositoriesApi.APIrestoreStatusRequest
class	RepositoriesApi.APIrestoreSubmitRequest
class	RepositoriesApi.APIsetBranchProtectionRulesRequest
class	RepositoriesApi.APIsetGCRulesRequest

Constructor Summary

Constructors

Constructor	Description
RepositoriesApi()
RepositoriesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
RepositoriesApi.APIcreateRepositoryRequest	createRepository(RepositoryCreation repositoryCreation)	create repository
RepositoriesApi.APIdeleteGCRulesRequest	deleteGCRules(String repository)
RepositoriesApi.APIdeleteRepositoryRequest	deleteRepository(String repository)	delete repository
RepositoriesApi.APIdumpStatusRequest	dumpStatus(String repository, String taskId)	Status of a repository dump task
RepositoriesApi.APIdumpSubmitRequest	dumpSubmit(String repository)	Backup the repository metadata (tags, commits, branches) and save the backup to the object store.
ApiClient	getApiClient()
RepositoriesApi.APIgetBranchProtectionRulesRequest	getBranchProtectionRules(String repository)	get branch protection rules
String	getCustomBaseUrl()
RepositoriesApi.APIgetGCRulesRequest	getGCRules(String repository)	get repository GC rules
int	getHostIndex()
RepositoriesApi.APIgetRepositoryRequest	getRepository(String repository)	get repository
RepositoriesApi.APIgetRepositoryMetadataRequest	getRepositoryMetadata(String repository)	get repository metadata
RepositoriesApi.APIlistRepositoriesRequest	listRepositories()	list repositories
RepositoriesApi.APIrestoreStatusRequest	restoreStatus(String repository, String taskId)	Status of a restore request
RepositoriesApi.APIrestoreSubmitRequest	restoreSubmit(String repository, RefsRestore refsRestore)	Restore repository from a dump in the object store
void	setApiClient(ApiClient apiClient)
RepositoriesApi.APIsetBranchProtectionRulesRequest	setBranchProtectionRules(String repository, List<BranchProtectionRule> branchProtectionRule)
void	setCustomBaseUrl(String customBaseUrl)
RepositoriesApi.APIsetGCRulesRequest	setGCRules(String repository, GarbageCollectionRules garbageCollectionRules)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoriesApi

public RepositoriesApi()

RepositoriesApi

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

createRepository

public RepositoriesApi.APIcreateRepositoryRequest createRepository(RepositoryCreation repositoryCreation)

create repository

Parameters:

repositoryCreation - (required)

Returns:

APIcreateRepositoryRequest

Http Response Details:

Status Code	Description	Response Headers
201	repository	-
400	Validation Error	-
401	Unauthorized	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

deleteGCRules

public RepositoriesApi.APIdeleteGCRulesRequest deleteGCRules(String repository)

Parameters:

repository - (required)

Returns:

APIdeleteGCRulesRequest

Http Response Details:

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

deleteRepository

public RepositoriesApi.APIdeleteRepositoryRequest deleteRepository(String repository)

delete repository

Parameters:

repository - (required)

Returns:

APIdeleteRepositoryRequest

Http Response Details:

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

dumpStatus

public RepositoriesApi.APIdumpStatusRequest dumpStatus(String repository,
                                                       String taskId)

Status of a repository dump task

Parameters:

repository - (required)

taskId - (required)

Returns:

APIdumpStatusRequest

Http Response Details:

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

dumpSubmit

public RepositoriesApi.APIdumpSubmitRequest dumpSubmit(String repository)

Backup the repository metadata (tags, commits, branches) and save the backup to the object store.

Parameters:

repository - (required)

Returns:

APIdumpSubmitRequest

Http Response Details:

Status Code	Description	Response Headers
202	dump task information	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getBranchProtectionRules

public RepositoriesApi.APIgetBranchProtectionRulesRequest getBranchProtectionRules(String repository)

get branch protection rules

Parameters:

repository - (required)

Returns:

APIgetBranchProtectionRulesRequest

Http Response Details:

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

getGCRules

public RepositoriesApi.APIgetGCRulesRequest getGCRules(String repository)

get repository GC rules

Parameters:

repository - (required)

Returns:

APIgetGCRulesRequest

Http Response Details:

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

getRepository

public RepositoriesApi.APIgetRepositoryRequest getRepository(String repository)

get repository

Parameters:

repository - (required)

Returns:

APIgetRepositoryRequest

Http Response Details:

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

getRepositoryMetadata

public RepositoriesApi.APIgetRepositoryMetadataRequest getRepositoryMetadata(String repository)

get repository metadata

Parameters:

repository - (required)

Returns:

APIgetRepositoryMetadataRequest

Http Response Details:

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

listRepositories

public RepositoriesApi.APIlistRepositoriesRequest listRepositories()

list repositories

Returns:

APIlistRepositoriesRequest

Http Response Details:

Status Code	Description	Response Headers
200	repository list	-
401	Unauthorized	-
420	too many requests	-
0	Internal Server Error	-

restoreStatus

public RepositoriesApi.APIrestoreStatusRequest restoreStatus(String repository,
                                                             String taskId)

Status of a restore request

Parameters:

repository - (required)

taskId - (required)

Returns:

APIrestoreStatusRequest

Http Response Details:

Status Code	Description	Response Headers
200	restore task status	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

restoreSubmit

public RepositoriesApi.APIrestoreSubmitRequest restoreSubmit(String repository,
                                                             RefsRestore refsRestore)

Restore repository from a dump in the object store

Parameters:

repository - (required)

refsRestore - (required)

Returns:

APIrestoreSubmitRequest

Http Response Details:

Status Code	Description	Response Headers
202	restore task created	-
400	Validation Error	-
403	Forbidden	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

setBranchProtectionRules

public RepositoriesApi.APIsetBranchProtectionRulesRequest setBranchProtectionRules(String repository,
                                                                                   List<BranchProtectionRule> branchProtectionRule)

Parameters:

repository - (required)

branchProtectionRule - (required)

Returns:

APIsetBranchProtectionRulesRequest

Http Response Details:

Status Code	Description	Response Headers
204	branch protection rule created successfully	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed	-
420	too many requests	-
0	Internal Server Error	-

setGCRules

public RepositoriesApi.APIsetGCRulesRequest setGCRules(String repository,
                                                       GarbageCollectionRules garbageCollectionRules)

Parameters:

repository - (required)

garbageCollectionRules - (required)

Returns:

APIsetGCRulesRequest

Http Response Details:

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