Class ReindexOnServerRequestParameters
Request options for ReindexOnServer
https://opensearch.org/docs/latest/im-plugin/reindex-data/
Inheritance
ReindexOnServerRequestParameters
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
If true
, the request refreshes affected shards to make this operation visible to search.
Declaration
public bool? Refresh { get; set; }
Property Value
Type | Description |
---|---|
bool? |
RequestsPerSecond
The throttle for this request in sub-requests per second. Defaults to no throttle.
Declaration
public long? RequestsPerSecond { get; set; }
Property Value
Type | Description |
---|---|
long? |
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
| Edit this page View SourceTimeout
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? |