Class GetFieldMappingDescriptor<TDocument>
Descriptor for GetFieldMapping
https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
Inheritance
GetFieldMappingDescriptor<TDocument>
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
|
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 GetFieldMappingDescriptor<TDocument> AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public GetFieldMappingDescriptor<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 GetFieldMappingDescriptor<TDocument> IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
IncludeDefaults(bool?)
Whether the default mapping values should be returned as well
Declaration
public GetFieldMappingDescriptor<TDocument> IncludeDefaults(bool? includedefaults = true)
Parameters
Type |
Name |
Description |
bool? |
includedefaults |
|
Returns
|
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
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names
Declaration
public GetFieldMappingDescriptor<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 GetFieldMappingDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Local(bool?)
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public GetFieldMappingDescriptor<TDocument> Local(bool? local = true)
Parameters
Type |
Name |
Description |
bool? |
local |
|
Returns
Implements
Extension Methods