java.lang.Object
- io.lakefs.clients.api.RefsApi

```
public class RefsApi
extends Object
```

Constructor Summary

Constructors
Constructor Description

RefsApi()

RefsApi(ApiClient apiClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DiffList`	`diffRefs(String repository, String leftRef, String rightRef, String after, Integer amount, String prefix, String delimiter, String type)`	diff references
`okhttp3.Call`	`diffRefsAsync(String repository, String leftRef, String rightRef, String after, Integer amount, String prefix, String delimiter, String type, ApiCallback<DiffList> _callback)`	diff references (asynchronously)
`okhttp3.Call`	`diffRefsCall(String repository, String leftRef, String rightRef, String after, Integer amount, String prefix, String delimiter, String type, ApiCallback _callback)`	Build call for diffRefs
`ApiResponse<DiffList>`	`diffRefsWithHttpInfo(String repository, String leftRef, String rightRef, String after, Integer amount, String prefix, String delimiter, String type)`	diff references
`FindMergeBaseResult`	`findMergeBase(String repository, String sourceRef, String destinationBranch)`	find the merge base for 2 references
`okhttp3.Call`	`findMergeBaseAsync(String repository, String sourceRef, String destinationBranch, ApiCallback<FindMergeBaseResult> _callback)`	find the merge base for 2 references (asynchronously)
`okhttp3.Call`	`findMergeBaseCall(String repository, String sourceRef, String destinationBranch, ApiCallback _callback)`	Build call for findMergeBase
`ApiResponse<FindMergeBaseResult>`	`findMergeBaseWithHttpInfo(String repository, String sourceRef, String destinationBranch)`	find the merge base for 2 references
`ApiClient`	`getApiClient()`
`CommitList`	`logCommits(String repository, String ref, String after, Integer amount, List<String> objects, List<String> prefixes, Boolean limit, Boolean firstParent, org.threeten.bp.OffsetDateTime since)`	get commit log from ref.
`okhttp3.Call`	`logCommitsAsync(String repository, String ref, String after, Integer amount, List<String> objects, List<String> prefixes, Boolean limit, Boolean firstParent, org.threeten.bp.OffsetDateTime since, ApiCallback<CommitList> _callback)`	get commit log from ref.
`okhttp3.Call`	`logCommitsCall(String repository, String ref, String after, Integer amount, List<String> objects, List<String> prefixes, Boolean limit, Boolean firstParent, org.threeten.bp.OffsetDateTime since, ApiCallback _callback)`	Build call for logCommits
`ApiResponse<CommitList>`	`logCommitsWithHttpInfo(String repository, String ref, String after, Integer amount, List<String> objects, List<String> prefixes, Boolean limit, Boolean firstParent, org.threeten.bp.OffsetDateTime since)`	get commit log from ref.
`MergeResult`	`mergeIntoBranch(String repository, String sourceRef, String destinationBranch, Merge merge)`	merge references
`okhttp3.Call`	`mergeIntoBranchAsync(String repository, String sourceRef, String destinationBranch, Merge merge, ApiCallback<MergeResult> _callback)`	merge references (asynchronously)
`okhttp3.Call`	`mergeIntoBranchCall(String repository, String sourceRef, String destinationBranch, Merge merge, ApiCallback _callback)`	Build call for mergeIntoBranch
`ApiResponse<MergeResult>`	`mergeIntoBranchWithHttpInfo(String repository, String sourceRef, String destinationBranch, Merge merge)`	merge references
`void`	`setApiClient(ApiClient apiClient)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefsApi
```
public RefsApi()
```

RefsApi

public RefsApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

diffRefsCall

public okhttp3.Call diffRefsCall(String repository,
                                 String leftRef,
                                 String rightRef,
                                 String after,
                                 Integer amount,
                                 String prefix,
                                 String delimiter,
                                 String type,
                                 ApiCallback _callback)
                          throws ApiException

Build call for diffRefs

Parameters:

repository - (required)

leftRef - a reference (could be either a branch or a commit ID) (required)

rightRef - a reference (could be either a branch or a commit ID) to compare against (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)

type - (optional, default to three_dot)

_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 between refs	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

diffRefs

public DiffList diffRefs(String repository,
                         String leftRef,
                         String rightRef,
                         String after,
                         Integer amount,
                         String prefix,
                         String delimiter,
                         String type)
                  throws ApiException

diff references

Parameters:

repository - (required)

leftRef - a reference (could be either a branch or a commit ID) (required)

rightRef - a reference (could be either a branch or a commit ID) to compare against (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)

type - (optional, default to three_dot)

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 between refs	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

diffRefsWithHttpInfo

public ApiResponse<DiffList> diffRefsWithHttpInfo(String repository,
                                                  String leftRef,
                                                  String rightRef,
                                                  String after,
                                                  Integer amount,
                                                  String prefix,
                                                  String delimiter,
                                                  String type)
                                           throws ApiException

diff references

Parameters:

repository - (required)

leftRef - a reference (could be either a branch or a commit ID) (required)

rightRef - a reference (could be either a branch or a commit ID) to compare against (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)

type - (optional, default to three_dot)

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 between refs	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

diffRefsAsync

public okhttp3.Call diffRefsAsync(String repository,
                                  String leftRef,
                                  String rightRef,
                                  String after,
                                  Integer amount,
                                  String prefix,
                                  String delimiter,
                                  String type,
                                  ApiCallback<DiffList> _callback)
                           throws ApiException

diff references (asynchronously)

Parameters:

repository - (required)

leftRef - a reference (could be either a branch or a commit ID) (required)

rightRef - a reference (could be either a branch or a commit ID) to compare against (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)

type - (optional, default to three_dot)

_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 between refs	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

findMergeBaseCall

public okhttp3.Call findMergeBaseCall(String repository,
                                      String sourceRef,
                                      String destinationBranch,
                                      ApiCallback _callback)
                               throws ApiException

Build call for findMergeBase

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (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	Found the merge base	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

findMergeBase

public FindMergeBaseResult findMergeBase(String repository,
                                         String sourceRef,
                                         String destinationBranch)
                                  throws ApiException

find the merge base for 2 references

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

Returns:

FindMergeBaseResult

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	Found the merge base	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

findMergeBaseWithHttpInfo

public ApiResponse<FindMergeBaseResult> findMergeBaseWithHttpInfo(String repository,
                                                                  String sourceRef,
                                                                  String destinationBranch)
                                                           throws ApiException

find the merge base for 2 references

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

Returns:

ApiResponse<FindMergeBaseResult>

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	Found the merge base	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

findMergeBaseAsync

public okhttp3.Call findMergeBaseAsync(String repository,
                                       String sourceRef,
                                       String destinationBranch,
                                       ApiCallback<FindMergeBaseResult> _callback)
                                throws ApiException

find the merge base for 2 references (asynchronously)

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (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	Found the merge base	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

logCommitsCall

public okhttp3.Call logCommitsCall(String repository,
                                   String ref,
                                   String after,
                                   Integer amount,
                                   List<String> objects,
                                   List<String> prefixes,
                                   Boolean limit,
                                   Boolean firstParent,
                                   org.threeten.bp.OffsetDateTime since,
                                   ApiCallback _callback)
                            throws ApiException

Build call for logCommits

Parameters:

repository - (required)

ref - (required)

after - return items after this value (optional)

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

objects - list of paths, each element is a path of a specific object (optional)

prefixes - list of paths, each element is a path of a prefix (optional)

limit - limit the number of items in return to 'amount'. Without further indication on actual number of items. (optional)

firstParent - if set to true, follow only the first parent upon reaching a merge commit (optional)

since - Show commits more recent than a specific date-time (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	commit log	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

logCommits

public CommitList logCommits(String repository,
                             String ref,
                             String after,
                             Integer amount,
                             List<String> objects,
                             List<String> prefixes,
                             Boolean limit,
                             Boolean firstParent,
                             org.threeten.bp.OffsetDateTime since)
                      throws ApiException

get commit log from ref. If both objects and prefixes are empty, return all commits.

Parameters:

repository - (required)

ref - (required)

after - return items after this value (optional)

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

objects - list of paths, each element is a path of a specific object (optional)

prefixes - list of paths, each element is a path of a prefix (optional)

limit - limit the number of items in return to 'amount'. Without further indication on actual number of items. (optional)

firstParent - if set to true, follow only the first parent upon reaching a merge commit (optional)

since - Show commits more recent than a specific date-time (optional)

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	-
420	too many requests	-
0	Internal Server Error	-

logCommitsWithHttpInfo

public ApiResponse<CommitList> logCommitsWithHttpInfo(String repository,
                                                      String ref,
                                                      String after,
                                                      Integer amount,
                                                      List<String> objects,
                                                      List<String> prefixes,
                                                      Boolean limit,
                                                      Boolean firstParent,
                                                      org.threeten.bp.OffsetDateTime since)
                                               throws ApiException

get commit log from ref. If both objects and prefixes are empty, return all commits.

Parameters:

repository - (required)

ref - (required)

after - return items after this value (optional)

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

objects - list of paths, each element is a path of a specific object (optional)

prefixes - list of paths, each element is a path of a prefix (optional)

limit - limit the number of items in return to 'amount'. Without further indication on actual number of items. (optional)

firstParent - if set to true, follow only the first parent upon reaching a merge commit (optional)

since - Show commits more recent than a specific date-time (optional)

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	-
420	too many requests	-
0	Internal Server Error	-

logCommitsAsync

public okhttp3.Call logCommitsAsync(String repository,
                                    String ref,
                                    String after,
                                    Integer amount,
                                    List<String> objects,
                                    List<String> prefixes,
                                    Boolean limit,
                                    Boolean firstParent,
                                    org.threeten.bp.OffsetDateTime since,
                                    ApiCallback<CommitList> _callback)
                             throws ApiException

get commit log from ref. If both objects and prefixes are empty, return all commits. (asynchronously)

Parameters:

repository - (required)

ref - (required)

after - return items after this value (optional)

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

objects - list of paths, each element is a path of a specific object (optional)

prefixes - list of paths, each element is a path of a prefix (optional)

limit - limit the number of items in return to 'amount'. Without further indication on actual number of items. (optional)

firstParent - if set to true, follow only the first parent upon reaching a merge commit (optional)

since - Show commits more recent than a specific date-time (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	commit log	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

mergeIntoBranchCall

public okhttp3.Call mergeIntoBranchCall(String repository,
                                        String sourceRef,
                                        String destinationBranch,
                                        Merge merge,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for mergeIntoBranch

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

merge - (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	merge completed	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Conflict Deprecated: content schema will return Error format and not an empty MergeResult	-
412	precondition failed (e.g. a pre-merge hook returned a failure)	-
420	too many requests	-
0	Internal Server Error	-

mergeIntoBranch

public MergeResult mergeIntoBranch(String repository,
                                   String sourceRef,
                                   String destinationBranch,
                                   Merge merge)
                            throws ApiException

merge references

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

merge - (optional)

Returns:

MergeResult

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	merge completed	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Conflict Deprecated: content schema will return Error format and not an empty MergeResult	-
412	precondition failed (e.g. a pre-merge hook returned a failure)	-
420	too many requests	-
0	Internal Server Error	-

mergeIntoBranchWithHttpInfo

public ApiResponse<MergeResult> mergeIntoBranchWithHttpInfo(String repository,
                                                            String sourceRef,
                                                            String destinationBranch,
                                                            Merge merge)
                                                     throws ApiException

merge references

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

merge - (optional)

Returns:

ApiResponse<MergeResult>

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	merge completed	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Conflict Deprecated: content schema will return Error format and not an empty MergeResult	-
412	precondition failed (e.g. a pre-merge hook returned a failure)	-
420	too many requests	-
0	Internal Server Error	-

mergeIntoBranchAsync

public okhttp3.Call mergeIntoBranchAsync(String repository,
                                         String sourceRef,
                                         String destinationBranch,
                                         Merge merge,
                                         ApiCallback<MergeResult> _callback)
                                  throws ApiException

merge references (asynchronously)

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

merge - (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	merge completed	-
400	Validation Error	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Conflict Deprecated: content schema will return Error format and not an empty MergeResult	-
412	precondition failed (e.g. a pre-merge hook returned a failure)	-
420	too many requests	-
0	Internal Server Error	-

Class RefsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RefsApi

RefsApi

Method Detail

getApiClient

setApiClient

diffRefsCall

diffRefs

diffRefsWithHttpInfo

diffRefsAsync

findMergeBaseCall

findMergeBase

findMergeBaseWithHttpInfo

findMergeBaseAsync

logCommitsCall

logCommits

logCommitsWithHttpInfo

logCommitsAsync

mergeIntoBranchCall

mergeIntoBranch

mergeIntoBranchWithHttpInfo

mergeIntoBranchAsync