Package io.lakefs.clients.sdk

Class RefsApi

java.lang.Object

io.lakefs.clients.sdk.RefsApi

public class RefsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RefsApi.APIdiffRefsRequest
class	RefsApi.APIfindMergeBaseRequest
class	RefsApi.APIlogCommitsRequest
class	RefsApi.APImergeIntoBranchRequest

Constructor Summary

Constructors

Constructor	Description
RefsApi()
RefsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
RefsApi.APIdiffRefsRequest	diffRefs(String repository, String leftRef, String rightRef)	diff references
RefsApi.APIfindMergeBaseRequest	findMergeBase(String repository, String sourceRef, String destinationBranch)	find the merge base for 2 references
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
RefsApi.APIlogCommitsRequest	logCommits(String repository, String ref)	get commit log from ref.
RefsApi.APImergeIntoBranchRequest	mergeIntoBranch(String repository, String sourceRef, String destinationBranch)	merge references
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

RefsApi

public RefsApi()

RefsApi

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

diffRefs

public RefsApi.APIdiffRefsRequest diffRefs(String repository,
                                           String leftRef,
                                           String rightRef)

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)

Returns:

APIdiffRefsRequest

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	-

findMergeBase

public RefsApi.APIfindMergeBaseRequest findMergeBase(String repository,
                                                     String sourceRef,
                                                     String destinationBranch)

find the merge base for 2 references

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

Returns:

APIfindMergeBaseRequest

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	-

logCommits

public RefsApi.APIlogCommitsRequest logCommits(String repository,
                                               String ref)

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

Parameters:

repository - (required)

ref - (required)

Returns:

APIlogCommitsRequest

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	-

mergeIntoBranch

public RefsApi.APImergeIntoBranchRequest mergeIntoBranch(String repository,
                                                         String sourceRef,
                                                         String destinationBranch)

merge references

Parameters:

repository - (required)

sourceRef - source ref (required)

destinationBranch - destination branch name (required)

Returns:

APImergeIntoBranchRequest

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	-