Search Results for

    Show / Hide Table of Contents

    Class DeleteSnapshotDescriptor

    Descriptor for Delete

    https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/

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

    Constructors

    | Edit this page View Source

    DeleteSnapshotDescriptor()

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

    Declaration
    protected DeleteSnapshotDescriptor()
    | Edit this page View Source

    DeleteSnapshotDescriptor(Name, Name)

    /_snapshot/{repository}/{snapshot}

    Declaration
    public DeleteSnapshotDescriptor(Name repository, Name snapshot)
    Parameters
    Type Name Description
    Name repository

    this parameter is required

    Name snapshot

    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 DeleteSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    DeleteSnapshotDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | 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 DeleteSnapshotDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    DeleteSnapshotDescriptor

    Implements

    IDescriptor
    IDeleteSnapshotRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • DeleteSnapshotDescriptor()
      • DeleteSnapshotDescriptor(Name, Name)
    • Methods
      • ClusterManagerTimeout(Time)
      • MasterTimeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX