org.openapitools.client.model

Class CreateCollectionRequest

java.lang.Object

org.openapitools.client.model.CreateCollectionRequest

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

The configuration needed to create a Pinecone collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateCollectionRequest.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_NAME
static java.lang.String	SERIALIZED_NAME_SOURCE

Constructor Summary

Constructors

Constructor and Description
CreateCollectionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static CreateCollectionRequest	fromJson(java.lang.String jsonString) Create an instance of CreateCollectionRequest 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	getName() The name of the collection to be created.
java.lang.String	getSource() The name of the index to be used as the source for the collection.
int	hashCode()
CreateCollectionRequest	name(java.lang.String name)
CreateCollectionRequest	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
void	setName(java.lang.String name)
void	setSource(java.lang.String source)
CreateCollectionRequest	source(java.lang.String source)
java.lang.String	toJson() Convert an instance of CreateCollectionRequest 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_NAME

public static final java.lang.String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_SOURCE

public static final java.lang.String SERIALIZED_NAME_SOURCE

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

CreateCollectionRequest

public CreateCollectionRequest()

Method Detail

name

public CreateCollectionRequest name(java.lang.String name)

getName

@Nonnull
public java.lang.String getName()

The name of the collection to be created. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.

Returns:

name

setName

public void setName(java.lang.String name)

source

public CreateCollectionRequest source(java.lang.String source)

getSource

@Nonnull
public java.lang.String getSource()

The name of the index to be used as the source for the collection.

Returns:

source

setSource

public void setSource(java.lang.String source)

putAdditionalProperty

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

fromJson

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

Create an instance of CreateCollectionRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateCollectionRequest

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of CreateCollectionRequest to an JSON string

Returns:

JSON string