Class GetFieldMappingDescriptor<TDocument>

Descriptor for GetFieldMapping

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

Inheritance
object
RequestBase<GetFieldMappingRequestParameters>
RequestDescriptorBase<GetFieldMappingDescriptor<TDocument>, GetFieldMappingRequestParameters, IGetFieldMappingRequest>
GetFieldMappingDescriptor<TDocument>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetFieldMappingDescriptor<TDocument> : RequestDescriptorBase<GetFieldMappingDescriptor<TDocument>, GetFieldMappingRequestParameters, IGetFieldMappingRequest>, IDescriptor, IGetFieldMappingRequest, IRequest<GetFieldMappingRequestParameters>, IRequest where TDocument : class
Type Parameters
Name Description
TDocument

Constructors

| Edit this page View Source

GetFieldMappingDescriptor()

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

Declaration
protected GetFieldMappingDescriptor()
| Edit this page View Source

GetFieldMappingDescriptor(Fields)

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

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

this parameter is required
| Edit this page View Source

GetFieldMappingDescriptor(Indices, Fields)

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

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

Optional, accepts null
Fields fields

this parameter is required

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public GetFieldMappingDescriptor<TDocument> AllIndices()
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
| Edit this page View Source

AllowNoIndices(bool?)

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 GetFieldMappingDescriptor<TDocument> AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
| Edit this page View Source

ExpandWildcards(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 GetFieldMappingDescriptor<TDocument> ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
| Edit this page View Source

IgnoreUnavailable(bool?)

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

Declaration
public GetFieldMappingDescriptor<TDocument> IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
| Edit this page View Source

IncludeDefaults(bool?)

If true, return all default settings in the response.

Declaration
public GetFieldMappingDescriptor<TDocument> IncludeDefaults(bool? includedefaults = true)
Parameters
Type Name Description
bool? includedefaults
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
| Edit this page View Source

IncludeTypeName(bool?)

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

Declaration
public GetFieldMappingDescriptor<TDocument> IncludeTypeName(bool? includetypename = true)
Parameters
Type Name Description
bool? includetypename
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

Index(Indices)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

Declaration
public GetFieldMappingDescriptor<TDocument> Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public GetFieldMappingDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Description
GetFieldMappingDescriptor<TDocument>
Type Parameters
Name Description
TOther
| Edit this page View Source

Local(bool?)

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

Declaration
public GetFieldMappingDescriptor<TDocument> Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
GetFieldMappingDescriptor<TDocument>

Implements

Extension Methods