org.openapitools.control.client.model

Class IndexSpec

java.lang.Object

org.openapitools.control.client.model.IndexSpec

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-07-18T20:37:01.807093Z[Etc/UTC]")
public class IndexSpec
extends java.lang.Object

The spec object defines how the index should be deployed. For serverless indexes, you define only the [cloud and region](http://docs.pinecone.io/guides/indexes/understanding-indexes#cloud-regions) where the index should be hosted. For pod-based indexes, you define the [environment](http://docs.pinecone.io/guides/indexes/understanding-indexes#pod-environments) where the index should be hosted, the [pod type and size](http://docs.pinecone.io/guides/indexes/understanding-indexes#pod-types) to use, and other index characteristics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexSpec.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_POD
static java.lang.String	SERIALIZED_NAME_SERVERLESS

Constructor Summary

Constructors

Constructor and Description
IndexSpec()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static IndexSpec	fromJson(java.lang.String jsonString) Create an instance of IndexSpec given an JSON string
PodSpec	getPod() Get pod
ServerlessSpec	getServerless() Get serverless
int	hashCode()
IndexSpec	pod(PodSpec pod)
IndexSpec	serverless(ServerlessSpec serverless)
void	setPod(PodSpec pod)
void	setServerless(ServerlessSpec serverless)
java.lang.String	toJson() Convert an instance of IndexSpec 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_SERVERLESS

public static final java.lang.String SERIALIZED_NAME_SERVERLESS

See Also:

Constant Field Values

SERIALIZED_NAME_POD

public static final java.lang.String SERIALIZED_NAME_POD

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

IndexSpec

public IndexSpec()

Method Detail

serverless

public IndexSpec serverless(ServerlessSpec serverless)

getServerless

@Nullable
public ServerlessSpec getServerless()

Get serverless

Returns:

serverless

setServerless

public void setServerless(ServerlessSpec serverless)

pod

public IndexSpec pod(PodSpec pod)

getPod

@Nullable
public PodSpec getPod()

Get pod

Returns:

pod

setPod

public void setPod(PodSpec pod)

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 IndexSpec

fromJson

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

Create an instance of IndexSpec given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of IndexSpec

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of IndexSpec to an JSON string

Returns:

JSON string