Class GetFieldMappingRequest
Request for GetFieldMapping
https://opensearch.org/docs/latest/opensearch/rest-api/update-mapping/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetFieldMappingRequest : PlainRequestBase<GetFieldMappingRequestParameters>, IGetFieldMappingRequest, IRequest<GetFieldMappingRequestParameters>, IRequest
Constructors
| Edit this page View SourceGetFieldMappingRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected GetFieldMappingRequest()
GetFieldMappingRequest(Fields)
/_mapping/field/{fields}
Declaration
public GetFieldMappingRequest(Fields fields)
Parameters
Type | Name | Description |
---|---|---|
Fields | fields | this parameter is required |
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 SourceAllowNoIndices
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 bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ExpandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
IgnoreUnavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeDefaults
Whether the default mapping values should be returned as well
Declaration
public bool? IncludeDefaults { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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
Local
Return local information, do not retrieve the state from cluster_manager node (default: false)
Declaration
public bool? Local { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Self
Declaration
protected IGetFieldMappingRequest Self { get; }
Property Value
Type | Description |
---|---|
IGetFieldMappingRequest |