Class GetMappingDescriptor<TDocument>
Descriptor for GetMapping
https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
Inheritance
GetMappingDescriptor<TDocument>
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()
Declaration
public GetMappingDescriptor()
|
Edit this page
View Source
GetMappingDescriptor(Indices)
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
|
Edit this page
View Source
AllowNoIndices(bool?)
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have been specified)
Declaration
public GetMappingDescriptor<TDocument> AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public GetMappingDescriptor<TDocument> ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public GetMappingDescriptor<TDocument> ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public GetMappingDescriptor<TDocument> IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
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
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names
Declaration
public GetMappingDescriptor<TDocument> Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
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 Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public GetMappingDescriptor<TDocument> MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
Implements
Extension Methods