org.openapitools.db_data.client.api

Class BulkOperationsApi

java.lang.Object

org.openapitools.db_data.client.api.BulkOperationsApi

public class BulkOperationsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BulkOperationsApi()
BulkOperationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	cancelBulkImport(java.lang.String id) Cancel an import The `cancel_import` operation cancels an import operation if it is not yet finished.
okhttp3.Call	cancelBulkImportAsync(java.lang.String id, ApiCallback<java.lang.Object> _callback) Cancel an import (asynchronously) The `cancel_import` operation cancels an import operation if it is not yet finished.
okhttp3.Call	cancelBulkImportCall(java.lang.String id, ApiCallback _callback) Build call for cancelBulkImport
ApiResponse<java.lang.Object>	cancelBulkImportWithHttpInfo(java.lang.String id) Cancel an import The `cancel_import` operation cancels an import operation if it is not yet finished.
ImportModel	describeBulkImport(java.lang.String id) Describe an import The `describe_import` operation returns details of a specific import operation.
okhttp3.Call	describeBulkImportAsync(java.lang.String id, ApiCallback<ImportModel> _callback) Describe an import (asynchronously) The `describe_import` operation returns details of a specific import operation.
okhttp3.Call	describeBulkImportCall(java.lang.String id, ApiCallback _callback) Build call for describeBulkImport
ApiResponse<ImportModel>	describeBulkImportWithHttpInfo(java.lang.String id) Describe an import The `describe_import` operation returns details of a specific import operation.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
ListImportsResponse	listBulkImports(java.lang.Integer limit, java.lang.String paginationToken) List imports The `list_imports` operation lists all recent and ongoing import operations.
okhttp3.Call	listBulkImportsAsync(java.lang.Integer limit, java.lang.String paginationToken, ApiCallback<ListImportsResponse> _callback) List imports (asynchronously) The `list_imports` operation lists all recent and ongoing import operations.
okhttp3.Call	listBulkImportsCall(java.lang.Integer limit, java.lang.String paginationToken, ApiCallback _callback) Build call for listBulkImports
ApiResponse<ListImportsResponse>	listBulkImportsWithHttpInfo(java.lang.Integer limit, java.lang.String paginationToken) List imports The `list_imports` operation lists all recent and ongoing import operations.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
StartImportResponse	startBulkImport(StartImportRequest startImportRequest) Start import The `start_import` operation starts an asynchronous import of vectors from object storage into an index.
okhttp3.Call	startBulkImportAsync(StartImportRequest startImportRequest, ApiCallback<StartImportResponse> _callback) Start import (asynchronously) The `start_import` operation starts an asynchronous import of vectors from object storage into an index.
okhttp3.Call	startBulkImportCall(StartImportRequest startImportRequest, ApiCallback _callback) Build call for startBulkImport
ApiResponse<StartImportResponse>	startBulkImportWithHttpInfo(StartImportRequest startImportRequest) Start import The `start_import` operation starts an asynchronous import of vectors from object storage into an index.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkOperationsApi

public BulkOperationsApi()

BulkOperationsApi

public BulkOperationsApi(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 java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

cancelBulkImportCall

public okhttp3.Call cancelBulkImportCall(java.lang.String id,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for cancelBulkImport

Parameters:

id - (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	Operation cancelled successfully	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

cancelBulkImport

public java.lang.Object cancelBulkImport(java.lang.String id)
                                  throws ApiException

Cancel an import The `cancel_import` operation cancels an import operation if it is not yet finished. It has no effect if the operation is already finished. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

id - (required)

Returns:

Object

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	Operation cancelled successfully	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

cancelBulkImportWithHttpInfo

public ApiResponse<java.lang.Object> cancelBulkImportWithHttpInfo(java.lang.String id)
                                                           throws ApiException

Cancel an import The `cancel_import` operation cancels an import operation if it is not yet finished. It has no effect if the operation is already finished. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

id - (required)

Returns:

ApiResponse<Object>

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	Operation cancelled successfully	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

cancelBulkImportAsync

public okhttp3.Call cancelBulkImportAsync(java.lang.String id,
                                          ApiCallback<java.lang.Object> _callback)
                                   throws ApiException

Cancel an import (asynchronously) The `cancel_import` operation cancels an import operation if it is not yet finished. It has no effect if the operation is already finished. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

id - (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	Operation cancelled successfully	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeBulkImportCall

public okhttp3.Call describeBulkImportCall(java.lang.String id,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for describeBulkImport

Parameters:

id - (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	Details of the import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeBulkImport

public ImportModel describeBulkImport(java.lang.String id)
                               throws ApiException

Describe an import The `describe_import` operation returns details of a specific import operation. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

id - (required)

Returns:

ImportModel

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	Details of the import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeBulkImportWithHttpInfo

public ApiResponse<ImportModel> describeBulkImportWithHttpInfo(java.lang.String id)
                                                        throws ApiException

Describe an import The `describe_import` operation returns details of a specific import operation. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

id - (required)

Returns:

ApiResponse<ImportModel>

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	Details of the import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

describeBulkImportAsync

public okhttp3.Call describeBulkImportAsync(java.lang.String id,
                                            ApiCallback<ImportModel> _callback)
                                     throws ApiException

Describe an import (asynchronously) The `describe_import` operation returns details of a specific import operation. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

id - (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	Details of the import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listBulkImportsCall

public okhttp3.Call listBulkImportsCall(java.lang.Integer limit,
                                        java.lang.String paginationToken,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for listBulkImports

Parameters:

limit - Max number of operations to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (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	A list of import operations	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listBulkImports

public ListImportsResponse listBulkImports(java.lang.Integer limit,
                                           java.lang.String paginationToken)
                                    throws ApiException

List imports The `list_imports` operation lists all recent and ongoing import operations. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

limit - Max number of operations to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (optional)

Returns:

ListImportsResponse

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	A list of import operations	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listBulkImportsWithHttpInfo

public ApiResponse<ListImportsResponse> listBulkImportsWithHttpInfo(java.lang.Integer limit,
                                                                    java.lang.String paginationToken)
                                                             throws ApiException

List imports The `list_imports` operation lists all recent and ongoing import operations. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

limit - Max number of operations to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (optional)

Returns:

ApiResponse<ListImportsResponse>

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	A list of import operations	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

listBulkImportsAsync

public okhttp3.Call listBulkImportsAsync(java.lang.Integer limit,
                                         java.lang.String paginationToken,
                                         ApiCallback<ListImportsResponse> _callback)
                                  throws ApiException

List imports (asynchronously) The `list_imports` operation lists all recent and ongoing import operations. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

limit - Max number of operations to return per page. (optional)

paginationToken - Pagination token to continue a previous listing operation. (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	A list of import operations	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

startBulkImportCall

public okhttp3.Call startBulkImportCall(StartImportRequest startImportRequest,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for startBulkImport

Parameters:

startImportRequest - (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	Successful import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

startBulkImport

public StartImportResponse startBulkImport(StartImportRequest startImportRequest)
                                    throws ApiException

Start import The `start_import` operation starts an asynchronous import of vectors from object storage into an index. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

startImportRequest - (required)

Returns:

StartImportResponse

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	Successful import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

startBulkImportWithHttpInfo

public ApiResponse<StartImportResponse> startBulkImportWithHttpInfo(StartImportRequest startImportRequest)
                                                             throws ApiException

Start import The `start_import` operation starts an asynchronous import of vectors from object storage into an index. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

startImportRequest - (required)

Returns:

ApiResponse<StartImportResponse>

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	Successful import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-

startBulkImportAsync

public okhttp3.Call startBulkImportAsync(StartImportRequest startImportRequest,
                                         ApiCallback<StartImportResponse> _callback)
                                  throws ApiException

Start import (asynchronously) The `start_import` operation starts an asynchronous import of vectors from object storage into an index. For guidance and examples, see [Import data](https://docs.pinecone.io/guides/data/import-data).

Parameters:

startImportRequest - (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	Successful import operation	-
400	Bad request. The request body included invalid request parameters.	-
4XX	An unexpected error response.	-
5XX	An unexpected error response.	-