Search Results for

    Show / Hide Table of Contents

    Class SplitIndexDescriptor

    A request to split an existing index into a new index, where each original primary shard is split into two or more primary shards in the new index.

    Inheritance
    object
    RequestBase<SplitIndexRequestParameters>
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>
    SplitIndexDescriptor
    Implements
    IDescriptor
    ISplitIndexRequest
    IRequest<SplitIndexRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.Self
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.Assign<TValue>(TValue, Action<ISplitIndexRequest, TValue>)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.Qs(string, object)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.FilterPath(params string[])
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.Human(bool?)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.Pretty(bool?)
    RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>.SourceQueryString(string)
    RequestBase<SplitIndexRequestParameters>.HttpMethod
    RequestBase<SplitIndexRequestParameters>.RequestState
    RequestBase<SplitIndexRequestParameters>.ContentType
    RequestBase<SplitIndexRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<SplitIndexRequestParameters>.RequestDefaults(SplitIndexRequestParameters)
    RequestBase<SplitIndexRequestParameters>.Q<TOut>(string)
    RequestBase<SplitIndexRequestParameters>.Q(string, object)
    RequestBase<SplitIndexRequestParameters>.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 SplitIndexDescriptor : RequestDescriptorBase<SplitIndexDescriptor, SplitIndexRequestParameters, ISplitIndexRequest>, IDescriptor, ISplitIndexRequest, IRequest<SplitIndexRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    SplitIndexDescriptor()

    Used for serialization purposes, making sure we have a parameterless constructor

    Declaration
    protected SplitIndexDescriptor()
    | Edit this page View Source

    SplitIndexDescriptor(IndexName, IndexName)

    /{index}/_split/{target}

    Declaration
    public SplitIndexDescriptor(IndexName index, IndexName target)
    Parameters
    Type Name Description
    IndexName index

    this parameter is required

    IndexName target

    this parameter is required

    Methods

    | Edit this page View Source

    Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)

    The aliases for the target index

    Declaration
    public SplitIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)
    Parameters
    Type Name Description
    Func<AliasesDescriptor, IPromise<IAliases>> selector
    Returns
    Type Description
    SplitIndexDescriptor
    | Edit this page View Source

    ClusterManagerTimeout(Time)

    Operation timeout for connection to cluster-manager node.

    Declaration
    public SplitIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    SplitIndexDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Index(IndexName)

    Name of the source index to split.

    Declaration
    public SplitIndexDescriptor Index(IndexName index)
    Parameters
    Type Name Description
    IndexName index
    Returns
    Type Description
    SplitIndexDescriptor
    | Edit this page View Source

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

    Declaration
    public SplitIndexDescriptor Index<TOther>() where TOther : class
    Returns
    Type Description
    SplitIndexDescriptor
    Type Parameters
    Name Description
    TOther
    | Edit this page View Source

    MasterTimeout(Time)

    Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
    public SplitIndexDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    SplitIndexDescriptor
    | Edit this page View Source

    Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)

    The settings for the target index

    Declaration
    public SplitIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
    Parameters
    Type Name Description
    Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector
    Returns
    Type Description
    SplitIndexDescriptor
    | Edit this page View Source

    TaskExecutionTimeout(Time)

    Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

    Declaration
    public SplitIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout)
    Parameters
    Type Name Description
    Time taskexecutiontimeout
    Returns
    Type Description
    SplitIndexDescriptor
    | Edit this page View Source

    Timeout(Time)

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    Declaration
    public SplitIndexDescriptor Timeout(Time timeout)
    Parameters
    Type Name Description
    Time timeout
    Returns
    Type Description
    SplitIndexDescriptor
    | 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 SplitIndexDescriptor WaitForActiveShards(string waitforactiveshards)
    Parameters
    Type Name Description
    string waitforactiveshards
    Returns
    Type Description
    SplitIndexDescriptor
    | Edit this page View Source

    WaitForCompletion(bool?)

    Should this request wait until the operation has completed before returning.

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

    Supported by OpenSearch servers of version 2.7.0 or greater.

    Implements

    IDescriptor
    ISplitIndexRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SplitIndexDescriptor()
      • SplitIndexDescriptor(IndexName, IndexName)
    • Methods
      • Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)
      • ClusterManagerTimeout(Time)
      • Index(IndexName)
      • Index<TOther>()
      • MasterTimeout(Time)
      • Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
      • TaskExecutionTimeout(Time)
      • Timeout(Time)
      • WaitForActiveShards(string)
      • WaitForCompletion(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX