org.openapitools.db_control.client.api

Class ManageIndexesApi

java.lang.Object

org.openapitools.db_control.client.api.ManageIndexesApi

public class ManageIndexesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ManageIndexesApi()
ManageIndexesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IndexModel	configureIndex(java.lang.String indexName, ConfigureIndexRequest configureIndexRequest) Configure an index This operation configures an existing index.
okhttp3.Call	configureIndexAsync(java.lang.String indexName, ConfigureIndexRequest configureIndexRequest, ApiCallback<IndexModel> _callback) Configure an index (asynchronously) This operation configures an existing index.
okhttp3.Call	configureIndexCall(java.lang.String indexName, ConfigureIndexRequest configureIndexRequest, ApiCallback _callback) Build call for configureIndex
ApiResponse<IndexModel>	configureIndexWithHttpInfo(java.lang.String indexName, ConfigureIndexRequest configureIndexRequest) Configure an index This operation configures an existing index.
CollectionModel	createCollection(CreateCollectionRequest createCollectionRequest) Create a collection This operation creates a Pinecone collection.
okhttp3.Call	createCollectionAsync(CreateCollectionRequest createCollectionRequest, ApiCallback<CollectionModel> _callback) Create a collection (asynchronously) This operation creates a Pinecone collection.
okhttp3.Call	createCollectionCall(CreateCollectionRequest createCollectionRequest, ApiCallback _callback) Build call for createCollection
ApiResponse<CollectionModel>	createCollectionWithHttpInfo(CreateCollectionRequest createCollectionRequest) Create a collection This operation creates a Pinecone collection.
IndexModel	createIndex(CreateIndexRequest createIndexRequest) Create an index This operation deploys a Pinecone index.
okhttp3.Call	createIndexAsync(CreateIndexRequest createIndexRequest, ApiCallback<IndexModel> _callback) Create an index (asynchronously) This operation deploys a Pinecone index.
okhttp3.Call	createIndexCall(CreateIndexRequest createIndexRequest, ApiCallback _callback) Build call for createIndex
ApiResponse<IndexModel>	createIndexWithHttpInfo(CreateIndexRequest createIndexRequest) Create an index This operation deploys a Pinecone index.
void	deleteCollection(java.lang.String collectionName) Delete a collection This operation deletes an existing collection.
okhttp3.Call	deleteCollectionAsync(java.lang.String collectionName, ApiCallback<java.lang.Void> _callback) Delete a collection (asynchronously) This operation deletes an existing collection.
okhttp3.Call	deleteCollectionCall(java.lang.String collectionName, ApiCallback _callback) Build call for deleteCollection
ApiResponse<java.lang.Void>	deleteCollectionWithHttpInfo(java.lang.String collectionName) Delete a collection This operation deletes an existing collection.
void	deleteIndex(java.lang.String indexName) Delete an index This operation deletes an existing index.
okhttp3.Call	deleteIndexAsync(java.lang.String indexName, ApiCallback<java.lang.Void> _callback) Delete an index (asynchronously) This operation deletes an existing index.
okhttp3.Call	deleteIndexCall(java.lang.String indexName, ApiCallback _callback) Build call for deleteIndex
ApiResponse<java.lang.Void>	deleteIndexWithHttpInfo(java.lang.String indexName) Delete an index This operation deletes an existing index.
CollectionModel	describeCollection(java.lang.String collectionName) Describe a collection This operation gets a description of a collection.
okhttp3.Call	describeCollectionAsync(java.lang.String collectionName, ApiCallback<CollectionModel> _callback) Describe a collection (asynchronously) This operation gets a description of a collection.
okhttp3.Call	describeCollectionCall(java.lang.String collectionName, ApiCallback _callback) Build call for describeCollection
ApiResponse<CollectionModel>	describeCollectionWithHttpInfo(java.lang.String collectionName) Describe a collection This operation gets a description of a collection.
IndexModel	describeIndex(java.lang.String indexName) Describe an index Get a description of an index.
okhttp3.Call	describeIndexAsync(java.lang.String indexName, ApiCallback<IndexModel> _callback) Describe an index (asynchronously) Get a description of an index.
okhttp3.Call	describeIndexCall(java.lang.String indexName, ApiCallback _callback) Build call for describeIndex
ApiResponse<IndexModel>	describeIndexWithHttpInfo(java.lang.String indexName) Describe an index Get a description of an index.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
CollectionList	listCollections() List collections This operation returns a list of all collections in a project.
okhttp3.Call	listCollectionsAsync(ApiCallback<CollectionList> _callback) List collections (asynchronously) This operation returns a list of all collections in a project.
okhttp3.Call	listCollectionsCall(ApiCallback _callback) Build call for listCollections
ApiResponse<CollectionList>	listCollectionsWithHttpInfo() List collections This operation returns a list of all collections in a project.
IndexList	listIndexes() List indexes This operation returns a list of all indexes in a project.
okhttp3.Call	listIndexesAsync(ApiCallback<IndexList> _callback) List indexes (asynchronously) This operation returns a list of all indexes in a project.
okhttp3.Call	listIndexesCall(ApiCallback _callback) Build call for listIndexes
ApiResponse<IndexList>	listIndexesWithHttpInfo() List indexes This operation returns a list of all indexes in a project.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.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

ManageIndexesApi

public ManageIndexesApi()

ManageIndexesApi

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

configureIndexCall

public okhttp3.Call configureIndexCall(java.lang.String indexName,
                                       ConfigureIndexRequest configureIndexRequest,
                                       ApiCallback _callback)
                                throws ApiException

Build call for configureIndex

Parameters:

indexName - The name of the index to configure. (required)

configureIndexRequest - The desired pod size and replica configuration for the index. (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	The request to configure the index has been accepted. Check the index status to see when the change has been applied.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Index not found.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

configureIndex

public IndexModel configureIndex(java.lang.String indexName,
                                 ConfigureIndexRequest configureIndexRequest)
                          throws ApiException

Configure an index This operation configures an existing index. For serverless indexes, you can configure only index deletion protection and tags. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/create-an-index#create-an-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/configure-an-index).

Parameters:

indexName - The name of the index to configure. (required)

configureIndexRequest - The desired pod size and replica configuration for the index. (required)

Returns:

IndexModel

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	The request to configure the index has been accepted. Check the index status to see when the change has been applied.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Index not found.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

configureIndexWithHttpInfo

public ApiResponse<IndexModel> configureIndexWithHttpInfo(java.lang.String indexName,
                                                          ConfigureIndexRequest configureIndexRequest)
                                                   throws ApiException

Configure an index This operation configures an existing index. For serverless indexes, you can configure only index deletion protection and tags. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/create-an-index#create-an-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/configure-an-index).

Parameters:

indexName - The name of the index to configure. (required)

configureIndexRequest - The desired pod size and replica configuration for the index. (required)

Returns:

ApiResponse<IndexModel>

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	The request to configure the index has been accepted. Check the index status to see when the change has been applied.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Index not found.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

configureIndexAsync

public okhttp3.Call configureIndexAsync(java.lang.String indexName,
                                        ConfigureIndexRequest configureIndexRequest,
                                        ApiCallback<IndexModel> _callback)
                                 throws ApiException

Configure an index (asynchronously) This operation configures an existing index. For serverless indexes, you can configure only index deletion protection and tags. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/create-an-index#create-an-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/configure-an-index).

Parameters:

indexName - The name of the index to configure. (required)

configureIndexRequest - The desired pod size and replica configuration for the index. (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	The request to configure the index has been accepted. Check the index status to see when the change has been applied.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Index not found.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

createCollectionCall

public okhttp3.Call createCollectionCall(CreateCollectionRequest createCollectionRequest,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for createCollection

Parameters:

createCollectionRequest - The desired configuration for the collection. (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
201	The collection has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your collections quota.	-
409	Collection of given name already exists.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

createCollection

public CollectionModel createCollection(CreateCollectionRequest createCollectionRequest)
                                 throws ApiException

Create a collection This operation creates a Pinecone collection. Serverless indexes do not support collections.

Parameters:

createCollectionRequest - The desired configuration for the collection. (required)

Returns:

CollectionModel

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	The collection has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your collections quota.	-
409	Collection of given name already exists.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

createCollectionWithHttpInfo

public ApiResponse<CollectionModel> createCollectionWithHttpInfo(CreateCollectionRequest createCollectionRequest)
                                                          throws ApiException

Create a collection This operation creates a Pinecone collection. Serverless indexes do not support collections.

Parameters:

createCollectionRequest - The desired configuration for the collection. (required)

Returns:

ApiResponse<CollectionModel>

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	The collection has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your collections quota.	-
409	Collection of given name already exists.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

createCollectionAsync

public okhttp3.Call createCollectionAsync(CreateCollectionRequest createCollectionRequest,
                                          ApiCallback<CollectionModel> _callback)
                                   throws ApiException

Create a collection (asynchronously) This operation creates a Pinecone collection. Serverless indexes do not support collections.

Parameters:

createCollectionRequest - The desired configuration for the collection. (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
201	The collection has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your collections quota.	-
409	Collection of given name already exists.	-
422	Unprocessable entity. The request body could not be deserialized.	-
500	Internal server error.	-

createIndexCall

public okhttp3.Call createIndexCall(CreateIndexRequest createIndexRequest,
                                    ApiCallback _callback)
                             throws ApiException

Build call for createIndex

Parameters:

createIndexRequest - The desired configuration for the index. (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
201	The index has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Unknown cloud or region when creating a serverless index.	-
422	Unprocessable entity. The request body could not be deserialized.	-
409	Index of given name already exists.	-
500	Internal server error.	-

createIndex

public IndexModel createIndex(CreateIndexRequest createIndexRequest)
                       throws ApiException

Create an index This operation deploys a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index).

Parameters:

createIndexRequest - The desired configuration for the index. (required)

Returns:

IndexModel

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	The index has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Unknown cloud or region when creating a serverless index.	-
422	Unprocessable entity. The request body could not be deserialized.	-
409	Index of given name already exists.	-
500	Internal server error.	-

createIndexWithHttpInfo

public ApiResponse<IndexModel> createIndexWithHttpInfo(CreateIndexRequest createIndexRequest)
                                                throws ApiException

Create an index This operation deploys a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index).

Parameters:

createIndexRequest - The desired configuration for the index. (required)

Returns:

ApiResponse<IndexModel>

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	The index has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Unknown cloud or region when creating a serverless index.	-
422	Unprocessable entity. The request body could not be deserialized.	-
409	Index of given name already exists.	-
500	Internal server error.	-

createIndexAsync

public okhttp3.Call createIndexAsync(CreateIndexRequest createIndexRequest,
                                     ApiCallback<IndexModel> _callback)
                              throws ApiException

Create an index (asynchronously) This operation deploys a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index).

Parameters:

createIndexRequest - The desired configuration for the index. (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
201	The index has been successfully created.	-
400	Bad request. The request body included invalid request parameters.	-
401	Unauthorized. Possible causes: Invalid API key.	-
402	Payment required. Organization is on a paid plan and is delinquent on payment.	-
403	You've exceed your pod quota.	-
404	Unknown cloud or region when creating a serverless index.	-
422	Unprocessable entity. The request body could not be deserialized.	-
409	Index of given name already exists.	-
500	Internal server error.	-

deleteCollectionCall

public okhttp3.Call deleteCollectionCall(java.lang.String collectionName,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for deleteCollection

Parameters:

collectionName - The name of the collection. (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	The collection has been successfully deleted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

deleteCollection

public void deleteCollection(java.lang.String collectionName)
                      throws ApiException

Delete a collection This operation deletes an existing collection. Serverless indexes do not support collections.

Parameters:

collectionName - The name of the collection. (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
202	The collection has been successfully deleted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

deleteCollectionWithHttpInfo

public ApiResponse<java.lang.Void> deleteCollectionWithHttpInfo(java.lang.String collectionName)
                                                         throws ApiException

Delete a collection This operation deletes an existing collection. Serverless indexes do not support collections.

Parameters:

collectionName - The name of the collection. (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
202	The collection has been successfully deleted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

deleteCollectionAsync

public okhttp3.Call deleteCollectionAsync(java.lang.String collectionName,
                                          ApiCallback<java.lang.Void> _callback)
                                   throws ApiException

Delete a collection (asynchronously) This operation deletes an existing collection. Serverless indexes do not support collections.

Parameters:

collectionName - The name of the collection. (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	The collection has been successfully deleted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

deleteIndexCall

public okhttp3.Call deleteIndexCall(java.lang.String indexName,
                                    ApiCallback _callback)
                             throws ApiException

Build call for deleteIndex

Parameters:

indexName - The name of the index to delete. (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	The request to delete the index has been accepted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
403	Forbidden. Deletion protection enabled.	-
404	Index not found.	-
412	There is a pending collection created from this index.	-
500	Internal server error.	-

deleteIndex

public void deleteIndex(java.lang.String indexName)
                 throws ApiException

Delete an index This operation deletes an existing index.

Parameters:

indexName - The name of the index to delete. (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
202	The request to delete the index has been accepted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
403	Forbidden. Deletion protection enabled.	-
404	Index not found.	-
412	There is a pending collection created from this index.	-
500	Internal server error.	-

deleteIndexWithHttpInfo

public ApiResponse<java.lang.Void> deleteIndexWithHttpInfo(java.lang.String indexName)
                                                    throws ApiException

Delete an index This operation deletes an existing index.

Parameters:

indexName - The name of the index to delete. (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
202	The request to delete the index has been accepted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
403	Forbidden. Deletion protection enabled.	-
404	Index not found.	-
412	There is a pending collection created from this index.	-
500	Internal server error.	-

deleteIndexAsync

public okhttp3.Call deleteIndexAsync(java.lang.String indexName,
                                     ApiCallback<java.lang.Void> _callback)
                              throws ApiException

Delete an index (asynchronously) This operation deletes an existing index.

Parameters:

indexName - The name of the index to delete. (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	The request to delete the index has been accepted.	-
401	Unauthorized. Possible causes: Invalid API key.	-
403	Forbidden. Deletion protection enabled.	-
404	Index not found.	-
412	There is a pending collection created from this index.	-
500	Internal server error.	-

describeCollectionCall

public okhttp3.Call describeCollectionCall(java.lang.String collectionName,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for describeCollection

Parameters:

collectionName - The name of the collection to be described. (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	Configuration information and status of the collection.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

describeCollection

public CollectionModel describeCollection(java.lang.String collectionName)
                                   throws ApiException

Describe a collection This operation gets a description of a collection. Serverless indexes do not support collections.

Parameters:

collectionName - The name of the collection to be described. (required)

Returns:

CollectionModel

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	Configuration information and status of the collection.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

describeCollectionWithHttpInfo

public ApiResponse<CollectionModel> describeCollectionWithHttpInfo(java.lang.String collectionName)
                                                            throws ApiException

Describe a collection This operation gets a description of a collection. Serverless indexes do not support collections.

Parameters:

collectionName - The name of the collection to be described. (required)

Returns:

ApiResponse<CollectionModel>

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	Configuration information and status of the collection.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

describeCollectionAsync

public okhttp3.Call describeCollectionAsync(java.lang.String collectionName,
                                            ApiCallback<CollectionModel> _callback)
                                     throws ApiException

Describe a collection (asynchronously) This operation gets a description of a collection. Serverless indexes do not support collections.

Parameters:

collectionName - The name of the collection to be described. (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	Configuration information and status of the collection.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Collection not found.	-
500	Internal server error.	-

describeIndexCall

public okhttp3.Call describeIndexCall(java.lang.String indexName,
                                      ApiCallback _callback)
                               throws ApiException

Build call for describeIndex

Parameters:

indexName - The name of the index to be described. (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	Configuration information and deployment status of the index.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Index not found.	-
500	Internal server error.	-

describeIndex

public IndexModel describeIndex(java.lang.String indexName)
                         throws ApiException

Describe an index Get a description of an index.

Parameters:

indexName - The name of the index to be described. (required)

Returns:

IndexModel

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	Configuration information and deployment status of the index.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Index not found.	-
500	Internal server error.	-

describeIndexWithHttpInfo

public ApiResponse<IndexModel> describeIndexWithHttpInfo(java.lang.String indexName)
                                                  throws ApiException

Describe an index Get a description of an index.

Parameters:

indexName - The name of the index to be described. (required)

Returns:

ApiResponse<IndexModel>

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	Configuration information and deployment status of the index.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Index not found.	-
500	Internal server error.	-

describeIndexAsync

public okhttp3.Call describeIndexAsync(java.lang.String indexName,
                                       ApiCallback<IndexModel> _callback)
                                throws ApiException

Describe an index (asynchronously) Get a description of an index.

Parameters:

indexName - The name of the index to be described. (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	Configuration information and deployment status of the index.	-
401	Unauthorized. Possible causes: Invalid API key.	-
404	Index not found.	-
500	Internal server error.	-

listCollectionsCall

public okhttp3.Call listCollectionsCall(ApiCallback _callback)
                                 throws ApiException

Build call for listCollections

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	This operation returns a list of all the collections in your current project.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listCollections

public CollectionList listCollections()
                               throws ApiException

List collections This operation returns a list of all collections in a project. Serverless indexes do not support collections.

Returns:

CollectionList

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	This operation returns a list of all the collections in your current project.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listCollectionsWithHttpInfo

public ApiResponse<CollectionList> listCollectionsWithHttpInfo()
                                                        throws ApiException

List collections This operation returns a list of all collections in a project. Serverless indexes do not support collections.

Returns:

ApiResponse<CollectionList>

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	This operation returns a list of all the collections in your current project.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listCollectionsAsync

public okhttp3.Call listCollectionsAsync(ApiCallback<CollectionList> _callback)
                                  throws ApiException

List collections (asynchronously) This operation returns a list of all collections in a project. Serverless indexes do not support collections.

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	This operation returns a list of all the collections in your current project.	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listIndexesCall

public okhttp3.Call listIndexesCall(ApiCallback _callback)
                             throws ApiException

Build call for listIndexes

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	This operation returns a list of all the indexes that you have previously created, and which are associated with the given project	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listIndexes

public IndexList listIndexes()
                      throws ApiException

List indexes This operation returns a list of all indexes in a project.

Returns:

IndexList

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	This operation returns a list of all the indexes that you have previously created, and which are associated with the given project	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listIndexesWithHttpInfo

public ApiResponse<IndexList> listIndexesWithHttpInfo()
                                               throws ApiException

List indexes This operation returns a list of all indexes in a project.

Returns:

ApiResponse<IndexList>

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	This operation returns a list of all the indexes that you have previously created, and which are associated with the given project	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-

listIndexesAsync

public okhttp3.Call listIndexesAsync(ApiCallback<IndexList> _callback)
                              throws ApiException

List indexes (asynchronously) This operation returns a list of all indexes in a project.

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	This operation returns a list of all the indexes that you have previously created, and which are associated with the given project	-
401	Unauthorized. Possible causes: Invalid API key.	-
500	Internal server error.	-