org.openapitools.db_control.client.model

Class IndexModel

java.lang.Object

org.openapitools.db_control.client.model.IndexModel

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-23T20:47:10.542209Z[Etc/UTC]")
public class IndexModel
extends java.lang.Object

The IndexModel describes the configuration and status of a Pinecone index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexModel.CustomTypeAdapterFactory
static class	IndexModel.MetricEnum The distance metric to be used for similarity search.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_DELETION_PROTECTION
static java.lang.String	SERIALIZED_NAME_DIMENSION
static java.lang.String	SERIALIZED_NAME_HOST
static java.lang.String	SERIALIZED_NAME_METRIC
static java.lang.String	SERIALIZED_NAME_NAME
static java.lang.String	SERIALIZED_NAME_SPEC
static java.lang.String	SERIALIZED_NAME_STATUS
static java.lang.String	SERIALIZED_NAME_TAGS

Constructor Summary

Constructors

Constructor and Description
IndexModel()

Method Summary

Modifier and Type	Method and Description
IndexModel	deletionProtection(DeletionProtection deletionProtection)
IndexModel	dimension(java.lang.Integer dimension)
boolean	equals(java.lang.Object o)
static IndexModel	fromJson(java.lang.String jsonString) Create an instance of IndexModel given an JSON string
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties() Return the additional (undeclared) property.
java.lang.Object	getAdditionalProperty(java.lang.String key) Return the additional (undeclared) property with the specified name.
DeletionProtection	getDeletionProtection() Get deletionProtection
java.lang.Integer	getDimension() The dimensions of the vectors to be inserted in the index.
java.lang.String	getHost() The URL address where the index is hosted.
IndexModel.MetricEnum	getMetric() The distance metric to be used for similarity search.
java.lang.String	getName() The name of the index.
IndexModelSpec	getSpec() Get spec
IndexModelStatus	getStatus() Get status
java.util.Map<java.lang.String,java.lang.String>	getTags() Custom user tags added to an index.
int	hashCode()
IndexModel	host(java.lang.String host)
IndexModel	metric(IndexModel.MetricEnum metric)
IndexModel	name(java.lang.String name)
IndexModel	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
IndexModel	putTagsItem(java.lang.String key, java.lang.String tagsItem)
void	setDeletionProtection(DeletionProtection deletionProtection)
void	setDimension(java.lang.Integer dimension)
void	setHost(java.lang.String host)
void	setMetric(IndexModel.MetricEnum metric)
void	setName(java.lang.String name)
void	setSpec(IndexModelSpec spec)
void	setStatus(IndexModelStatus status)
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags)
IndexModel	spec(IndexModelSpec spec)
IndexModel	status(IndexModelStatus status)
IndexModel	tags(java.util.Map<java.lang.String,java.lang.String> tags)
java.lang.String	toJson() Convert an instance of IndexModel to an JSON string
java.lang.String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_NAME

public static final java.lang.String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_DIMENSION

public static final java.lang.String SERIALIZED_NAME_DIMENSION

See Also:

Constant Field Values

SERIALIZED_NAME_METRIC

public static final java.lang.String SERIALIZED_NAME_METRIC

See Also:

Constant Field Values

SERIALIZED_NAME_HOST

public static final java.lang.String SERIALIZED_NAME_HOST

See Also:

Constant Field Values

SERIALIZED_NAME_DELETION_PROTECTION

public static final java.lang.String SERIALIZED_NAME_DELETION_PROTECTION

See Also:

Constant Field Values

SERIALIZED_NAME_TAGS

public static final java.lang.String SERIALIZED_NAME_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_SPEC

public static final java.lang.String SERIALIZED_NAME_SPEC

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final java.lang.String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

IndexModel

public IndexModel()

Method Detail

name

public IndexModel name(java.lang.String name)

getName

@Nonnull
public java.lang.String getName()

The name of the index. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Returns:

name

setName

public void setName(java.lang.String name)

dimension

public IndexModel dimension(java.lang.Integer dimension)

getDimension

@Nonnull
public java.lang.Integer getDimension()

The dimensions of the vectors to be inserted in the index. minimum: 1 maximum: 20000

Returns:

dimension

setDimension

public void setDimension(java.lang.Integer dimension)

metric

public IndexModel metric(IndexModel.MetricEnum metric)

getMetric

@Nonnull
public IndexModel.MetricEnum getMetric()

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

Returns:

metric

setMetric

public void setMetric(IndexModel.MetricEnum metric)

host

public IndexModel host(java.lang.String host)

getHost

@Nonnull
public java.lang.String getHost()

The URL address where the index is hosted.

Returns:

host

setHost

public void setHost(java.lang.String host)

deletionProtection

public IndexModel deletionProtection(DeletionProtection deletionProtection)

getDeletionProtection

@Nullable
public DeletionProtection getDeletionProtection()

Get deletionProtection

Returns:

deletionProtection

setDeletionProtection

public void setDeletionProtection(DeletionProtection deletionProtection)

tags

public IndexModel tags(java.util.Map<java.lang.String,java.lang.String> tags)

putTagsItem

public IndexModel putTagsItem(java.lang.String key,
                              java.lang.String tagsItem)

getTags

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getTags()

Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.

Returns:

tags

setTags

public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)

spec

public IndexModel spec(IndexModelSpec spec)

getSpec

@Nonnull
public IndexModelSpec getSpec()

Get spec

Returns:

spec

setSpec

public void setSpec(IndexModelSpec spec)

status

public IndexModel status(IndexModelStatus status)

getStatus

@Nonnull
public IndexModelStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(IndexModelStatus status)

putAdditionalProperty

public IndexModel putAdditionalProperty(java.lang.String key,
                                        java.lang.Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the IndexModel instance itself

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public java.lang.Object getAdditionalProperty(java.lang.String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

java.io.IOException - if the JSON Element is invalid with respect to IndexModel

fromJson

public static IndexModel fromJson(java.lang.String jsonString)
                           throws java.io.IOException

Create an instance of IndexModel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of IndexModel

Throws:

java.io.IOException - if the JSON string is invalid with respect to IndexModel

toJson

public java.lang.String toJson()

Convert an instance of IndexModel to an JSON string

Returns:

JSON string