Package io.lakefs.clients.api

Class ConfigApi

java.lang.Object

io.lakefs.clients.api.ConfigApi

public class ConfigApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ConfigApi()
ConfigApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
GarbageCollectionConfig	getGarbageCollectionConfig()	get information of gc settings
okhttp3.Call	getGarbageCollectionConfigAsync(ApiCallback<GarbageCollectionConfig> _callback)	(asynchronously) get information of gc settings
okhttp3.Call	getGarbageCollectionConfigCall(ApiCallback _callback)	Build call for getGarbageCollectionConfig
ApiResponse<GarbageCollectionConfig>	getGarbageCollectionConfigWithHttpInfo()	get information of gc settings
VersionConfig	getLakeFSVersion()	get version of lakeFS server
okhttp3.Call	getLakeFSVersionAsync(ApiCallback<VersionConfig> _callback)	(asynchronously) get version of lakeFS server
okhttp3.Call	getLakeFSVersionCall(ApiCallback _callback)	Build call for getLakeFSVersion
ApiResponse<VersionConfig>	getLakeFSVersionWithHttpInfo()	get version of lakeFS server
SetupState	getSetupState()	check if the lakeFS installation is already set up
okhttp3.Call	getSetupStateAsync(ApiCallback<SetupState> _callback)	check if the lakeFS installation is already set up (asynchronously)
okhttp3.Call	getSetupStateCall(ApiCallback _callback)	Build call for getSetupState
ApiResponse<SetupState>	getSetupStateWithHttpInfo()	check if the lakeFS installation is already set up
StorageConfig	getStorageConfig()	retrieve lakeFS storage configuration
okhttp3.Call	getStorageConfigAsync(ApiCallback<StorageConfig> _callback)	(asynchronously) retrieve lakeFS storage configuration
okhttp3.Call	getStorageConfigCall(ApiCallback _callback)	Build call for getStorageConfig
ApiResponse<StorageConfig>	getStorageConfigWithHttpInfo()	retrieve lakeFS storage configuration
void	setApiClient(ApiClient apiClient)
CredentialsWithSecret	setup(Setup setup)	setup lakeFS and create a first user
okhttp3.Call	setupAsync(Setup setup, ApiCallback<CredentialsWithSecret> _callback)	setup lakeFS and create a first user (asynchronously)
okhttp3.Call	setupCall(Setup setup, ApiCallback _callback)	Build call for setup
void	setupCommPrefs(CommPrefsInput commPrefsInput)	setup communications preferences
okhttp3.Call	setupCommPrefsAsync(CommPrefsInput commPrefsInput, ApiCallback<Void> _callback)	setup communications preferences (asynchronously)
okhttp3.Call	setupCommPrefsCall(CommPrefsInput commPrefsInput, ApiCallback _callback)	Build call for setupCommPrefs
ApiResponse<Void>	setupCommPrefsWithHttpInfo(CommPrefsInput commPrefsInput)	setup communications preferences
ApiResponse<CredentialsWithSecret>	setupWithHttpInfo(Setup setup)	setup lakeFS and create a first user

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigApi

public ConfigApi()

ConfigApi

public ConfigApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getGarbageCollectionConfigCall

public okhttp3.Call getGarbageCollectionConfigCall(ApiCallback _callback)
                                            throws ApiException

Build call for getGarbageCollectionConfig

Parameters:

_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	lakeFS garbage collection config	-
401	Unauthorized	-

getGarbageCollectionConfig

public GarbageCollectionConfig getGarbageCollectionConfig()
                                                   throws ApiException

get information of gc settings

Returns:

GarbageCollectionConfig

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	lakeFS garbage collection config	-
401	Unauthorized	-

getGarbageCollectionConfigWithHttpInfo

public ApiResponse<GarbageCollectionConfig> getGarbageCollectionConfigWithHttpInfo()
                                                                            throws ApiException

get information of gc settings

Returns:

ApiResponse<GarbageCollectionConfig>

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	lakeFS garbage collection config	-
401	Unauthorized	-

getGarbageCollectionConfigAsync

public okhttp3.Call getGarbageCollectionConfigAsync(ApiCallback<GarbageCollectionConfig> _callback)
                                             throws ApiException

(asynchronously) get information of gc settings

Parameters:

_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	lakeFS garbage collection config	-
401	Unauthorized	-

getLakeFSVersionCall

public okhttp3.Call getLakeFSVersionCall(ApiCallback _callback)
                                  throws ApiException

Build call for getLakeFSVersion

Parameters:

_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	lakeFS version	-
401	Unauthorized	-

getLakeFSVersion

public VersionConfig getLakeFSVersion()
                               throws ApiException

get version of lakeFS server

Returns:

VersionConfig

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	lakeFS version	-
401	Unauthorized	-

getLakeFSVersionWithHttpInfo

public ApiResponse<VersionConfig> getLakeFSVersionWithHttpInfo()
                                                        throws ApiException

get version of lakeFS server

Returns:

ApiResponse<VersionConfig>

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	lakeFS version	-
401	Unauthorized	-

getLakeFSVersionAsync

public okhttp3.Call getLakeFSVersionAsync(ApiCallback<VersionConfig> _callback)
                                   throws ApiException

(asynchronously) get version of lakeFS server

Parameters:

_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	lakeFS version	-
401	Unauthorized	-

getSetupStateCall

public okhttp3.Call getSetupStateCall(ApiCallback _callback)
                               throws ApiException

Build call for getSetupState

Parameters:

_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	lakeFS setup state	-
0	Internal Server Error	-

getSetupState

public SetupState getSetupState()
                         throws ApiException

check if the lakeFS installation is already set up

Returns:

SetupState

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	lakeFS setup state	-
0	Internal Server Error	-

getSetupStateWithHttpInfo

public ApiResponse<SetupState> getSetupStateWithHttpInfo()
                                                  throws ApiException

check if the lakeFS installation is already set up

Returns:

ApiResponse<SetupState>

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	lakeFS setup state	-
0	Internal Server Error	-

getSetupStateAsync

public okhttp3.Call getSetupStateAsync(ApiCallback<SetupState> _callback)
                                throws ApiException

check if the lakeFS installation is already set up (asynchronously)

Parameters:

_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	lakeFS setup state	-
0	Internal Server Error	-

getStorageConfigCall

public okhttp3.Call getStorageConfigCall(ApiCallback _callback)
                                  throws ApiException

Build call for getStorageConfig

Parameters:

_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	lakeFS storage configuration	-
401	Unauthorized	-

getStorageConfig

public StorageConfig getStorageConfig()
                               throws ApiException

retrieve lakeFS storage configuration

Returns:

StorageConfig

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	lakeFS storage configuration	-
401	Unauthorized	-

getStorageConfigWithHttpInfo

public ApiResponse<StorageConfig> getStorageConfigWithHttpInfo()
                                                        throws ApiException

retrieve lakeFS storage configuration

Returns:

ApiResponse<StorageConfig>

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	lakeFS storage configuration	-
401	Unauthorized	-

getStorageConfigAsync

public okhttp3.Call getStorageConfigAsync(ApiCallback<StorageConfig> _callback)
                                   throws ApiException

(asynchronously) retrieve lakeFS storage configuration

Parameters:

_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	lakeFS storage configuration	-
401	Unauthorized	-

setupCall

public okhttp3.Call setupCall(Setup setup,
                              ApiCallback _callback)
                       throws ApiException

Build call for setup

Parameters:

setup - (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	user created successfully	-
400	bad request	-
409	setup was already called	-
0	Internal Server Error	-

setup

public CredentialsWithSecret setup(Setup setup)
                            throws ApiException

setup lakeFS and create a first user

Parameters:

setup - (required)

Returns:

CredentialsWithSecret

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	user created successfully	-
400	bad request	-
409	setup was already called	-
0	Internal Server Error	-

setupWithHttpInfo

public ApiResponse<CredentialsWithSecret> setupWithHttpInfo(Setup setup)
                                                     throws ApiException

setup lakeFS and create a first user

Parameters:

setup - (required)

Returns:

ApiResponse<CredentialsWithSecret>

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	user created successfully	-
400	bad request	-
409	setup was already called	-
0	Internal Server Error	-

setupAsync

public okhttp3.Call setupAsync(Setup setup,
                               ApiCallback<CredentialsWithSecret> _callback)
                        throws ApiException

setup lakeFS and create a first user (asynchronously)

Parameters:

setup - (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	user created successfully	-
400	bad request	-
409	setup was already called	-
0	Internal Server Error	-

setupCommPrefsCall

public okhttp3.Call setupCommPrefsCall(CommPrefsInput commPrefsInput,
                                       ApiCallback _callback)
                                throws ApiException

Build call for setupCommPrefs

Parameters:

commPrefsInput - (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	communication preferences saved successfully	-
409	setup was already completed	-
412	wrong setup state for this operation	-
0	Internal Server Error	-

setupCommPrefs

public void setupCommPrefs(CommPrefsInput commPrefsInput)
                    throws ApiException

setup communications preferences

Parameters:

commPrefsInput - (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
200	communication preferences saved successfully	-
409	setup was already completed	-
412	wrong setup state for this operation	-
0	Internal Server Error	-

setupCommPrefsWithHttpInfo

public ApiResponse<Void> setupCommPrefsWithHttpInfo(CommPrefsInput commPrefsInput)
                                             throws ApiException

setup communications preferences

Parameters:

commPrefsInput - (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
200	communication preferences saved successfully	-
409	setup was already completed	-
412	wrong setup state for this operation	-
0	Internal Server Error	-

setupCommPrefsAsync

public okhttp3.Call setupCommPrefsAsync(CommPrefsInput commPrefsInput,
                                        ApiCallback<Void> _callback)
                                 throws ApiException

setup communications preferences (asynchronously)

Parameters:

commPrefsInput - (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	communication preferences saved successfully	-
409	setup was already completed	-
412	wrong setup state for this operation	-
0	Internal Server Error	-