Class DeleteDescriptor<TDocument>

Descriptor for Delete

https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/

Inheritance
object
RequestBase<DeleteRequestParameters>
RequestDescriptorBase<DeleteDescriptor<TDocument>, DeleteRequestParameters, IDeleteRequest<TDocument>>
DeleteDescriptor<TDocument>
Implements
IDeleteRequest<TDocument>
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DeleteDescriptor<TDocument> : RequestDescriptorBase<DeleteDescriptor<TDocument>, DeleteRequestParameters, IDeleteRequest<TDocument>>, IDescriptor, IDeleteRequest<TDocument>, IDeleteRequest, IRequest<DeleteRequestParameters>, IRequest where TDocument : class
Type Parameters
Name Description
TDocument

Constructors

| Edit this page View Source

DeleteDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected DeleteDescriptor()
| Edit this page View Source

DeleteDescriptor(Id)

/{index}/_doc/{id}

Declaration
public DeleteDescriptor(Id id)
Parameters
Type Name Description
Id id

this parameter is required
| Edit this page View Source

DeleteDescriptor(IndexName, Id)

/{index}/_doc/{id}

Declaration
public DeleteDescriptor(IndexName index, Id id)
Parameters
Type Name Description
IndexName index

this parameter is required
Id id

this parameter is required
| Edit this page View Source

DeleteDescriptor(TDocument, IndexName, Id)

/{index}/_doc/{id}

Declaration
public DeleteDescriptor(TDocument documentWithId, IndexName index = null, Id id = null)
Parameters
Type Name Description
TDocument documentWithId
IndexName index
Id id

The document used to resolve the path from

Methods

| Edit this page View Source

IfPrimaryTerm(long?)

Only perform the operation if the document has this primary term.

Declaration
public DeleteDescriptor<TDocument> IfPrimaryTerm(long? ifprimaryterm)
Parameters
Type Name Description
long? ifprimaryterm
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

IfSequenceNumber(long?)

Only perform the operation if the document has this sequence number.

Declaration
public DeleteDescriptor<TDocument> IfSequenceNumber(long? ifsequencenumber)
Parameters
Type Name Description
long? ifsequencenumber
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

Index(IndexName)

Name of the target index.

Declaration
public DeleteDescriptor<TDocument> Index(IndexName index)
Parameters
Type Name Description
IndexName index
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public DeleteDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Description
DeleteDescriptor<TDocument>
Type Parameters
Name Description
TOther
| Edit this page View Source

Refresh(Refresh?)

If true, OpenSearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for.

Declaration
public DeleteDescriptor<TDocument> Refresh(Refresh? refresh)
Parameters
Type Name Description
Refresh? refresh
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

Routing(Routing)

A document is routed to a particular shard in an index using the following formula

shard_num = hash(_routing) % num_primary_shards

OpenSearch will use the document id if not provided.

For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

Declaration
public DeleteDescriptor<TDocument> Routing(Routing routing)
Parameters
Type Name Description
Routing routing
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

Timeout(Time)

Period to wait for active shards.

Declaration
public DeleteDescriptor<TDocument> Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

Version(long?)

Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

Declaration
public DeleteDescriptor<TDocument> Version(long? version)
Parameters
Type Name Description
long? version
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

VersionType(VersionType?)

Specific version type: external, external_gte.

Declaration
public DeleteDescriptor<TDocument> VersionType(VersionType? versiontype)
Parameters
Type Name Description
VersionType? versiontype
Returns
Type Description
DeleteDescriptor<TDocument>
| Edit this page View Source

WaitForActiveShards(string)

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

Declaration
public DeleteDescriptor<TDocument> WaitForActiveShards(string waitforactiveshards)
Parameters
Type Name Description
string waitforactiveshards
Returns
Type Description
DeleteDescriptor<TDocument>

Implements

Extension Methods