org.openapitools.client.model

Class CollectionModel

java.lang.Object

org.openapitools.client.model.CollectionModel

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

The CollectionModel describes the configuration and status of a Pinecone collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionModel.CustomTypeAdapterFactory
static class	CollectionModel.StatusEnum The status of the collection.

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_ENVIRONMENT
static java.lang.String	SERIALIZED_NAME_NAME
static java.lang.String	SERIALIZED_NAME_SIZE
static java.lang.String	SERIALIZED_NAME_STATUS
static java.lang.String	SERIALIZED_NAME_VECTOR_COUNT

Constructor Summary

Constructors

Constructor and Description
CollectionModel()

Method Summary

Modifier and Type	Method and Description
CollectionModel	dimension(java.lang.Integer dimension)
CollectionModel	environment(java.lang.String environment)
boolean	equals(java.lang.Object o)
static CollectionModel	fromJson(java.lang.String jsonString) Create an instance of CollectionModel 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.Integer	getDimension() The dimension of the vectors stored in each record held in the collection.
java.lang.String	getEnvironment() The environment where the collection is hosted.
java.lang.String	getName() Get name
java.lang.Long	getSize() The size of the collection in bytes.
CollectionModel.StatusEnum	getStatus() The status of the collection.
java.lang.Integer	getVectorCount() The number of records stored in the collection.
int	hashCode()
CollectionModel	name(java.lang.String name)
CollectionModel	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setDimension(java.lang.Integer dimension)
void	setEnvironment(java.lang.String environment)
void	setName(java.lang.String name)
void	setSize(java.lang.Long size)
void	setStatus(CollectionModel.StatusEnum status)
void	setVectorCount(java.lang.Integer vectorCount)
CollectionModel	size(java.lang.Long size)
CollectionModel	status(CollectionModel.StatusEnum status)
java.lang.String	toJson() Convert an instance of CollectionModel 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
CollectionModel	vectorCount(java.lang.Integer vectorCount)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_NAME

public static final java.lang.String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_SIZE

public static final java.lang.String SERIALIZED_NAME_SIZE

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final java.lang.String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_DIMENSION

public static final java.lang.String SERIALIZED_NAME_DIMENSION

See Also:

Constant Field Values

SERIALIZED_NAME_VECTOR_COUNT

public static final java.lang.String SERIALIZED_NAME_VECTOR_COUNT

See Also:

Constant Field Values

SERIALIZED_NAME_ENVIRONMENT

public static final java.lang.String SERIALIZED_NAME_ENVIRONMENT

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

CollectionModel

public CollectionModel()

Method Detail

name

public CollectionModel name(java.lang.String name)

getName

@Nonnull
public java.lang.String getName()

Get name

Returns:

name

setName

public void setName(java.lang.String name)

size

public CollectionModel size(java.lang.Long size)

getSize

@Nullable
public java.lang.Long getSize()

The size of the collection in bytes.

Returns:

size

setSize

public void setSize(java.lang.Long size)

status

public CollectionModel status(CollectionModel.StatusEnum status)

getStatus

@Nonnull
public CollectionModel.StatusEnum getStatus()

The status of the collection.

Returns:

status

setStatus

public void setStatus(CollectionModel.StatusEnum status)

dimension

public CollectionModel dimension(java.lang.Integer dimension)

getDimension

@Nullable
public java.lang.Integer getDimension()

The dimension of the vectors stored in each record held in the collection. minimum: 1 maximum: 2000

Returns:

dimension

setDimension

public void setDimension(java.lang.Integer dimension)

vectorCount

public CollectionModel vectorCount(java.lang.Integer vectorCount)

getVectorCount

@Nullable
public java.lang.Integer getVectorCount()

The number of records stored in the collection.

Returns:

vectorCount

setVectorCount

public void setVectorCount(java.lang.Integer vectorCount)

environment

public CollectionModel environment(java.lang.String environment)

getEnvironment

@Nonnull
public java.lang.String getEnvironment()

The environment where the collection is hosted.

Returns:

environment

setEnvironment

public void setEnvironment(java.lang.String environment)

putAdditionalProperty

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

fromJson

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

Create an instance of CollectionModel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CollectionModel

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of CollectionModel to an JSON string

Returns:

JSON string