Search Results for

    Show / Hide Table of Contents

    Class CloneSnapshotDescriptor

    Descriptor for Clone

    https://opensearch.org/docs/latest

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

    Constructors

    | Edit this page View Source

    CloneSnapshotDescriptor()

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

    Declaration
    protected CloneSnapshotDescriptor()
    | Edit this page View Source

    CloneSnapshotDescriptor(Name, Name, Name)

    /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}

    Declaration
    public CloneSnapshotDescriptor(Name repository, Name snapshot, Name targetSnapshot)
    Parameters
    Type Name Description
    Name repository

    this parameter is required

    Name snapshot

    this parameter is required

    Name targetSnapshot

    this parameter is required

    Methods

    | Edit this page View Source

    ClusterManagerTimeout(Time)

    The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

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

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Index(IndexName)

    The indices to restore

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

    Index<T>()

    The indices to restore

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

    Indices(Indices)

    The indices to restore

    Declaration
    public CloneSnapshotDescriptor Indices(Indices indices)
    Parameters
    Type Name Description
    Indices indices
    Returns
    Type Description
    CloneSnapshotDescriptor
    | Edit this page View Source

    MasterTimeout(Time)

    Explicit operation timeout for connection to cluster-manager node.

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

    Implements

    IDescriptor
    ICloneSnapshotRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CloneSnapshotDescriptor()
      • CloneSnapshotDescriptor(Name, Name, Name)
    • Methods
      • ClusterManagerTimeout(Time)
      • Index(IndexName)
      • Index<T>()
      • Indices(Indices)
      • MasterTimeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX