Class GetFieldMappingRequestParameters

Request options for GetFieldMapping

https://opensearch.org/docs/latest/field-types/index/

Inheritance

object

RequestParameters<GetFieldMappingRequestParameters>

GetFieldMappingRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<GetFieldMappingRequestParameters>.CustomResponseBuilder

RequestParameters<GetFieldMappingRequestParameters>.QueryString

RequestParameters<GetFieldMappingRequestParameters>.RequestConfiguration

RequestParameters<GetFieldMappingRequestParameters>.ContainsQueryString(string)

RequestParameters<GetFieldMappingRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<GetFieldMappingRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<GetFieldMappingRequestParameters>.SetQueryString(string, object)

RequestParameters<GetFieldMappingRequestParameters>.Q<TOut>(string)

RequestParameters<GetFieldMappingRequestParameters>.Q(string, object)

RequestParameters<GetFieldMappingRequestParameters>.SetAcceptHeader(string)

RequestParameters<GetFieldMappingRequestParameters>.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 GetFieldMappingRequestParameters : RequestParameters<GetFieldMappingRequestParameters>, IRequestParameters

Properties

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?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<GetFieldMappingRequestParameters>.DefaultHttpMethod

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?

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?

IncludeDefaults

If true, return all default settings in the response.

Declaration

public bool? IncludeDefaults { get; set; }

Property Value

Type	Description
bool?

IncludeTypeName

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

Declaration

public bool? IncludeTypeName { get; set; }

Property Value

Type	Description
bool?

Remarks

Deprecated as of OpenSearch 2.0

Local

If true, the request retrieves information from the local node only.

Declaration

public bool? Local { get; set; }

Property Value

Type	Description
bool?

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<GetFieldMappingRequestParameters>.SupportsBody

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)