Search Results for

    Show / Hide Table of Contents

    Class AddIndexBlockRequestParameters

    Request options for AddBlock

    <p>https://docs.opensearch.org/latest/</p>
    
    Inheritance
    object
    RequestParameters<AddIndexBlockRequestParameters>
    AddIndexBlockRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<AddIndexBlockRequestParameters>.CustomResponseBuilder
    RequestParameters<AddIndexBlockRequestParameters>.QueryString
    RequestParameters<AddIndexBlockRequestParameters>.RequestConfiguration
    RequestParameters<AddIndexBlockRequestParameters>.ContainsQueryString(string)
    RequestParameters<AddIndexBlockRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<AddIndexBlockRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<AddIndexBlockRequestParameters>.SetQueryString(string, object)
    RequestParameters<AddIndexBlockRequestParameters>.Q<TOut>(string)
    RequestParameters<AddIndexBlockRequestParameters>.Q(string, object)
    RequestParameters<AddIndexBlockRequestParameters>.SetAcceptHeader(string)
    RequestParameters<AddIndexBlockRequestParameters>.SetAcceptHeader(Enum)
    RequestParameters<AddIndexBlockRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.IndicesApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class AddIndexBlockRequestParameters : RequestParameters<AddIndexBlockRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    AllowNoIndices

    Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).

    Declaration
    public bool? AllowNoIndices { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    ClusterManagerTimeout

    Operation timeout for connection to cluster-manager node.

    Declaration
    public TimeSpan ClusterManagerTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<AddIndexBlockRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    ExpandWildcards

    Whether to expand wildcard expression to concrete indexes that are open, closed or both.

    Declaration
    public ExpandWildcards? ExpandWildcards { get; set; }
    Property Value
    Type Description
    ExpandWildcards?
    | Edit this page View Source

    IgnoreUnavailable

    Whether specified concrete indexes should be ignored when unavailable (missing or closed).

    Declaration
    public bool? IgnoreUnavailable { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    MasterTimeout

    Specify timeout for connection to cluster manager.

    Declaration
    [Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
    public TimeSpan MasterTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    OperationName

    The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

    Declaration
    public override string OperationName { get; }
    Property Value
    Type Description
    string
    Overrides
    RequestParameters<AddIndexBlockRequestParameters>.OperationName
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<AddIndexBlockRequestParameters>.SupportsBody
    | Edit this page View Source

    Timeout

    Explicit operation timeout.

    Declaration
    public TimeSpan Timeout { get; set; }
    Property Value
    Type Description
    TimeSpan

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFX