org.openapitools.db_data.client.model

Class DescribeIndexStatsRequest

java.lang.Object

org.openapitools.db_data.client.model.DescribeIndexStatsRequest

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

The request for the `describe_index_stats` operation.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DescribeIndexStatsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
DescribeIndexStatsRequest	filter(java.lang.Object filter)
static DescribeIndexStatsRequest	fromJson(java.lang.String jsonString) Create an instance of DescribeIndexStatsRequest 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.Object	getFilter() If this parameter is present, the operation only returns statistics for vectors that satisfy the filter.
int	hashCode()
DescribeIndexStatsRequest	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setFilter(java.lang.Object filter)
java.lang.String	toJson() Convert an instance of DescribeIndexStatsRequest 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_FILTER

public static final java.lang.String SERIALIZED_NAME_FILTER

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

DescribeIndexStatsRequest

public DescribeIndexStatsRequest()

Method Detail

filter

public DescribeIndexStatsRequest filter(java.lang.Object filter)

getFilter

@Nullable
public java.lang.Object getFilter()

If this parameter is present, the operation only returns statistics for vectors that satisfy the filter. See [Filter with metadata](https://docs.pinecone.io/guides/data/filter-with-metadata). Serverless indexes do not support filtering `describe_index_stats` by metadata.

Returns:

filter

setFilter

public void setFilter(java.lang.Object filter)

putAdditionalProperty

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

fromJson

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

Create an instance of DescribeIndexStatsRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DescribeIndexStatsRequest

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of DescribeIndexStatsRequest to an JSON string

Returns:

JSON string