Class ReindexOnServerRequestParameters

Request options for ReindexOnServer

<p>https://docs.opensearch.org/latest/im-plugin/reindex-data/</p>
Inheritance
object
RequestParameters<ReindexOnServerRequestParameters>
ReindexOnServerRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class ReindexOnServerRequestParameters : RequestParameters<ReindexOnServerRequestParameters>, 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

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, the request refreshes affected shards to make this operation visible to search.

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

RequestsPerSecond

The throttle for this request in sub-requests per second. Defaults to no throttle.

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

RequireAlias

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

Scroll

Specifies how long a consistent view of the index should be maintained for scrolled search.

Declaration
public TimeSpan Scroll { get; set; }
Property Value
Type Description
TimeSpan
| 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 each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.

Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| 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
| Edit this page View Source

WaitForCompletion

If true, the request blocks until the operation is complete.

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods