Package io.lakefs.clients.api

Class CommitsApi

java.lang.Object

io.lakefs.clients.api.CommitsApi

public class CommitsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CommitsApi()
CommitsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Commit	commit(String repository, String branch, CommitCreation commitCreation, String sourceMetarange)	create commit
okhttp3.Call	commitAsync(String repository, String branch, CommitCreation commitCreation, String sourceMetarange, ApiCallback<Commit> _callback)	create commit (asynchronously)
okhttp3.Call	commitCall(String repository, String branch, CommitCreation commitCreation, String sourceMetarange, ApiCallback _callback)	Build call for commit
ApiResponse<Commit>	commitWithHttpInfo(String repository, String branch, CommitCreation commitCreation, String sourceMetarange)	create commit
ApiClient	getApiClient()
Commit	getCommit(String repository, String commitId)	get commit
okhttp3.Call	getCommitAsync(String repository, String commitId, ApiCallback<Commit> _callback)	get commit (asynchronously)
okhttp3.Call	getCommitCall(String repository, String commitId, ApiCallback _callback)	Build call for getCommit
ApiResponse<Commit>	getCommitWithHttpInfo(String repository, String commitId)	get commit
CommitList	logBranchCommits(String repository, String branch, String after, Integer amount)	Deprecated.
okhttp3.Call	logBranchCommitsAsync(String repository, String branch, String after, Integer amount, ApiCallback<CommitList> _callback)	Deprecated.
okhttp3.Call	logBranchCommitsCall(String repository, String branch, String after, Integer amount, ApiCallback _callback)	Deprecated.
ApiResponse<CommitList>	logBranchCommitsWithHttpInfo(String repository, String branch, String after, Integer amount)	Deprecated.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitsApi

public CommitsApi()

CommitsApi

public CommitsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

commitCall

public okhttp3.Call commitCall(String repository,
                               String branch,
                               CommitCreation commitCreation,
                               String sourceMetarange,
                               ApiCallback _callback)
                        throws ApiException

Build call for commit

Parameters:

repository - (required)

branch - (required)

commitCreation - (required)

sourceMetarange - The source metarange to commit. Branch must not have uncommitted changes. (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
201	commit	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed (e.g. a pre-commit hook returned a failure)	-
0	Internal Server Error	-

commit

public Commit commit(String repository,
                     String branch,
                     CommitCreation commitCreation,
                     String sourceMetarange)
              throws ApiException

create commit

Parameters:

repository - (required)

branch - (required)

commitCreation - (required)

sourceMetarange - The source metarange to commit. Branch must not have uncommitted changes. (optional)

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	commit	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed (e.g. a pre-commit hook returned a failure)	-
0	Internal Server Error	-

commitWithHttpInfo

public ApiResponse<Commit> commitWithHttpInfo(String repository,
                                              String branch,
                                              CommitCreation commitCreation,
                                              String sourceMetarange)
                                       throws ApiException

create commit

Parameters:

repository - (required)

branch - (required)

commitCreation - (required)

sourceMetarange - The source metarange to commit. Branch must not have uncommitted changes. (optional)

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	commit	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed (e.g. a pre-commit hook returned a failure)	-
0	Internal Server Error	-

commitAsync

public okhttp3.Call commitAsync(String repository,
                                String branch,
                                CommitCreation commitCreation,
                                String sourceMetarange,
                                ApiCallback<Commit> _callback)
                         throws ApiException

create commit (asynchronously)

Parameters:

repository - (required)

branch - (required)

commitCreation - (required)

sourceMetarange - The source metarange to commit. Branch must not have uncommitted changes. (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
201	commit	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
412	Precondition Failed (e.g. a pre-commit hook returned a failure)	-
0	Internal Server Error	-

getCommitCall

public okhttp3.Call getCommitCall(String repository,
                                  String commitId,
                                  ApiCallback _callback)
                           throws ApiException

Build call for getCommit

Parameters:

repository - (required)

commitId - (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	commit	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getCommit

public Commit getCommit(String repository,
                        String commitId)
                 throws ApiException

get commit

Parameters:

repository - (required)

commitId - (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
200	commit	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getCommitWithHttpInfo

public ApiResponse<Commit> getCommitWithHttpInfo(String repository,
                                                 String commitId)
                                          throws ApiException

get commit

Parameters:

repository - (required)

commitId - (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
200	commit	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getCommitAsync

public okhttp3.Call getCommitAsync(String repository,
                                   String commitId,
                                   ApiCallback<Commit> _callback)
                            throws ApiException

get commit (asynchronously)

Parameters:

repository - (required)

commitId - (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	commit	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

logBranchCommitsCall

@Deprecated
public okhttp3.Call logBranchCommitsCall(String repository,
                                         String branch,
                                         String after,
                                         Integer amount,
                                         ApiCallback _callback)
                                  throws ApiException

Deprecated.

Build call for logBranchCommits

Parameters:

repository - (required)

branch - (required)

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	commit log	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

logBranchCommits

@Deprecated
public CommitList logBranchCommits(String repository,
                                   String branch,
                                   String after,
                                   Integer amount)
                            throws ApiException

Deprecated.

get commit log from branch. Deprecated: replaced by logCommits by passing branch name as ref

Parameters:

repository - (required)

branch - (required)

after - return items after this value (optional)

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

Returns:

CommitList

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	commit log	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

logBranchCommitsWithHttpInfo

@Deprecated
public ApiResponse<CommitList> logBranchCommitsWithHttpInfo(String repository,
                                                            String branch,
                                                            String after,
                                                            Integer amount)
                                                     throws ApiException

Deprecated.

get commit log from branch. Deprecated: replaced by logCommits by passing branch name as ref

Parameters:

repository - (required)

branch - (required)

after - return items after this value (optional)

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

Returns:

ApiResponse<CommitList>

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	commit log	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

logBranchCommitsAsync

@Deprecated
public okhttp3.Call logBranchCommitsAsync(String repository,
                                          String branch,
                                          String after,
                                          Integer amount,
                                          ApiCallback<CommitList> _callback)
                                   throws ApiException

Deprecated.

get commit log from branch. Deprecated: replaced by logCommits by passing branch name as ref (asynchronously)

Parameters:

repository - (required)

branch - (required)

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	commit log	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-