DeleteRequest (pinecone-java-client 3.0.0 API)

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

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

The request for the `delete` operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeleteRequest.CustomTypeAdapterFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeleteRequest.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_DELETE_ALL`
`static java.lang.String`	`SERIALIZED_NAME_FILTER`
`static java.lang.String`	`SERIALIZED_NAME_IDS`
`static java.lang.String`	`SERIALIZED_NAME_NAMESPACE`

Constructor Summary

Constructors
Constructor and Description

DeleteRequest()

Constructors
Constructor and Description
`DeleteRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeleteRequest`	`addIdsItem(java.lang.String idsItem)`
`DeleteRequest`	`deleteAll(java.lang.Boolean deleteAll)`
`boolean`	`equals(java.lang.Object o)`
`DeleteRequest`	`filter(java.lang.Object filter)`
`static DeleteRequest`	`fromJson(java.lang.String jsonString)` Create an instance of DeleteRequest 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.Boolean`	`getDeleteAll()` This indicates that all vectors in the index namespace should be deleted.
`java.lang.Object`	`getFilter()` If specified, the metadata filter here will be used to select the vectors to delete.
`java.util.List<java.lang.String>`	`getIds()` Vectors to delete.
`java.lang.String`	`getNamespace()` The namespace to delete vectors from, if applicable.
`int`	`hashCode()`
`DeleteRequest`	`ids(java.util.List<java.lang.String> ids)`
`DeleteRequest`	`namespace(java.lang.String namespace)`
`DeleteRequest`	`putAdditionalProperty(java.lang.String key, java.lang.Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setDeleteAll(java.lang.Boolean deleteAll)`
`void`	`setFilter(java.lang.Object filter)`
`void`	`setIds(java.util.List<java.lang.String> ids)`
`void`	`setNamespace(java.lang.String namespace)`
`java.lang.String`	`toJson()` Convert an instance of DeleteRequest 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_IDS
```
public static final java.lang.String SERIALIZED_NAME_IDS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELETE_ALL
```
public static final java.lang.String SERIALIZED_NAME_DELETE_ALL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAMESPACE
```
public static final java.lang.String SERIALIZED_NAME_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - 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
  - DeleteRequest
```
public DeleteRequest()
```
- Method Detail
  - ids
```
public DeleteRequest ids(java.util.List<java.lang.String> ids)
```
  - addIdsItem
```
public DeleteRequest addIdsItem(java.lang.String idsItem)
```
  - getIds
```
@Nullable
public java.util.List<java.lang.String> getIds()
```
    Vectors to delete.
    
    Returns:
    
    ids
  - setIds
```
public void setIds(java.util.List<java.lang.String> ids)
```
  - deleteAll
```
public DeleteRequest deleteAll(java.lang.Boolean deleteAll)
```
  - getDeleteAll
```
@Nullable
public java.lang.Boolean getDeleteAll()
```
    This indicates that all vectors in the index namespace should be deleted.
    
    Returns:
    
    deleteAll
  - setDeleteAll
```
public void setDeleteAll(java.lang.Boolean deleteAll)
```
  - namespace
```
public DeleteRequest namespace(java.lang.String namespace)
```
  - getNamespace
```
@Nullable
public java.lang.String getNamespace()
```
    The namespace to delete vectors from, if applicable.
    
    Returns:
    
    namespace
  - setNamespace
```
public void setNamespace(java.lang.String namespace)
```
  - filter
```
public DeleteRequest filter(java.lang.Object filter)
```
  - getFilter
```
@Nullable
public java.lang.Object getFilter()
```
    If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive with specifying ids to delete in the ids param or using delete_all=True. See [Filter with metadata](https://docs.pinecone.io/guides/data/filter-with-metadata). Serverless indexes do not support delete by metadata. Instead, you can use the `list` operation to fetch the vector IDs based on their common ID prefix and then delete the records by ID.
    
    Returns:
    
    filter
  - setFilter
```
public void setFilter(java.lang.Object filter)
```
  - putAdditionalProperty
```
public DeleteRequest 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 DeleteRequest 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 DeleteRequest
  - fromJson
```
public static DeleteRequest fromJson(java.lang.String jsonString)
                              throws java.io.IOException
```
    Create an instance of DeleteRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of DeleteRequest
    
    Throws:
    
    java.io.IOException - if the JSON string is invalid with respect to DeleteRequest
  - toJson
```
public java.lang.String toJson()
```
    Convert an instance of DeleteRequest to an JSON string
    
    Returns:
    
    JSON string

Class DeleteRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_IDS

SERIALIZED_NAME_DELETE_ALL

SERIALIZED_NAME_NAMESPACE

SERIALIZED_NAME_FILTER

openapiFields

openapiRequiredFields

Constructor Detail

DeleteRequest

Method Detail

ids

addIdsItem

getIds

setIds

deleteAll

getDeleteAll

setDeleteAll

namespace

getNamespace

setNamespace

filter

getFilter

setFilter

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson