Package io.lakefs.clients.api

Class ImportApi

java.lang.Object

io.lakefs.clients.api.ImportApi

public class ImportApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ImportApi()
ImportApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	importCancel(String repository, String branch, String id)	cancel ongoing import
okhttp3.Call	importCancelAsync(String repository, String branch, String id, ApiCallback<Void> _callback)	cancel ongoing import (asynchronously)
okhttp3.Call	importCancelCall(String repository, String branch, String id, ApiCallback _callback)	Build call for importCancel
ApiResponse<Void>	importCancelWithHttpInfo(String repository, String branch, String id)	cancel ongoing import
ImportCreationResponse	importStart(String repository, String branch, ImportCreation importCreation)	import data from object store
okhttp3.Call	importStartAsync(String repository, String branch, ImportCreation importCreation, ApiCallback<ImportCreationResponse> _callback)	import data from object store (asynchronously)
okhttp3.Call	importStartCall(String repository, String branch, ImportCreation importCreation, ApiCallback _callback)	Build call for importStart
ApiResponse<ImportCreationResponse>	importStartWithHttpInfo(String repository, String branch, ImportCreation importCreation)	import data from object store
ImportStatus	importStatus(String repository, String branch, String id)	get import status
okhttp3.Call	importStatusAsync(String repository, String branch, String id, ApiCallback<ImportStatus> _callback)	get import status (asynchronously)
okhttp3.Call	importStatusCall(String repository, String branch, String id, ApiCallback _callback)	Build call for importStatus
ApiResponse<ImportStatus>	importStatusWithHttpInfo(String repository, String branch, String id)	get import status
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportApi

public ImportApi()

ImportApi

public ImportApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

importCancelCall

public okhttp3.Call importCancelCall(String repository,
                                     String branch,
                                     String id,
                                     ApiCallback _callback)
                              throws ApiException

Build call for importCancel

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (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	import canceled successfully	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

importCancel

public void importCancel(String repository,
                         String branch,
                         String id)
                  throws ApiException

cancel ongoing import

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (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	import canceled successfully	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

importCancelWithHttpInfo

public ApiResponse<Void> importCancelWithHttpInfo(String repository,
                                                  String branch,
                                                  String id)
                                           throws ApiException

cancel ongoing import

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (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	import canceled successfully	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

importCancelAsync

public okhttp3.Call importCancelAsync(String repository,
                                      String branch,
                                      String id,
                                      ApiCallback<Void> _callback)
                               throws ApiException

cancel ongoing import (asynchronously)

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (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	import canceled successfully	-
401	Unauthorized	-
403	Forbidden	-
404	Resource Not Found	-
409	Resource Conflicts With Target	-
420	too many requests	-
0	Internal Server Error	-

importStartCall

public okhttp3.Call importStartCall(String repository,
                                    String branch,
                                    ImportCreation importCreation,
                                    ApiCallback _callback)
                             throws ApiException

Build call for importStart

Parameters:

repository - (required)

branch - (required)

importCreation - (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
202	Import started	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

importStart

public ImportCreationResponse importStart(String repository,
                                          String branch,
                                          ImportCreation importCreation)
                                   throws ApiException

import data from object store

Parameters:

repository - (required)

branch - (required)

importCreation - (required)

Returns:

ImportCreationResponse

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

importStartWithHttpInfo

public ApiResponse<ImportCreationResponse> importStartWithHttpInfo(String repository,
                                                                   String branch,
                                                                   ImportCreation importCreation)
                                                            throws ApiException

import data from object store

Parameters:

repository - (required)

branch - (required)

importCreation - (required)

Returns:

ApiResponse<ImportCreationResponse>

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

importStartAsync

public okhttp3.Call importStartAsync(String repository,
                                     String branch,
                                     ImportCreation importCreation,
                                     ApiCallback<ImportCreationResponse> _callback)
                              throws ApiException

import data from object store (asynchronously)

Parameters:

repository - (required)

branch - (required)

importCreation - (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
202	Import started	-
400	Validation Error	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

importStatusCall

public okhttp3.Call importStatusCall(String repository,
                                     String branch,
                                     String id,
                                     ApiCallback _callback)
                              throws ApiException

Build call for importStatus

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (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	import status	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-

importStatus

public ImportStatus importStatus(String repository,
                                 String branch,
                                 String id)
                          throws ApiException

get import status

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (required)

Returns:

ImportStatus

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

importStatusWithHttpInfo

public ApiResponse<ImportStatus> importStatusWithHttpInfo(String repository,
                                                          String branch,
                                                          String id)
                                                   throws ApiException

get import status

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (required)

Returns:

ApiResponse<ImportStatus>

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

importStatusAsync

public okhttp3.Call importStatusAsync(String repository,
                                      String branch,
                                      String id,
                                      ApiCallback<ImportStatus> _callback)
                               throws ApiException

get import status (asynchronously)

Parameters:

repository - (required)

branch - (required)

id - Unique identifier of the import process (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	import status	-
401	Unauthorized	-
404	Resource Not Found	-
420	too many requests	-
0	Internal Server Error	-