org.openapitools.client.model

Class PodSpecMetadataConfig

java.lang.Object

org.openapitools.client.model.PodSpecMetadataConfig

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

Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when `metadata_config` is present, only specified metadata fields are indexed. These configurations are only valid for use with pod-based indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PodSpecMetadataConfig.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_INDEXED

Constructor Summary

Constructors

Constructor and Description
PodSpecMetadataConfig()

Method Summary

Modifier and Type	Method and Description
PodSpecMetadataConfig	addIndexedItem(java.lang.String indexedItem)
boolean	equals(java.lang.Object o)
static PodSpecMetadataConfig	fromJson(java.lang.String jsonString) Create an instance of PodSpecMetadataConfig 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.util.List<java.lang.String>	getIndexed() By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields that should be indexed.
int	hashCode()
PodSpecMetadataConfig	indexed(java.util.List<java.lang.String> indexed)
PodSpecMetadataConfig	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setIndexed(java.util.List<java.lang.String> indexed)
java.lang.String	toJson() Convert an instance of PodSpecMetadataConfig 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_INDEXED

public static final java.lang.String SERIALIZED_NAME_INDEXED

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

PodSpecMetadataConfig

public PodSpecMetadataConfig()

Method Detail

indexed

public PodSpecMetadataConfig indexed(java.util.List<java.lang.String> indexed)

addIndexedItem

public PodSpecMetadataConfig addIndexedItem(java.lang.String indexedItem)

getIndexed

@Nullable
public java.util.List<java.lang.String> getIndexed()

By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields that should be indexed.

Returns:

indexed

setIndexed

public void setIndexed(java.util.List<java.lang.String> indexed)

putAdditionalProperty

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

fromJson

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

Create an instance of PodSpecMetadataConfig given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PodSpecMetadataConfig

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of PodSpecMetadataConfig to an JSON string

Returns:

JSON string