Search Results for

    Show / Hide Table of Contents

    Class PutMappingRequestParameters

    Request options for PutMapping

    https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/

    Inheritance
    object
    RequestParameters<PutMappingRequestParameters>
    PutMappingRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<PutMappingRequestParameters>.CustomResponseBuilder
    RequestParameters<PutMappingRequestParameters>.QueryString
    RequestParameters<PutMappingRequestParameters>.RequestConfiguration
    RequestParameters<PutMappingRequestParameters>.ContainsQueryString(string)
    RequestParameters<PutMappingRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<PutMappingRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<PutMappingRequestParameters>.SetQueryString(string, object)
    RequestParameters<PutMappingRequestParameters>.Q<TOut>(string)
    RequestParameters<PutMappingRequestParameters>.Q(string, object)
    RequestParameters<PutMappingRequestParameters>.SetAcceptHeader(string)
    RequestParameters<PutMappingRequestParameters>.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 PutMappingRequestParameters : RequestParameters<PutMappingRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    AllowNoIndices

    If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

    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<PutMappingRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    ExpandWildcards

    Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

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

    IgnoreUnavailable

    If false, the request returns an error if it targets a missing or closed index.

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

    IncludeTypeName

    Whether a type should be expected in the body of the mappings.

    Declaration
    public bool? IncludeTypeName { get; set; }
    Property Value
    Type Description
    bool?
    Remarks

    Deprecated as of OpenSearch 2.0

    | Edit this page View Source

    MasterTimeout

    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 TimeSpan MasterTimeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    SupportsBody

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

    Timeout

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

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

    WriteIndexOnly

    If true, the mappings are applied only to the current write index for the target.

    Declaration
    public bool? WriteIndexOnly { get; set; }
    Property Value
    Type Description
    bool?

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AllowNoIndices
      • ClusterManagerTimeout
      • DefaultHttpMethod
      • ExpandWildcards
      • IgnoreUnavailable
      • IncludeTypeName
      • MasterTimeout
      • SupportsBody
      • Timeout
      • WriteIndexOnly
    • Implements
    • Extension Methods
    Back to top Generated by DocFX