Package io.lakefs.clients.sdk

Class BranchesApi

java.lang.Object

io.lakefs.clients.sdk.BranchesApi

public class BranchesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BranchesApi.APIcherryPickRequest
class	BranchesApi.APIcreateBranchRequest
class	BranchesApi.APIdeleteBranchRequest
class	BranchesApi.APIdiffBranchRequest
class	BranchesApi.APIgetBranchRequest
class	BranchesApi.APIlistBranchesRequest
class	BranchesApi.APIresetBranchRequest
class	BranchesApi.APIrevertBranchRequest

Constructor Summary

Constructors

Constructor	Description
BranchesApi()
BranchesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BranchesApi.APIcherryPickRequest	cherryPick(String repository, String branch, CherryPickCreation cherryPickCreation)	Replay the changes from the given commit on the branch
BranchesApi.APIcreateBranchRequest	createBranch(String repository, BranchCreation branchCreation)	create branch
BranchesApi.APIdeleteBranchRequest	deleteBranch(String repository, String branch)	delete branch
BranchesApi.APIdiffBranchRequest	diffBranch(String repository, String branch)	diff branch
ApiClient	getApiClient()
BranchesApi.APIgetBranchRequest	getBranch(String repository, String branch)	get branch
String	getCustomBaseUrl()
int	getHostIndex()
BranchesApi.APIlistBranchesRequest	listBranches(String repository)	list branches
BranchesApi.APIresetBranchRequest	resetBranch(String repository, String branch, ResetCreation resetCreation)	reset branch
BranchesApi.APIrevertBranchRequest	revertBranch(String repository, String branch, RevertCreation revertCreation)	revert
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

BranchesApi

public BranchesApi()

BranchesApi

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

cherryPick

public BranchesApi.APIcherryPickRequest cherryPick(String repository,
                                                   String branch,
                                                   CherryPickCreation cherryPickCreation)

Replay the changes from the given commit on the branch

Parameters:

repository - (required)

branch - (required)

cherryPickCreation - (required)

Returns:

APIcherryPickRequest

Http Response Details:

Status Code	Description	Response Headers
201	the cherry-pick commit	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
409	Conflict Found	-
420	too many requests	-
0	Internal Server Error	-

createBranch

public BranchesApi.APIcreateBranchRequest createBranch(String repository,
                                                       BranchCreation branchCreation)

create branch

Parameters:

repository - (required)

branchCreation - (required)

Returns:

APIcreateBranchRequest

Http Response Details:

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

deleteBranch

public BranchesApi.APIdeleteBranchRequest deleteBranch(String repository,
                                                       String branch)

delete branch

Parameters:

repository - (required)

branch - (required)

Returns:

APIdeleteBranchRequest

Http Response Details:

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

diffBranch

public BranchesApi.APIdiffBranchRequest diffBranch(String repository,
                                                   String branch)

diff branch

Parameters:

repository - (required)

branch - (required)

Returns:

APIdiffBranchRequest

Http Response Details:

Status Code	Description	Response Headers
200	diff of branch uncommitted changes	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

getBranch

public BranchesApi.APIgetBranchRequest getBranch(String repository,
                                                 String branch)

get branch

Parameters:

repository - (required)

branch - (required)

Returns:

APIgetBranchRequest

Http Response Details:

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

listBranches

public BranchesApi.APIlistBranchesRequest listBranches(String repository)

list branches

Parameters:

repository - (required)

Returns:

APIlistBranchesRequest

Http Response Details:

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

resetBranch

public BranchesApi.APIresetBranchRequest resetBranch(String repository,
                                                     String branch,
                                                     ResetCreation resetCreation)

reset branch

Parameters:

repository - (required)

branch - (required)

resetCreation - (required)

Returns:

APIresetBranchRequest

Http Response Details:

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

revertBranch

public BranchesApi.APIrevertBranchRequest revertBranch(String repository,
                                                       String branch,
                                                       RevertCreation revertCreation)

revert

Parameters:

repository - (required)

branch - (required)

revertCreation - (required)

Returns:

APIrevertBranchRequest

Http Response Details:

Status Code	Description	Response Headers
204	revert successful	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
409	Conflict Found	-
420	too many requests	-
0	Internal Server Error	-