Class ReindexOnServerDescriptor
Descriptor for ReindexOnServer
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/
Inheritance
ReindexOnServerDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class ReindexOnServerDescriptor : RequestDescriptorBase<ReindexOnServerDescriptor, ReindexOnServerRequestParameters, IReindexOnServerRequest>, IDescriptor, IReindexOnServerRequest, IRequest<ReindexOnServerRequestParameters>, IRequest
Methods
|
Edit this page
View Source
Conflicts(Conflicts?)
Determine what to do in the event of version conflicts.
Defaults to Abort
Declaration
public ReindexOnServerDescriptor Conflicts(Conflicts? conflicts)
Parameters
Returns
|
Edit this page
View Source
Destination(Func<ReindexDestinationDescriptor, IReindexDestination>)
The destination for the reindex operation.
Declaration
public ReindexOnServerDescriptor Destination(Func<ReindexDestinationDescriptor, IReindexDestination> selector)
Parameters
Returns
|
Edit this page
View Source
MaximumDocuments(long?)
Limit the number of processed documents
Declaration
public ReindexOnServerDescriptor MaximumDocuments(long? maximumDocuments)
Parameters
Type |
Name |
Description |
long? |
maximumDocuments |
|
Returns
|
Edit this page
View Source
Refresh(bool?)
Should the affected indexes be refreshed?
Declaration
public ReindexOnServerDescriptor Refresh(bool? refresh = true)
Parameters
Type |
Name |
Description |
bool? |
refresh |
|
Returns
|
Edit this page
View Source
RequestsPerSecond(long?)
The throttle to set on this request in sub-requests per second. -1 means no throttle.
Declaration
public ReindexOnServerDescriptor RequestsPerSecond(long? requestspersecond)
Parameters
Type |
Name |
Description |
long? |
requestspersecond |
|
Returns
|
Edit this page
View Source
Script(Func<ScriptDescriptor, IScript>)
A script that can modify documents from source, including metadata, before reindexing
Declaration
public ReindexOnServerDescriptor Script(Func<ScriptDescriptor, IScript> scriptSelector)
Parameters
Returns
|
Edit this page
View Source
Script(string)
A script that can modify documents from source, including metadata, before reindexing
Declaration
public ReindexOnServerDescriptor Script(string script)
Parameters
Type |
Name |
Description |
string |
script |
|
Returns
|
Edit this page
View Source
Control how long to keep the search context alive
Declaration
public ReindexOnServerDescriptor Scroll(Time scroll)
Parameters
Type |
Name |
Description |
Time |
scroll |
|
Returns
|
Edit this page
View Source
Slices(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 ReindexOnServerDescriptor Slices(Slices slices)
Parameters
Type |
Name |
Description |
Slices |
slices |
|
Returns
|
Edit this page
View Source
Source(Func<ReindexSourceDescriptor, IReindexSource>)
The source for the reindex operation
Declaration
public ReindexOnServerDescriptor Source(Func<ReindexSourceDescriptor, IReindexSource> selector = null)
Parameters
Returns
|
Edit this page
View Source
Timeout(Time)
Time each individual bulk request should wait for shards that are unavailable.
Declaration
public ReindexOnServerDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
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 ReindexOnServerDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
|
Edit this page
View Source
WaitForCompletion(bool?)
Should the request should block until the reindex is complete.
Declaration
public ReindexOnServerDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type |
Name |
Description |
bool? |
waitforcompletion |
|
Returns
Implements
Extension Methods