Class GetMappingDescriptor<TDocument>

Descriptor for GetMapping

https://opensearch.org/docs/latest/field-types/index/#get-a-mapping

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

Constructors

| Edit this page View Source

GetMappingDescriptor()

/{index}/_mapping

Declaration
public GetMappingDescriptor()
| Edit this page View Source

GetMappingDescriptor(Indices)

/{index}/_mapping

Declaration
public GetMappingDescriptor(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public GetMappingDescriptor<TDocument> AllIndices()
Returns
Type Description
GetMappingDescriptor<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 indices. This behavior applies even if the request targets other open indices.

Declaration
public GetMappingDescriptor<TDocument> AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
GetMappingDescriptor<TDocument>
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public GetMappingDescriptor<TDocument> ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
GetMappingDescriptor<TDocument>
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| 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 GetMappingDescriptor<TDocument> ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
GetMappingDescriptor<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 GetMappingDescriptor<TDocument> IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
GetMappingDescriptor<TDocument>
| Edit this page View Source

IncludeTypeName(bool?)

Whether to add the type name to the response (default: false)

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

Deprecated as of OpenSearch 2.0

| Edit this page View Source

Index(Indices)

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

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public GetMappingDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Description
GetMappingDescriptor<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 GetMappingDescriptor<TDocument> Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
GetMappingDescriptor<TDocument>
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the master 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 GetMappingDescriptor<TDocument> MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
GetMappingDescriptor<TDocument>

Implements

Extension Methods