Class ReindexOnServerRequest
A request to Reindex API
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ReindexOnServerRequest : PlainRequestBase<ReindexOnServerRequestParameters>, IReindexOnServerRequest, IRequest<ReindexOnServerRequestParameters>, IRequest
Properties
| Edit this page View SourceConflicts
Determine what to do in the event of version conflicts. Defaults to Abort
Declaration
public Conflicts? Conflicts { get; set; }
Property Value
Type | Description |
---|---|
Conflicts? |
Destination
The destination for the reindex operation.
Declaration
public IReindexDestination Destination { get; set; }
Property Value
Type | Description |
---|---|
IReindexDestination |
Remarks
Reindex does not attempt to set up the destination index. It does not copy the settings of the source index. You should set up the destination index beforehand
MaximumDocuments
Limit the number of processed documents
Declaration
public long? MaximumDocuments { get; set; }
Property Value
Type | Description |
---|---|
long? |
Refresh
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? |
Script
A script that can modify documents from source, including metadata, before reindexing
Declaration
public IScript Script { get; set; }
Property Value
Type | Description |
---|---|
IScript |
Scroll
Control how long to keep the search context alive
Declaration
public Time Scroll { get; set; }
Property Value
Type | Description |
---|---|
Time |
Self
Declaration
protected IReindexOnServerRequest Self { get; }
Property Value
Type | Description |
---|---|
IReindexOnServerRequest |
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 Slices Slices { get; set; }
Property Value
Type | Description |
---|---|
Slices |
Source
The source for the reindex operation
Declaration
public IReindexSource Source { get; set; }
Property Value
Type | Description |
---|---|
IReindexSource |
Timeout
Time each individual bulk request should wait for shards that are unavailable.
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
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? |