Class ReindexOnServerRequestParameters

Request options for ReindexOnServer

https://opensearch.org/docs/latest/im-plugin/reindex-data/

Inheritance

object

RequestParameters<ReindexOnServerRequestParameters>

ReindexOnServerRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<ReindexOnServerRequestParameters>.CustomResponseBuilder

RequestParameters<ReindexOnServerRequestParameters>.QueryString

RequestParameters<ReindexOnServerRequestParameters>.RequestConfiguration

RequestParameters<ReindexOnServerRequestParameters>.ContainsQueryString(string)

RequestParameters<ReindexOnServerRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<ReindexOnServerRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<ReindexOnServerRequestParameters>.SetQueryString(string, object)

RequestParameters<ReindexOnServerRequestParameters>.Q<TOut>(string)

RequestParameters<ReindexOnServerRequestParameters>.Q(string, object)

RequestParameters<ReindexOnServerRequestParameters>.SetAcceptHeader(string)

RequestParameters<ReindexOnServerRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class ReindexOnServerRequestParameters : RequestParameters<ReindexOnServerRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<ReindexOnServerRequestParameters>.DefaultHttpMethod

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?

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?

RequireAlias

Declaration

public bool? RequireAlias { get; set; }

Property Value

Type	Description
bool?

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

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ReindexOnServerRequestParameters>.SupportsBody

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

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

WaitForCompletion

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

Declaration

public bool? WaitForCompletion { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)