CreateIndexRequest (pinecone-java-client 3.1.0 API)

java.lang.Object
- org.openapitools.db_control.client.model.CreateIndexRequest

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

The configuration needed to create a Pinecone index.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreateIndexRequest.CustomTypeAdapterFactory`
`static class`	`CreateIndexRequest.MetricEnum` The distance metric to be used for similarity search.

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_DELETION_PROTECTION`
`static java.lang.String`	`SERIALIZED_NAME_DIMENSION`
`static java.lang.String`	`SERIALIZED_NAME_METRIC`
`static java.lang.String`	`SERIALIZED_NAME_NAME`
`static java.lang.String`	`SERIALIZED_NAME_SPEC`
`static java.lang.String`	`SERIALIZED_NAME_TAGS`

Constructor Summary

Constructors
Constructor and Description

CreateIndexRequest()

Constructors
Constructor and Description
`CreateIndexRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateIndexRequest`	`deletionProtection(DeletionProtection deletionProtection)`
`CreateIndexRequest`	`dimension(java.lang.Integer dimension)`
`boolean`	`equals(java.lang.Object o)`
`static CreateIndexRequest`	`fromJson(java.lang.String jsonString)` Create an instance of CreateIndexRequest 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.
`DeletionProtection`	`getDeletionProtection()` Get deletionProtection
`java.lang.Integer`	`getDimension()` The dimensions of the vectors to be inserted in the index.
`CreateIndexRequest.MetricEnum`	`getMetric()` The distance metric to be used for similarity search.
`java.lang.String`	`getName()` The name of the index.
`IndexSpec`	`getSpec()` Get spec
`java.util.Map<java.lang.String,java.lang.String>`	`getTags()` Custom user tags added to an index.
`int`	`hashCode()`
`CreateIndexRequest`	`metric(CreateIndexRequest.MetricEnum metric)`
`CreateIndexRequest`	`name(java.lang.String name)`
`CreateIndexRequest`	`putAdditionalProperty(java.lang.String key, java.lang.Object value)` Set the additional (undeclared) property with the specified name and value.
`CreateIndexRequest`	`putTagsItem(java.lang.String key, java.lang.String tagsItem)`
`void`	`setDeletionProtection(DeletionProtection deletionProtection)`
`void`	`setDimension(java.lang.Integer dimension)`
`void`	`setMetric(CreateIndexRequest.MetricEnum metric)`
`void`	`setName(java.lang.String name)`
`void`	`setSpec(IndexSpec spec)`
`void`	`setTags(java.util.Map<java.lang.String,java.lang.String> tags)`
`CreateIndexRequest`	`spec(IndexSpec spec)`
`CreateIndexRequest`	`tags(java.util.Map<java.lang.String,java.lang.String> tags)`
`java.lang.String`	`toJson()` Convert an instance of CreateIndexRequest 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_DIMENSION

public static final java.lang.String SERIALIZED_NAME_DIMENSION

See Also:: Constant Field Values

SERIALIZED_NAME_METRIC

public static final java.lang.String SERIALIZED_NAME_METRIC

See Also:: Constant Field Values

SERIALIZED_NAME_DELETION_PROTECTION

public static final java.lang.String SERIALIZED_NAME_DELETION_PROTECTION

See Also:: Constant Field Values

SERIALIZED_NAME_TAGS

public static final java.lang.String SERIALIZED_NAME_TAGS

See Also:: Constant Field Values

SERIALIZED_NAME_SPEC

public static final java.lang.String SERIALIZED_NAME_SPEC

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
- CreateIndexRequest
```
public CreateIndexRequest()
```

Method Detail
- name
```
public CreateIndexRequest name(java.lang.String name)
```
- getName
```
@Nonnull
public java.lang.String getName()
```
  The name of the index. 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)
```
- dimension
```
public CreateIndexRequest dimension(java.lang.Integer dimension)
```
- getDimension
```
@Nonnull
public java.lang.Integer getDimension()
```
  The dimensions of the vectors to be inserted in the index. minimum: 1 maximum: 20000
  
  Returns:
  
  dimension
- setDimension
```
public void setDimension(java.lang.Integer dimension)
```
- metric
```
public CreateIndexRequest metric(CreateIndexRequest.MetricEnum metric)
```
- getMetric
```
@Nullable
public CreateIndexRequest.MetricEnum getMetric()
```
  The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.
  
  Returns:
  
  metric
- setMetric
```
public void setMetric(CreateIndexRequest.MetricEnum metric)
```
- deletionProtection
```
public CreateIndexRequest deletionProtection(DeletionProtection deletionProtection)
```
- getDeletionProtection
```
@Nullable
public DeletionProtection getDeletionProtection()
```
  Get deletionProtection
  
  Returns:
  
  deletionProtection
- setDeletionProtection
```
public void setDeletionProtection(DeletionProtection deletionProtection)
```
- tags
```
public CreateIndexRequest tags(java.util.Map<java.lang.String,java.lang.String> tags)
```
- putTagsItem
```
public CreateIndexRequest putTagsItem(java.lang.String key,
                                      java.lang.String tagsItem)
```
- getTags
```
@Nullable
public java.util.Map<java.lang.String,java.lang.String> getTags()
```
  Custom user tags added to an index. Keys must be alphanumeric and 80 characters or less. Values must be 120 characters or less.
  
  Returns:
  
  tags
- setTags
```
public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)
```
- spec
```
public CreateIndexRequest spec(IndexSpec spec)
```
- getSpec
```
@Nullable
public IndexSpec getSpec()
```
  Get spec
  
  Returns:
  
  spec
- setSpec
```
public void setSpec(IndexSpec spec)
```
- putAdditionalProperty
```
public CreateIndexRequest 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 CreateIndexRequest 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 CreateIndexRequest
- fromJson
```
public static CreateIndexRequest fromJson(java.lang.String jsonString)
                                   throws java.io.IOException
```
  Create an instance of CreateIndexRequest given an JSON string
  
  Parameters:
  
  jsonString - JSON string
  
  Returns:
  
  An instance of CreateIndexRequest
  
  Throws:
  
  java.io.IOException - if the JSON string is invalid with respect to CreateIndexRequest
- toJson
```
public java.lang.String toJson()
```
  Convert an instance of CreateIndexRequest to an JSON string
  
  Returns:
  
  JSON string

Class CreateIndexRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_NAME

SERIALIZED_NAME_DIMENSION

SERIALIZED_NAME_METRIC

SERIALIZED_NAME_DELETION_PROTECTION

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_SPEC

openapiFields

openapiRequiredFields

Constructor Detail

CreateIndexRequest

Method Detail

name

getName

setName

dimension

getDimension

setDimension

metric

getMetric

setMetric

deletionProtection

getDeletionProtection

setDeletionProtection

tags

putTagsItem

getTags

setTags

spec

getSpec

setSpec

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson