Class ReindexOnServerRequestParameters
Request options for ReindexOnServer
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/
Inheritance
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class ReindexOnServerRequestParameters : RequestParameters<ReindexOnServerRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceDefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourceRefresh
Should the affected indexes be refreshed?
Declaration
public bool? Refresh { get; set; }
Property Value
Type | Description |
---|---|
bool? |
RequestsPerSecond
The throttle to set on this request in sub-requests per second. -1 means no throttle.
Declaration
public long? RequestsPerSecond { get; set; }
Property Value
Type | Description |
---|---|
long? |
Scroll
Control how long to keep the search context alive
Declaration
public TimeSpan Scroll { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Slices
The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to auto
.
Declaration
public long? Slices { get; set; }
Property Value
Type | Description |
---|---|
long? |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceTimeout
Time each individual bulk request should wait for shards that are unavailable.
Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
WaitForActiveShards
Sets the number of shard copies that must be active before proceeding with the reindex 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 |
WaitForCompletion
Should the request should block until the reindex is complete.
Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type | Description |
---|---|
bool? |