io.pinecone.model

Class CreateIndexRequest

java.lang.Object

io.pinecone.model.CreateIndexRequest

public class CreateIndexRequest
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CreateIndexRequest()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getDimension() The dimensions of the vectors to be inserted in the index
java.lang.String	getIndexName() The name of the index to be created.
IndexMetadataConfig	getMetadataConfig() Get metadataConfig
java.lang.String	getMetric() The distance metric to be used for similarity search.
java.lang.Integer	getPods() The number of pods for the index to use,including replicas.
java.lang.String	getPodType() The type of pod to use.
java.lang.Integer	getReplicas() The number of replicas.
java.lang.String	getSourceCollection() The name of the collection to create an index from
void	setDimension(java.lang.Integer dimension)
void	setIndexName(java.lang.String indexName)
void	setMetadataConfig(IndexMetadataConfig metadataConfig)
void	setMetric(java.lang.String metric)
void	setPods(java.lang.Integer pods)
void	setPodType(java.lang.String podType)
void	setReplicas(java.lang.Integer replicas)
void	setSourceCollection(java.lang.String sourceCollection)
java.lang.String	toJson()
static void	validateJsonObject(com.fasterxml.jackson.databind.JsonNode jsonNode)
CreateIndexRequest	withDimension(java.lang.Integer dimension)
CreateIndexRequest	withIndexName(java.lang.String name)
CreateIndexRequest	withMetadataConfig(IndexMetadataConfig metadataConfig)
CreateIndexRequest	withMetric(java.lang.String metric)
CreateIndexRequest	withPods(java.lang.Integer pods)
CreateIndexRequest	withPodType(java.lang.String podType)
CreateIndexRequest	withReplicas(java.lang.Integer replicas)
CreateIndexRequest	withSourceCollection(java.lang.String sourceCollection)

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateIndexRequest

public CreateIndexRequest()

Method Detail

withIndexName

public CreateIndexRequest withIndexName(java.lang.String name)

getIndexName

@Nonnull
public java.lang.String getIndexName()

The name of the index to be created. The maximum length is 45 characters.

Returns:

name

setIndexName

public void setIndexName(java.lang.String indexName)

withDimension

public CreateIndexRequest withDimension(java.lang.Integer dimension)

getDimension

@Nonnull
public java.lang.Integer getDimension()

The dimensions of the vectors to be inserted in the index

Returns:

dimension

setDimension

public void setDimension(java.lang.Integer dimension)

withMetric

public CreateIndexRequest withMetric(java.lang.String metric)

getMetric

public java.lang.String getMetric()

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

Returns:

metric

setMetric

public void setMetric(java.lang.String metric)

withPods

public CreateIndexRequest withPods(java.lang.Integer pods)

getPods

public java.lang.Integer getPods()

The number of pods for the index to use,including replicas.

Returns:

pods

setPods

public void setPods(java.lang.Integer pods)

withReplicas

public CreateIndexRequest withReplicas(java.lang.Integer replicas)

getReplicas

public java.lang.Integer getReplicas()

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput.

Returns:

replicas

setReplicas

public void setReplicas(java.lang.Integer replicas)

withPodType

public CreateIndexRequest withPodType(java.lang.String podType)

getPodType

public java.lang.String getPodType()

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

Returns:

podType

setPodType

public void setPodType(java.lang.String podType)

withMetadataConfig

public CreateIndexRequest withMetadataConfig(IndexMetadataConfig metadataConfig)

getMetadataConfig

@Nullable
public IndexMetadataConfig getMetadataConfig()

Get metadataConfig

Returns:

metadataConfig

setMetadataConfig

public void setMetadataConfig(IndexMetadataConfig metadataConfig)

withSourceCollection

public CreateIndexRequest withSourceCollection(java.lang.String sourceCollection)

getSourceCollection

@Nullable
public java.lang.String getSourceCollection()

The name of the collection to create an index from

Returns:

sourceCollection

setSourceCollection

public void setSourceCollection(java.lang.String sourceCollection)

toJson

public java.lang.String toJson()
                        throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

validateJsonObject

public static void validateJsonObject(com.fasterxml.jackson.databind.JsonNode jsonNode)