Class DeleteRequestParameters

Request options for Delete

<p>https://docs.opensearch.org/latest/api-reference/document-apis/delete-document/</p>
Inheritance
object
RequestParameters<DeleteRequestParameters>
DeleteRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class DeleteRequestParameters : RequestParameters<DeleteRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

IfPrimaryTerm

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

Declaration
public long? IfPrimaryTerm { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

IfSequenceNumber

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

Declaration
public long? IfSequenceNumber { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

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 Refresh? Refresh { get; set; }
Property Value
Type Description
Refresh?
| Edit this page View Source

Routing

A custom value used to route operations to a specific shard.

Declaration
public string[] Routing { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Timeout

Period to wait for active shards.

Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

Version

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

Declaration
public long? Version { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

VersionType

The specific version type: external, external_gte.

Declaration
public VersionType? VersionType { get; set; }
Property Value
Type Description
VersionType?
| Edit this page View Source

WaitForActiveShards

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 string WaitForActiveShards { get; set; }
Property Value
Type Description
string

Implements

Extension Methods