Class DeleteRequest
Request for Delete
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DeleteRequest : PlainRequestBase<DeleteRequestParameters>, IDeleteRequest, IRequest<DeleteRequestParameters>, IRequest
Constructors
| Edit this page View SourceDeleteRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected DeleteRequest()
DeleteRequest(IndexName, Id)
/{index}/_doc/{id}
Declaration
public DeleteRequest(IndexName index, Id id)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
Id | id | this parameter is required |
Properties
| Edit this page View SourceIfPrimaryTerm
only perform the delete operation if the last operation that has changed the document has the specified primary term
Declaration
public long? IfPrimaryTerm { get; set; }
Property Value
Type | Description |
---|---|
long? |
IfSequenceNumber
only perform the delete operation if the last operation that has changed the document has the specified sequence number
Declaration
public long? IfSequenceNumber { get; set; }
Property Value
Type | Description |
---|---|
long? |
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 Refresh? Refresh { get; set; }
Property Value
Type | Description |
---|---|
Refresh? |
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 OSC 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 Routing Routing { get; set; }
Property Value
Type | Description |
---|---|
Routing |
Self
Declaration
protected IDeleteRequest Self { get; }
Property Value
Type | Description |
---|---|
IDeleteRequest |
Timeout
Explicit operation timeout
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Version
Explicit version number for concurrency control
Declaration
public long? Version { get; set; }
Property Value
Type | Description |
---|---|
long? |
VersionType
Specific version type
Declaration
public VersionType? VersionType { get; set; }
Property Value
Type | Description |
---|---|
VersionType? |
WaitForActiveShards
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 string WaitForActiveShards { get; set; }
Property Value
Type | Description |
---|---|
string |