Class ReindexOnServerDescriptor

Descriptor for ReindexOnServer

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

Inheritance
object
RequestBase<ReindexOnServerRequestParameters>
RequestDescriptorBase<ReindexOnServerDescriptor, ReindexOnServerRequestParameters, IReindexOnServerRequest>
ReindexOnServerDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
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
Type Name Description
Conflicts? conflicts
Returns
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

Destination(Func<ReindexDestinationDescriptor, IReindexDestination>)

The destination for the reindex operation.

Declaration
public ReindexOnServerDescriptor Destination(Func<ReindexDestinationDescriptor, IReindexDestination> selector)
Parameters
Type Name Description
Func<ReindexDestinationDescriptor, IReindexDestination> selector
Returns
Type Description
ReindexOnServerDescriptor
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

| 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
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

Refresh(Refresh?)

If true, the request refreshes affected shards to make this operation visible to search.

Declaration
public ReindexOnServerDescriptor Refresh(Refresh? refresh)
Parameters
Type Name Description
Refresh? refresh
Returns
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

RequestsPerSecond(long?)

The throttle for this request in sub-requests per second. Defaults to no throttle.

Declaration
public ReindexOnServerDescriptor RequestsPerSecond(long? requestspersecond)
Parameters
Type Name Description
long? requestspersecond
Returns
Type Description
ReindexOnServerDescriptor
| 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
Type Name Description
Func<ScriptDescriptor, IScript> scriptSelector
Returns
Type Description
ReindexOnServerDescriptor
| 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
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

Scroll(Time)

Specifies how long a consistent view of the index should be maintained for scrolled search.

Declaration
public ReindexOnServerDescriptor Scroll(Time scroll)
Parameters
Type Name Description
Time scroll
Returns
Type Description
ReindexOnServerDescriptor
| 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
Type Description
ReindexOnServerDescriptor
| 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
Type Name Description
Func<ReindexSourceDescriptor, IReindexSource> selector
Returns
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

Timeout(Time)

Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards.

Declaration
public ReindexOnServerDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

WaitForActiveShards(string)

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 ReindexOnServerDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type Name Description
string waitforactiveshards
Returns
Type Description
ReindexOnServerDescriptor
| Edit this page View Source

WaitForCompletion(bool?)

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

Declaration
public ReindexOnServerDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type Name Description
bool? waitforcompletion
Returns
Type Description
ReindexOnServerDescriptor

Implements

Extension Methods