Package io.lakefs.clients.api

Class BranchesApi

java.lang.Object

io.lakefs.clients.api.BranchesApi

public class BranchesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
BranchesApi()
BranchesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Commit	cherryPick(String repository, String branch, CherryPickCreation cherryPickCreation)	Replay the changes from the given commit on the branch
okhttp3.Call	cherryPickAsync(String repository, String branch, CherryPickCreation cherryPickCreation, ApiCallback<Commit> _callback)	Replay the changes from the given commit on the branch (asynchronously)
okhttp3.Call	cherryPickCall(String repository, String branch, CherryPickCreation cherryPickCreation, ApiCallback _callback)	Build call for cherryPick
ApiResponse<Commit>	cherryPickWithHttpInfo(String repository, String branch, CherryPickCreation cherryPickCreation)	Replay the changes from the given commit on the branch
String	createBranch(String repository, BranchCreation branchCreation)	create branch
okhttp3.Call	createBranchAsync(String repository, BranchCreation branchCreation, ApiCallback<String> _callback)	create branch (asynchronously)
okhttp3.Call	createBranchCall(String repository, BranchCreation branchCreation, ApiCallback _callback)	Build call for createBranch
ApiResponse<String>	createBranchWithHttpInfo(String repository, BranchCreation branchCreation)	create branch
void	deleteBranch(String repository, String branch)	delete branch
okhttp3.Call	deleteBranchAsync(String repository, String branch, ApiCallback<Void> _callback)	delete branch (asynchronously)
okhttp3.Call	deleteBranchCall(String repository, String branch, ApiCallback _callback)	Build call for deleteBranch
ApiResponse<Void>	deleteBranchWithHttpInfo(String repository, String branch)	delete branch
DiffList	diffBranch(String repository, String branch, String after, Integer amount, String prefix, String delimiter)	diff branch
okhttp3.Call	diffBranchAsync(String repository, String branch, String after, Integer amount, String prefix, String delimiter, ApiCallback<DiffList> _callback)	diff branch (asynchronously)
okhttp3.Call	diffBranchCall(String repository, String branch, String after, Integer amount, String prefix, String delimiter, ApiCallback _callback)	Build call for diffBranch
ApiResponse<DiffList>	diffBranchWithHttpInfo(String repository, String branch, String after, Integer amount, String prefix, String delimiter)	diff branch
ApiClient	getApiClient()
Ref	getBranch(String repository, String branch)	get branch
okhttp3.Call	getBranchAsync(String repository, String branch, ApiCallback<Ref> _callback)	get branch (asynchronously)
okhttp3.Call	getBranchCall(String repository, String branch, ApiCallback _callback)	Build call for getBranch
ApiResponse<Ref>	getBranchWithHttpInfo(String repository, String branch)	get branch
RefList	listBranches(String repository, String prefix, String after, Integer amount)	list branches
okhttp3.Call	listBranchesAsync(String repository, String prefix, String after, Integer amount, ApiCallback<RefList> _callback)	list branches (asynchronously)
okhttp3.Call	listBranchesCall(String repository, String prefix, String after, Integer amount, ApiCallback _callback)	Build call for listBranches
ApiResponse<RefList>	listBranchesWithHttpInfo(String repository, String prefix, String after, Integer amount)	list branches
void	resetBranch(String repository, String branch, ResetCreation resetCreation)	reset branch
okhttp3.Call	resetBranchAsync(String repository, String branch, ResetCreation resetCreation, ApiCallback<Void> _callback)	reset branch (asynchronously)
okhttp3.Call	resetBranchCall(String repository, String branch, ResetCreation resetCreation, ApiCallback _callback)	Build call for resetBranch
ApiResponse<Void>	resetBranchWithHttpInfo(String repository, String branch, ResetCreation resetCreation)	reset branch
void	revertBranch(String repository, String branch, RevertCreation revertCreation)	revert
okhttp3.Call	revertBranchAsync(String repository, String branch, RevertCreation revertCreation, ApiCallback<Void> _callback)	revert (asynchronously)
okhttp3.Call	revertBranchCall(String repository, String branch, RevertCreation revertCreation, ApiCallback _callback)	Build call for revertBranch
ApiResponse<Void>	revertBranchWithHttpInfo(String repository, String branch, RevertCreation revertCreation)	revert
void	setApiClient(ApiClient apiClient)

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)

cherryPickCall

public okhttp3.Call cherryPickCall(String repository,
                                   String branch,
                                   CherryPickCreation cherryPickCreation,
                                   ApiCallback _callback)
                            throws ApiException

Build call for cherryPick

Parameters:

repository - (required)

branch - (required)

cherryPickCreation - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

cherryPick

public Commit cherryPick(String repository,
                         String branch,
                         CherryPickCreation cherryPickCreation)
                  throws ApiException

Replay the changes from the given commit on the branch

Parameters:

repository - (required)

branch - (required)

cherryPickCreation - (required)

Returns:

Commit

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

cherryPickWithHttpInfo

public ApiResponse<Commit> cherryPickWithHttpInfo(String repository,
                                                  String branch,
                                                  CherryPickCreation cherryPickCreation)
                                           throws ApiException

Replay the changes from the given commit on the branch

Parameters:

repository - (required)

branch - (required)

cherryPickCreation - (required)

Returns:

ApiResponse<Commit>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

cherryPickAsync

public okhttp3.Call cherryPickAsync(String repository,
                                    String branch,
                                    CherryPickCreation cherryPickCreation,
                                    ApiCallback<Commit> _callback)
                             throws ApiException

Replay the changes from the given commit on the branch (asynchronously)

Parameters:

repository - (required)

branch - (required)

cherryPickCreation - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-

createBranchCall

public okhttp3.Call createBranchCall(String repository,
                                     BranchCreation branchCreation,
                                     ApiCallback _callback)
                              throws ApiException

Build call for createBranch

Parameters:

repository - (required)

branchCreation - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

createBranch

public String createBranch(String repository,
                           BranchCreation branchCreation)
                    throws ApiException

create branch

Parameters:

repository - (required)

branchCreation - (required)

Returns:

String

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

createBranchWithHttpInfo

public ApiResponse<String> createBranchWithHttpInfo(String repository,
                                                    BranchCreation branchCreation)
                                             throws ApiException

create branch

Parameters:

repository - (required)

branchCreation - (required)

Returns:

ApiResponse<String>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

createBranchAsync

public okhttp3.Call createBranchAsync(String repository,
                                      BranchCreation branchCreation,
                                      ApiCallback<String> _callback)
                               throws ApiException

create branch (asynchronously)

Parameters:

repository - (required)

branchCreation - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-

deleteBranchCall

public okhttp3.Call deleteBranchCall(String repository,
                                     String branch,
                                     ApiCallback _callback)
                              throws ApiException

Build call for deleteBranch

Parameters:

repository - (required)

branch - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

deleteBranch

public void deleteBranch(String repository,
                         String branch)
                  throws ApiException

delete branch

Parameters:

repository - (required)

branch - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

deleteBranchWithHttpInfo

public ApiResponse<Void> deleteBranchWithHttpInfo(String repository,
                                                  String branch)
                                           throws ApiException

delete branch

Parameters:

repository - (required)

branch - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

deleteBranchAsync

public okhttp3.Call deleteBranchAsync(String repository,
                                      String branch,
                                      ApiCallback<Void> _callback)
                               throws ApiException

delete branch (asynchronously)

Parameters:

repository - (required)

branch - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-

diffBranchCall

public okhttp3.Call diffBranchCall(String repository,
                                   String branch,
                                   String after,
                                   Integer amount,
                                   String prefix,
                                   String delimiter,
                                   ApiCallback _callback)
                            throws ApiException

Build call for diffBranch

Parameters:

repository - (required)

branch - (required)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

prefix - return items prefixed with this value (optional)

delimiter - delimiter used to group common prefixes by (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

diffBranch

public DiffList diffBranch(String repository,
                           String branch,
                           String after,
                           Integer amount,
                           String prefix,
                           String delimiter)
                    throws ApiException

diff branch

Parameters:

repository - (required)

branch - (required)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

prefix - return items prefixed with this value (optional)

delimiter - delimiter used to group common prefixes by (optional)

Returns:

DiffList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

diffBranchWithHttpInfo

public ApiResponse<DiffList> diffBranchWithHttpInfo(String repository,
                                                    String branch,
                                                    String after,
                                                    Integer amount,
                                                    String prefix,
                                                    String delimiter)
                                             throws ApiException

diff branch

Parameters:

repository - (required)

branch - (required)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

prefix - return items prefixed with this value (optional)

delimiter - delimiter used to group common prefixes by (optional)

Returns:

ApiResponse<DiffList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

diffBranchAsync

public okhttp3.Call diffBranchAsync(String repository,
                                    String branch,
                                    String after,
                                    Integer amount,
                                    String prefix,
                                    String delimiter,
                                    ApiCallback<DiffList> _callback)
                             throws ApiException

diff branch (asynchronously)

Parameters:

repository - (required)

branch - (required)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

prefix - return items prefixed with this value (optional)

delimiter - delimiter used to group common prefixes by (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-

getBranchCall

public okhttp3.Call getBranchCall(String repository,
                                  String branch,
                                  ApiCallback _callback)
                           throws ApiException

Build call for getBranch

Parameters:

repository - (required)

branch - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

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

getBranch

public Ref getBranch(String repository,
                     String branch)
              throws ApiException

get branch

Parameters:

repository - (required)

branch - (required)

Returns:

Ref

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

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

getBranchWithHttpInfo

public ApiResponse<Ref> getBranchWithHttpInfo(String repository,
                                              String branch)
                                       throws ApiException

get branch

Parameters:

repository - (required)

branch - (required)

Returns:

ApiResponse<Ref>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

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

getBranchAsync

public okhttp3.Call getBranchAsync(String repository,
                                   String branch,
                                   ApiCallback<Ref> _callback)
                            throws ApiException

get branch (asynchronously)

Parameters:

repository - (required)

branch - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

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

listBranchesCall

public okhttp3.Call listBranchesCall(String repository,
                                     String prefix,
                                     String after,
                                     Integer amount,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listBranches

Parameters:

repository - (required)

prefix - return items prefixed with this value (optional)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

listBranches

public RefList listBranches(String repository,
                            String prefix,
                            String after,
                            Integer amount)
                     throws ApiException

list branches

Parameters:

repository - (required)

prefix - return items prefixed with this value (optional)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

Returns:

RefList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

listBranchesWithHttpInfo

public ApiResponse<RefList> listBranchesWithHttpInfo(String repository,
                                                     String prefix,
                                                     String after,
                                                     Integer amount)
                                              throws ApiException

list branches

Parameters:

repository - (required)

prefix - return items prefixed with this value (optional)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

Returns:

ApiResponse<RefList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

listBranchesAsync

public okhttp3.Call listBranchesAsync(String repository,
                                      String prefix,
                                      String after,
                                      Integer amount,
                                      ApiCallback<RefList> _callback)
                               throws ApiException

list branches (asynchronously)

Parameters:

repository - (required)

prefix - return items prefixed with this value (optional)

after - return items after this value (optional)

amount - how many items to return (optional, default to 100)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-

resetBranchCall

public okhttp3.Call resetBranchCall(String repository,
                                    String branch,
                                    ResetCreation resetCreation,
                                    ApiCallback _callback)
                             throws ApiException

Build call for resetBranch

Parameters:

repository - (required)

branch - (required)

resetCreation - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

resetBranch

public void resetBranch(String repository,
                        String branch,
                        ResetCreation resetCreation)
                 throws ApiException

reset branch

Parameters:

repository - (required)

branch - (required)

resetCreation - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

resetBranchWithHttpInfo

public ApiResponse<Void> resetBranchWithHttpInfo(String repository,
                                                 String branch,
                                                 ResetCreation resetCreation)
                                          throws ApiException

reset branch

Parameters:

repository - (required)

branch - (required)

resetCreation - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

resetBranchAsync

public okhttp3.Call resetBranchAsync(String repository,
                                     String branch,
                                     ResetCreation resetCreation,
                                     ApiCallback<Void> _callback)
                              throws ApiException

reset branch (asynchronously)

Parameters:

repository - (required)

branch - (required)

resetCreation - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-

revertBranchCall

public okhttp3.Call revertBranchCall(String repository,
                                     String branch,
                                     RevertCreation revertCreation,
                                     ApiCallback _callback)
                              throws ApiException

Build call for revertBranch

Parameters:

repository - (required)

branch - (required)

revertCreation - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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	-

revertBranch

public void revertBranch(String repository,
                         String branch,
                         RevertCreation revertCreation)
                  throws ApiException

revert

Parameters:

repository - (required)

branch - (required)

revertCreation - (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

revertBranchWithHttpInfo

public ApiResponse<Void> revertBranchWithHttpInfo(String repository,
                                                  String branch,
                                                  RevertCreation revertCreation)
                                           throws ApiException

revert

Parameters:

repository - (required)

branch - (required)

revertCreation - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

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	-

revertBranchAsync

public okhttp3.Call revertBranchAsync(String repository,
                                      String branch,
                                      RevertCreation revertCreation,
                                      ApiCallback<Void> _callback)
                               throws ApiException

revert (asynchronously)

Parameters:

repository - (required)

branch - (required)

revertCreation - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

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	-