Class DeleteDescriptor<TDocument>
Descriptor for Delete
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/
Inheritance
DeleteDescriptor<TDocument>
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)
Declaration
public DeleteDescriptor(Id id)
Parameters
Type |
Name |
Description |
Id |
id |
this parameter is required
|
|
Edit this page
View Source
DeleteDescriptor(IndexName, 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)
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 delete operation if the last operation that has changed the document has the specified primary term
Declaration
public DeleteDescriptor<TDocument> IfPrimaryTerm(long? ifprimaryterm)
Parameters
Type |
Name |
Description |
long? |
ifprimaryterm |
|
Returns
|
Edit this page
View Source
IfSequenceNumber(long?)
only perform the delete operation if the last operation that has changed the document has the specified sequence number
Declaration
public DeleteDescriptor<TDocument> IfSequenceNumber(long? ifsequencenumber)
Parameters
Type |
Name |
Description |
long? |
ifsequencenumber |
|
Returns
|
Edit this page
View Source
Index(IndexName)
Declaration
public DeleteDescriptor<TDocument> Index(IndexName index)
Parameters
Returns
|
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 Parameters
|
Edit this page
View Source
Refresh(Refresh?)
If true
then refresh 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
(the default) then do nothing with refreshes.
Declaration
public DeleteDescriptor<TDocument> Refresh(Refresh? refresh)
Parameters
Type |
Name |
Description |
Refresh? |
refresh |
|
Returns
|
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
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public DeleteDescriptor<TDocument> Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
Version(long?)
Explicit version number for concurrency control
Declaration
public DeleteDescriptor<TDocument> Version(long? version)
Parameters
Type |
Name |
Description |
long? |
version |
|
Returns
|
Edit this page
View Source
VersionType(VersionType?)
Declaration
public DeleteDescriptor<TDocument> VersionType(VersionType? versiontype)
Parameters
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to all
for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
Declaration
public DeleteDescriptor<TDocument> WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
Implements
Extension Methods