org.openapitools.client.model

Class CreateIndexRequest

java.lang.Object

org.openapitools.client.model.CreateIndexRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-04-06T02:44:17.986783Z[Etc/UTC]")
public class CreateIndexRequest
extends java.lang.Object

The configuration needed to create a Pinecone index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateIndexRequest.CustomTypeAdapterFactory

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_DIMENSION
static java.lang.String	SERIALIZED_NAME_METRIC
static java.lang.String	SERIALIZED_NAME_NAME
static java.lang.String	SERIALIZED_NAME_SPEC

Constructor Summary

Constructors

Constructor and Description
CreateIndexRequest()

Method Summary

Modifier and Type	Method and Description
CreateIndexRequest	dimension(java.lang.Integer dimension)
boolean	equals(java.lang.Object o)
static CreateIndexRequest	fromJson(java.lang.String jsonString) Create an instance of CreateIndexRequest 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.
java.lang.Integer	getDimension() The dimensions of the vectors to be inserted in the index.
IndexMetric	getMetric() Get metric
java.lang.String	getName() The name of the index.
CreateIndexRequestSpec	getSpec() Get spec
int	hashCode()
CreateIndexRequest	metric(IndexMetric metric)
CreateIndexRequest	name(java.lang.String name)
CreateIndexRequest	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setDimension(java.lang.Integer dimension)
void	setMetric(IndexMetric metric)
void	setName(java.lang.String name)
void	setSpec(CreateIndexRequestSpec spec)
CreateIndexRequest	spec(CreateIndexRequestSpec spec)
java.lang.String	toJson() Convert an instance of CreateIndexRequest 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_SPEC

public static final java.lang.String SERIALIZED_NAME_SPEC

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

CreateIndexRequest

public CreateIndexRequest()

Method Detail

name

public CreateIndexRequest 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 CreateIndexRequest 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 CreateIndexRequest metric(IndexMetric metric)

getMetric

@Nullable
public IndexMetric getMetric()

Get metric

Returns:

metric

setMetric

public void setMetric(IndexMetric metric)

spec

public CreateIndexRequest spec(CreateIndexRequestSpec spec)

getSpec

@Nullable
public CreateIndexRequestSpec getSpec()

Get spec

Returns:

spec

setSpec

public void setSpec(CreateIndexRequestSpec spec)

putAdditionalProperty

public CreateIndexRequest 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 CreateIndexRequest 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 CreateIndexRequest

fromJson

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

Create an instance of CreateIndexRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateIndexRequest

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of CreateIndexRequest to an JSON string

Returns:

JSON string