IndexDescription (pinecone-java-client 3.0.0 API)

java.lang.Object
- org.openapitools.db_data.client.model.IndexDescription

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

The response for the `describe_index_stats` operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IndexDescription.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexDescription.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_INDEX_FULLNESS`
`static java.lang.String`	`SERIALIZED_NAME_NAMESPACES`
`static java.lang.String`	`SERIALIZED_NAME_TOTAL_VECTOR_COUNT`

Constructor Summary

Constructors
Constructor and Description

IndexDescription()

Constructors
Constructor and Description
`IndexDescription()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexDescription`	`dimension(java.lang.Long dimension)`
`boolean`	`equals(java.lang.Object o)`
`static IndexDescription`	`fromJson(java.lang.String jsonString)` Create an instance of IndexDescription 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.Long`	`getDimension()` The dimension of the indexed vectors.
`java.lang.Float`	`getIndexFullness()` The fullness of the index, regardless of whether a metadata filter expression was passed.
`java.util.Map<java.lang.String,NamespaceSummary>`	`getNamespaces()` A mapping for each namespace in the index from the namespace name to a summary of its contents.
`java.lang.Long`	`getTotalVectorCount()` The total number of vectors in the index, regardless of whether a metadata filter expression was passed
`int`	`hashCode()`
`IndexDescription`	`indexFullness(java.lang.Float indexFullness)`
`IndexDescription`	`namespaces(java.util.Map<java.lang.String,NamespaceSummary> namespaces)`
`IndexDescription`	`putAdditionalProperty(java.lang.String key, java.lang.Object value)` Set the additional (undeclared) property with the specified name and value.
`IndexDescription`	`putNamespacesItem(java.lang.String key, NamespaceSummary namespacesItem)`
`void`	`setDimension(java.lang.Long dimension)`
`void`	`setIndexFullness(java.lang.Float indexFullness)`
`void`	`setNamespaces(java.util.Map<java.lang.String,NamespaceSummary> namespaces)`
`void`	`setTotalVectorCount(java.lang.Long totalVectorCount)`
`java.lang.String`	`toJson()` Convert an instance of IndexDescription to an JSON string
`java.lang.String`	`toString()`
`IndexDescription`	`totalVectorCount(java.lang.Long totalVectorCount)`
`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_NAMESPACES
```
public static final java.lang.String SERIALIZED_NAME_NAMESPACES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DIMENSION
```
public static final java.lang.String SERIALIZED_NAME_DIMENSION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INDEX_FULLNESS
```
public static final java.lang.String SERIALIZED_NAME_INDEX_FULLNESS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOTAL_VECTOR_COUNT
```
public static final java.lang.String SERIALIZED_NAME_TOTAL_VECTOR_COUNT
```
    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
  - IndexDescription
```
public IndexDescription()
```
- Method Detail
  - namespaces
```
public IndexDescription namespaces(java.util.Map<java.lang.String,NamespaceSummary> namespaces)
```
  - putNamespacesItem
```
public IndexDescription putNamespacesItem(java.lang.String key,
                                          NamespaceSummary namespacesItem)
```
  - getNamespaces
```
@Nullable
public java.util.Map<java.lang.String,NamespaceSummary> getNamespaces()
```
    A mapping for each namespace in the index from the namespace name to a summary of its contents. If a metadata filter expression is present, the summary will reflect only vectors matching that expression.
    
    Returns:
    
    namespaces
  - setNamespaces
```
public void setNamespaces(java.util.Map<java.lang.String,NamespaceSummary> namespaces)
```
  - dimension
```
public IndexDescription dimension(java.lang.Long dimension)
```
  - getDimension
```
@Nullable
public java.lang.Long getDimension()
```
    The dimension of the indexed vectors.
    
    Returns:
    
    dimension
  - setDimension
```
public void setDimension(java.lang.Long dimension)
```
  - indexFullness
```
public IndexDescription indexFullness(java.lang.Float indexFullness)
```
  - getIndexFullness
```
@Nullable
public java.lang.Float getIndexFullness()
```
    The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%. Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes. The index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use [`describe_index`](https://docs.pinecone.io/reference/api/control-plane/describe_index).
    
    Returns:
    
    indexFullness
  - setIndexFullness
```
public void setIndexFullness(java.lang.Float indexFullness)
```
  - totalVectorCount
```
public IndexDescription totalVectorCount(java.lang.Long totalVectorCount)
```
  - getTotalVectorCount
```
@Nullable
public java.lang.Long getTotalVectorCount()
```
    The total number of vectors in the index, regardless of whether a metadata filter expression was passed
    
    Returns:
    
    totalVectorCount
  - setTotalVectorCount
```
public void setTotalVectorCount(java.lang.Long totalVectorCount)
```
  - putAdditionalProperty
```
public IndexDescription 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 IndexDescription 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 IndexDescription
  - fromJson
```
public static IndexDescription fromJson(java.lang.String jsonString)
                                 throws java.io.IOException
```
    Create an instance of IndexDescription given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of IndexDescription
    
    Throws:
    
    java.io.IOException - if the JSON string is invalid with respect to IndexDescription
  - toJson
```
public java.lang.String toJson()
```
    Convert an instance of IndexDescription to an JSON string
    
    Returns:
    
    JSON string

Class IndexDescription

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_NAMESPACES

SERIALIZED_NAME_DIMENSION

SERIALIZED_NAME_INDEX_FULLNESS

SERIALIZED_NAME_TOTAL_VECTOR_COUNT

openapiFields

openapiRequiredFields

Constructor Detail

IndexDescription

Method Detail

namespaces

putNamespacesItem

getNamespaces

setNamespaces

dimension

getDimension

setDimension

indexFullness

getIndexFullness

setIndexFullness

totalVectorCount

getTotalVectorCount

setTotalVectorCount

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson