Search Results for

    Show / Hide Table of Contents

    Class ReindexOnServerRequest

    A request to Reindex API

    Inheritance
    object
    RequestBase<ReindexOnServerRequestParameters>
    PlainRequestBase<ReindexOnServerRequestParameters>
    ReindexOnServerRequest
    Implements
    IReindexOnServerRequest
    IRequest<ReindexOnServerRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<ReindexOnServerRequestParameters>.RequestConfiguration
    PlainRequestBase<ReindexOnServerRequestParameters>.ErrorTrace
    PlainRequestBase<ReindexOnServerRequestParameters>.FilterPath
    PlainRequestBase<ReindexOnServerRequestParameters>.Human
    PlainRequestBase<ReindexOnServerRequestParameters>.Pretty
    PlainRequestBase<ReindexOnServerRequestParameters>.SourceQueryString
    RequestBase<ReindexOnServerRequestParameters>.HttpMethod
    RequestBase<ReindexOnServerRequestParameters>.RequestState
    RequestBase<ReindexOnServerRequestParameters>.ContentType
    RequestBase<ReindexOnServerRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<ReindexOnServerRequestParameters>.RequestDefaults(ReindexOnServerRequestParameters)
    RequestBase<ReindexOnServerRequestParameters>.Q<TOut>(string)
    RequestBase<ReindexOnServerRequestParameters>.Q(string, object)
    RequestBase<ReindexOnServerRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class ReindexOnServerRequest : PlainRequestBase<ReindexOnServerRequestParameters>, IReindexOnServerRequest, IRequest<ReindexOnServerRequestParameters>, IRequest

    Properties

    | Edit this page View Source

    Conflicts

    Determine what to do in the event of version conflicts. Defaults to Abort

    Declaration
    public Conflicts? Conflicts { get; set; }
    Property Value
    Type Description
    Conflicts?
    | Edit this page View Source

    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

    | Edit this page View Source

    MaximumDocuments

    Limit the number of processed documents

    Declaration
    public long? MaximumDocuments { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    Refresh

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

    Declaration
    public Refresh? Refresh { get; set; }
    Property Value
    Type Description
    Refresh?
    | Edit this page View Source

    RequestsPerSecond

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

    Declaration
    public float? RequestsPerSecond { get; set; }
    Property Value
    Type Description
    float?
    | Edit this page View Source

    RequireAlias

    TODO

    Declaration
    public bool? RequireAlias { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Script

    A script that can modify documents from source, including metadata, before reindexing

    Declaration
    public IScript Script { get; set; }
    Property Value
    Type Description
    IScript
    | Edit this page View Source

    Scroll

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

    Declaration
    public Time Scroll { get; set; }
    Property Value
    Type Description
    Time
    | Edit this page View Source

    Self

    Declaration
    protected IReindexOnServerRequest Self { get; }
    Property Value
    Type Description
    IReindexOnServerRequest
    | Edit this page View Source

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

    Source

    The source for the reindex operation

    Declaration
    public IReindexSource Source { get; set; }
    Property Value
    Type Description
    IReindexSource
    | Edit this page View Source

    Timeout

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

    Declaration
    public Time Timeout { get; set; }
    Property Value
    Type Description
    Time
    | Edit this page View Source

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

    WaitForCompletion

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

    Declaration
    public bool? WaitForCompletion { get; set; }
    Property Value
    Type Description
    bool?

    Implements

    IReindexOnServerRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Conflicts
      • Destination
      • MaximumDocuments
      • Refresh
      • RequestsPerSecond
      • RequireAlias
      • Script
      • Scroll
      • Self
      • Slices
      • Source
      • Timeout
      • WaitForActiveShards
      • WaitForCompletion
    • Implements
    • Extension Methods
    Back to top Generated by DocFX