Package io.lakefs.clients.api

Class RetentionApi

java.lang.Object

io.lakefs.clients.api.RetentionApi

public class RetentionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RetentionApi()
RetentionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
GarbageCollectionRules	getGarbageCollectionRules(String repository)
okhttp3.Call	getGarbageCollectionRulesAsync(String repository, ApiCallback<GarbageCollectionRules> _callback)	(asynchronously)
okhttp3.Call	getGarbageCollectionRulesCall(String repository, ApiCallback _callback)	Build call for getGarbageCollectionRules
ApiResponse<GarbageCollectionRules>	getGarbageCollectionRulesWithHttpInfo(String repository)
GarbageCollectionPrepareResponse	prepareGarbageCollectionCommits(String repository, GarbageCollectionPrepareRequest garbageCollectionPrepareRequest)	save lists of active and expired commits for garbage collection
okhttp3.Call	prepareGarbageCollectionCommitsAsync(String repository, GarbageCollectionPrepareRequest garbageCollectionPrepareRequest, ApiCallback<GarbageCollectionPrepareResponse> _callback)	save lists of active and expired commits for garbage collection (asynchronously)
okhttp3.Call	prepareGarbageCollectionCommitsCall(String repository, GarbageCollectionPrepareRequest garbageCollectionPrepareRequest, ApiCallback _callback)	Build call for prepareGarbageCollectionCommits
ApiResponse<GarbageCollectionPrepareResponse>	prepareGarbageCollectionCommitsWithHttpInfo(String repository, GarbageCollectionPrepareRequest garbageCollectionPrepareRequest)	save lists of active and expired commits for garbage collection
void	setApiClient(ApiClient apiClient)
void	setGarbageCollectionRules(String repository, GarbageCollectionRules garbageCollectionRules)
okhttp3.Call	setGarbageCollectionRulesAsync(String repository, GarbageCollectionRules garbageCollectionRules, ApiCallback<Void> _callback)	(asynchronously)
okhttp3.Call	setGarbageCollectionRulesCall(String repository, GarbageCollectionRules garbageCollectionRules, ApiCallback _callback)	Build call for setGarbageCollectionRules
ApiResponse<Void>	setGarbageCollectionRulesWithHttpInfo(String repository, GarbageCollectionRules garbageCollectionRules)

Methods inherited from class java.lang.Object

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

Constructor Detail

RetentionApi

public RetentionApi()

RetentionApi

public RetentionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getGarbageCollectionRulesCall

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

Build call for getGarbageCollectionRules

Parameters:

repository - (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	gc rule list	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getGarbageCollectionRules

public GarbageCollectionRules getGarbageCollectionRules(String repository)
                                                 throws ApiException

Parameters:

repository - (required)

Returns:

GarbageCollectionRules

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	gc rule list	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getGarbageCollectionRulesWithHttpInfo

public ApiResponse<GarbageCollectionRules> getGarbageCollectionRulesWithHttpInfo(String repository)
                                                                          throws ApiException

Parameters:

repository - (required)

Returns:

ApiResponse<GarbageCollectionRules>

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	gc rule list	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

getGarbageCollectionRulesAsync

public okhttp3.Call getGarbageCollectionRulesAsync(String repository,
                                                   ApiCallback<GarbageCollectionRules> _callback)
                                            throws ApiException

(asynchronously)

Parameters:

repository - (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	gc rule list	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

prepareGarbageCollectionCommitsCall

public okhttp3.Call prepareGarbageCollectionCommitsCall(String repository,
                                                        GarbageCollectionPrepareRequest garbageCollectionPrepareRequest,
                                                        ApiCallback _callback)
                                                 throws ApiException

Build call for prepareGarbageCollectionCommits

Parameters:

repository - (required)

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

prepareGarbageCollectionCommits

public GarbageCollectionPrepareResponse prepareGarbageCollectionCommits(String repository,
                                                                        GarbageCollectionPrepareRequest garbageCollectionPrepareRequest)
                                                                 throws ApiException

save lists of active and expired commits for garbage collection

Parameters:

repository - (required)

garbageCollectionPrepareRequest - (optional)

Returns:

GarbageCollectionPrepareResponse

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

prepareGarbageCollectionCommitsWithHttpInfo

public ApiResponse<GarbageCollectionPrepareResponse> prepareGarbageCollectionCommitsWithHttpInfo(String repository,
                                                                                                 GarbageCollectionPrepareRequest garbageCollectionPrepareRequest)
                                                                                          throws ApiException

save lists of active and expired commits for garbage collection

Parameters:

repository - (required)

garbageCollectionPrepareRequest - (optional)

Returns:

ApiResponse<GarbageCollectionPrepareResponse>

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

prepareGarbageCollectionCommitsAsync

public okhttp3.Call prepareGarbageCollectionCommitsAsync(String repository,
                                                         GarbageCollectionPrepareRequest garbageCollectionPrepareRequest,
                                                         ApiCallback<GarbageCollectionPrepareResponse> _callback)
                                                  throws ApiException

save lists of active and expired commits for garbage collection (asynchronously)

Parameters:

repository - (required)

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

setGarbageCollectionRulesCall

public okhttp3.Call setGarbageCollectionRulesCall(String repository,
                                                  GarbageCollectionRules garbageCollectionRules,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for setGarbageCollectionRules

Parameters:

repository - (required)

garbageCollectionRules - (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	set garbage collection rules successfully	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

setGarbageCollectionRules

public void setGarbageCollectionRules(String repository,
                                      GarbageCollectionRules garbageCollectionRules)
                               throws ApiException

Parameters:

repository - (required)

garbageCollectionRules - (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	set garbage collection rules successfully	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

setGarbageCollectionRulesWithHttpInfo

public ApiResponse<Void> setGarbageCollectionRulesWithHttpInfo(String repository,
                                                               GarbageCollectionRules garbageCollectionRules)
                                                        throws ApiException

Parameters:

repository - (required)

garbageCollectionRules - (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	set garbage collection rules successfully	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

setGarbageCollectionRulesAsync

public okhttp3.Call setGarbageCollectionRulesAsync(String repository,
                                                   GarbageCollectionRules garbageCollectionRules,
                                                   ApiCallback<Void> _callback)
                                            throws ApiException

(asynchronously)

Parameters:

repository - (required)

garbageCollectionRules - (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	set garbage collection rules successfully	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-