Class FieldCapabilitiesDescriptor

Descriptor for FieldCapabilities

https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations

Inheritance
object
RequestBase<FieldCapabilitiesRequestParameters>
RequestDescriptorBase<FieldCapabilitiesDescriptor, FieldCapabilitiesRequestParameters, IFieldCapabilitiesRequest>
FieldCapabilitiesDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class FieldCapabilitiesDescriptor : RequestDescriptorBase<FieldCapabilitiesDescriptor, FieldCapabilitiesRequestParameters, IFieldCapabilitiesRequest>, IDescriptor, IFieldCapabilitiesRequest, IRequest<FieldCapabilitiesRequestParameters>, IRequest

Constructors

| Edit this page View Source

FieldCapabilitiesDescriptor()

/_field_caps

Declaration
public FieldCapabilitiesDescriptor()
| Edit this page View Source

FieldCapabilitiesDescriptor(Indices)

/{index}/_field_caps

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

Optional, accepts null

Properties

| Edit this page View Source

HttpMethod

Declaration
protected override HttpMethod HttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public FieldCapabilitiesDescriptor AllIndices()
Returns
Type Description
FieldCapabilitiesDescriptor
| 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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

Declaration
public FieldCapabilitiesDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
FieldCapabilitiesDescriptor
| 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.

Declaration
public FieldCapabilitiesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
FieldCapabilitiesDescriptor
| Edit this page View Source

Fields(Fields)

Comma-separated list of fields to retrieve capabilities for. Wildcard (*) expressions are supported.

Declaration
public FieldCapabilitiesDescriptor Fields(Fields fields)
Parameters
Type Name Description
Fields fields
Returns
Type Description
FieldCapabilitiesDescriptor
| Edit this page View Source

Fields<T>(params Expression<Func<T, object>>[])

Comma-separated list of fields to retrieve capabilities for. Wildcard (<c>*</c>) expressions are supported.

Declaration
public FieldCapabilitiesDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Type Name Description
Expression<Func<T, object>>[] fields
Returns
Type Description
FieldCapabilitiesDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

IgnoreUnavailable(bool?)

If true, missing or closed indexes are not included in the response.

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

IncludeUnmapped(bool?)

If true, unmapped fields are included in the response.

Declaration
public FieldCapabilitiesDescriptor IncludeUnmapped(bool? includeunmapped = true)
Parameters
Type Name Description
bool? includeunmapped
Returns
Type Description
FieldCapabilitiesDescriptor
| 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 FieldCapabilitiesDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
FieldCapabilitiesDescriptor
| Edit this page View Source

IndexFilter<T>(Func<QueryContainerDescriptor<T>, QueryContainer>)

Declaration
public FieldCapabilitiesDescriptor IndexFilter<T>(Func<QueryContainerDescriptor<T>, QueryContainer> query) where T : class
Parameters
Type Name Description
Func<QueryContainerDescriptor<T>, QueryContainer> query
Returns
Type Description
FieldCapabilitiesDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public FieldCapabilitiesDescriptor Index<TOther>() where TOther : class
Returns
Type Description
FieldCapabilitiesDescriptor
Type Parameters
Name Description
TOther

Implements

Extension Methods