Class FieldCapabilitiesRequest

Request for FieldCapabilities

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

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

Constructors

| Edit this page View Source

FieldCapabilitiesRequest()

/_field_caps

Declaration
public FieldCapabilitiesRequest()
| Edit this page View Source

FieldCapabilitiesRequest(Indices)

/{index}/_field_caps

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

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

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 bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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 ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

Fields

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

Declaration
public Fields Fields { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

HttpMethod

Declaration
protected override HttpMethod HttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

IgnoreUnavailable

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

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IncludeUnmapped

If true, unmapped fields are included in the response.

Declaration
public bool? IncludeUnmapped { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IndexFilter

Declaration
public QueryContainer IndexFilter { get; set; }
Property Value
Type Description
QueryContainer
| Edit this page View Source

Self

Declaration
protected IFieldCapabilitiesRequest Self { get; }
Property Value
Type Description
IFieldCapabilitiesRequest

Implements

Extension Methods