Search Results for

    Show / Hide Table of Contents

    Class DeleteScriptDescriptor

    Descriptor for DeleteScript

    https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/

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

    Constructors

    | Edit this page View Source

    DeleteScriptDescriptor()

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

    Declaration
    protected DeleteScriptDescriptor()
    | Edit this page View Source

    DeleteScriptDescriptor(Id)

    /_scripts/{id}

    Declaration
    public DeleteScriptDescriptor(Id id)
    Parameters
    Type Name Description
    Id id

    this parameter is required

    Methods

    | Edit this page View Source

    ClusterManagerTimeout(Time)

    Operation timeout for connection to cluster-manager node.

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

    Supported by OpenSearch servers of version 2.0.0 or greater.

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

    Implements

    IDescriptor
    IDeleteScriptRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

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