PodSpec (pinecone-java-client 1.2.1 API)

java.lang.Object
- org.openapitools.client.model.PodSpec

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

Configuration needed to deploy a pod-based index.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PodSpec.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`PodSpec.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_ENVIRONMENT`
`static java.lang.String`	`SERIALIZED_NAME_METADATA_CONFIG`
`static java.lang.String`	`SERIALIZED_NAME_POD_TYPE`
`static java.lang.String`	`SERIALIZED_NAME_PODS`
`static java.lang.String`	`SERIALIZED_NAME_REPLICAS`
`static java.lang.String`	`SERIALIZED_NAME_SHARDS`
`static java.lang.String`	`SERIALIZED_NAME_SOURCE_COLLECTION`

Constructor Summary

Constructors
Constructor and Description

PodSpec()

Constructors
Constructor and Description
`PodSpec()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PodSpec`	`environment(java.lang.String environment)`
`boolean`	`equals(java.lang.Object o)`
`static PodSpec`	`fromJson(java.lang.String jsonString)` Create an instance of PodSpec 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.String`	`getEnvironment()` The environment where the index is hosted.
`PodSpecMetadataConfig`	`getMetadataConfig()` Get metadataConfig
`java.lang.Integer`	`getPods()` The number of pods to be used in the index.
`java.lang.String`	`getPodType()` The type of pod to use.
`java.lang.Integer`	`getReplicas()` The number of replicas.
`java.lang.Integer`	`getShards()` The number of shards.
`java.lang.String`	`getSourceCollection()` The name of the collection to be used as the source for the index.
`int`	`hashCode()`
`PodSpec`	`metadataConfig(PodSpecMetadataConfig metadataConfig)`
`PodSpec`	`pods(java.lang.Integer pods)`
`PodSpec`	`podType(java.lang.String podType)`
`PodSpec`	`putAdditionalProperty(java.lang.String key, java.lang.Object value)` Set the additional (undeclared) property with the specified name and value.
`PodSpec`	`replicas(java.lang.Integer replicas)`
`void`	`setEnvironment(java.lang.String environment)`
`void`	`setMetadataConfig(PodSpecMetadataConfig metadataConfig)`
`void`	`setPods(java.lang.Integer pods)`
`void`	`setPodType(java.lang.String podType)`
`void`	`setReplicas(java.lang.Integer replicas)`
`void`	`setShards(java.lang.Integer shards)`
`void`	`setSourceCollection(java.lang.String sourceCollection)`
`PodSpec`	`shards(java.lang.Integer shards)`
`PodSpec`	`sourceCollection(java.lang.String sourceCollection)`
`java.lang.String`	`toJson()` Convert an instance of PodSpec 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_ENVIRONMENT
```
public static final java.lang.String SERIALIZED_NAME_ENVIRONMENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REPLICAS
```
public static final java.lang.String SERIALIZED_NAME_REPLICAS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SHARDS
```
public static final java.lang.String SERIALIZED_NAME_SHARDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_POD_TYPE
```
public static final java.lang.String SERIALIZED_NAME_POD_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PODS
```
public static final java.lang.String SERIALIZED_NAME_PODS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_METADATA_CONFIG
```
public static final java.lang.String SERIALIZED_NAME_METADATA_CONFIG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SOURCE_COLLECTION
```
public static final java.lang.String SERIALIZED_NAME_SOURCE_COLLECTION
```
    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
  - PodSpec
```
public PodSpec()
```
- Method Detail
  - environment
```
public PodSpec environment(java.lang.String environment)
```
  - getEnvironment
```
@Nonnull
public java.lang.String getEnvironment()
```
    The environment where the index is hosted.
    
    Returns:
    
    environment
  - setEnvironment
```
public void setEnvironment(java.lang.String environment)
```
  - replicas
```
public PodSpec replicas(java.lang.Integer replicas)
```
  - getReplicas
```
@Nonnull
public java.lang.Integer getReplicas()
```
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change. minimum: 1
    
    Returns:
    
    replicas
  - setReplicas
```
public void setReplicas(java.lang.Integer replicas)
```
  - shards
```
public PodSpec shards(java.lang.Integer shards)
```
  - getShards
```
@Nonnull
public java.lang.Integer getShards()
```
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index. minimum: 1
    
    Returns:
    
    shards
  - setShards
```
public void setShards(java.lang.Integer shards)
```
  - podType
```
public PodSpec podType(java.lang.String podType)
```
  - getPodType
```
@Nonnull
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)
```
  - pods
```
public PodSpec pods(java.lang.Integer pods)
```
  - getPods
```
@Nonnull
public java.lang.Integer getPods()
```
    The number of pods to be used in the index. This should be equal to `shards` x `replicas`.' minimum: 1
    
    Returns:
    
    pods
  - setPods
```
public void setPods(java.lang.Integer pods)
```
  - metadataConfig
```
public PodSpec metadataConfig(PodSpecMetadataConfig metadataConfig)
```
  - getMetadataConfig
```
@Nullable
public PodSpecMetadataConfig getMetadataConfig()
```
    Get metadataConfig
    
    Returns:
    
    metadataConfig
  - setMetadataConfig
```
public void setMetadataConfig(PodSpecMetadataConfig metadataConfig)
```
  - sourceCollection
```
public PodSpec sourceCollection(java.lang.String sourceCollection)
```
  - getSourceCollection
```
@Nullable
public java.lang.String getSourceCollection()
```
    The name of the collection to be used as the source for the index.
    
    Returns:
    
    sourceCollection
  - setSourceCollection
```
public void setSourceCollection(java.lang.String sourceCollection)
```
  - putAdditionalProperty
```
public PodSpec 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 PodSpec 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 PodSpec
  - fromJson
```
public static PodSpec fromJson(java.lang.String jsonString)
                        throws java.io.IOException
```
    Create an instance of PodSpec given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PodSpec
    
    Throws:
    
    java.io.IOException - if the JSON string is invalid with respect to PodSpec
  - toJson
```
public java.lang.String toJson()
```
    Convert an instance of PodSpec to an JSON string
    
    Returns:
    
    JSON string

Class PodSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ENVIRONMENT

SERIALIZED_NAME_REPLICAS

SERIALIZED_NAME_SHARDS

SERIALIZED_NAME_POD_TYPE

SERIALIZED_NAME_PODS

SERIALIZED_NAME_METADATA_CONFIG

SERIALIZED_NAME_SOURCE_COLLECTION

openapiFields

openapiRequiredFields

Constructor Detail

PodSpec

Method Detail

environment

getEnvironment

setEnvironment

replicas

getReplicas

setReplicas

shards

getShards

setShards

podType

getPodType

setPodType

pods

getPods

setPods

metadataConfig

getMetadataConfig

setMetadataConfig

sourceCollection

getSourceCollection

setSourceCollection

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson