Class FieldCapabilitiesDescriptor
Descriptor for FieldCapabilities
Inheritance
FieldCapabilitiesDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class FieldCapabilitiesDescriptor : RequestDescriptorBase<FieldCapabilitiesDescriptor, FieldCapabilitiesRequestParameters, IFieldCapabilitiesRequest>, IDescriptor, IFieldCapabilitiesRequest, IRequest<FieldCapabilitiesRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
FieldCapabilitiesDescriptor()
Declaration
public FieldCapabilitiesDescriptor()
|
Edit this page
View Source
FieldCapabilitiesDescriptor(Indices)
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
Overrides
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public FieldCapabilitiesDescriptor 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 FieldCapabilitiesDescriptor 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 FieldCapabilitiesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
Fields(Fields)
A comma-separated list of field names
Declaration
public FieldCapabilitiesDescriptor Fields(Fields fields)
Parameters
Type |
Name |
Description |
Fields |
fields |
|
Returns
|
Edit this page
View Source
Fields<T>(params Expression<Func<T, object>>[])
A comma-separated list of field names
Declaration
public FieldCapabilitiesDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Returns
Type Parameters
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public FieldCapabilitiesDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
IncludeUnmapped(bool?)
Indicates whether unmapped fields should be included in the response.
Declaration
public FieldCapabilitiesDescriptor IncludeUnmapped(bool? includeunmapped = true)
Parameters
Type |
Name |
Description |
bool? |
includeunmapped |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of index names; use the special string _all
or Indices.All to perform the operation on all indices
Declaration
public FieldCapabilitiesDescriptor Index(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
|
Returns
|
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
Returns
Type Parameters
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public FieldCapabilitiesDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
Implements
Extension Methods