Class GetFieldMappingRequest

Request for GetFieldMapping

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

Inheritance
object
RequestBase<GetFieldMappingRequestParameters>
PlainRequestBase<GetFieldMappingRequestParameters>
GetFieldMappingRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetFieldMappingRequest : PlainRequestBase<GetFieldMappingRequestParameters>, IGetFieldMappingRequest, IRequest<GetFieldMappingRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetFieldMappingRequest()

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

Declaration
protected GetFieldMappingRequest()
| Edit this page View Source

GetFieldMappingRequest(Fields)

/_mapping/field/{fields}

Declaration
public GetFieldMappingRequest(Fields fields)
Parameters
Type Name Description
Fields fields

this parameter is required
| Edit this page View Source

GetFieldMappingRequest(Indices, Fields)

/{index}/_mapping/field/{fields}

Declaration
public GetFieldMappingRequest(Indices index, Fields fields)
Parameters
Type Name Description
Indices index

Optional, accepts null
Fields fields

this parameter is required

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

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

IncludeDefaults

If true, return all default settings in the response.

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

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

| Edit this page View Source

Local

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

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

Self

Declaration
protected IGetFieldMappingRequest Self { get; }
Property Value
Type Description
IGetFieldMappingRequest

Implements

Extension Methods