Search Results for

    Show / Hide Table of Contents

    Class UpdateByQueryRethrottleDescriptor

    Descriptor for UpdateByQueryRethrottle

    https://opensearch.org/docs/latest

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

    Constructors

    | Edit this page View Source

    UpdateByQueryRethrottleDescriptor()

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

    Declaration
    protected UpdateByQueryRethrottleDescriptor()
    | Edit this page View Source

    UpdateByQueryRethrottleDescriptor(TaskId)

    /_update_by_query/{task_id}/_rethrottle

    Declaration
    public UpdateByQueryRethrottleDescriptor(TaskId taskId)
    Parameters
    Type Name Description
    TaskId taskId

    this parameter is required

    Methods

    | Edit this page View Source

    RequestsPerSecond(float?)

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

    Declaration
    public UpdateByQueryRethrottleDescriptor RequestsPerSecond(float? requestspersecond)
    Parameters
    Type Name Description
    float? requestspersecond
    Returns
    Type Description
    UpdateByQueryRethrottleDescriptor

    Implements

    IDescriptor
    IUpdateByQueryRethrottleRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • UpdateByQueryRethrottleDescriptor()
      • UpdateByQueryRethrottleDescriptor(TaskId)
    • Methods
      • RequestsPerSecond(float?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX