Class GetIndexDescriptor
Descriptor for Get
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/get-index/
Inheritance
GetIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexDescriptor : RequestDescriptorBase<GetIndexDescriptor, GetIndexRequestParameters, IGetIndexRequest>, IDescriptor, IGetIndexRequest, IRequest<GetIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
GetIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected GetIndexDescriptor()
|
Edit this page
View Source
GetIndexDescriptor(Indices)
Declaration
public GetIndexDescriptor(Indices index)
Parameters
Type |
Name |
Description |
Indices |
index |
this parameter is required
|
Methods
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public GetIndexDescriptor AllIndices()
Returns
|
Edit this page
View Source
AllowNoIndices(bool?)
Ignore if a wildcard expression resolves to no concrete indices (default: false)
Declaration
public GetIndexDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type |
Name |
Description |
bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public GetIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Whether wildcard expressions should get expanded to open or closed indices (default: open)
Declaration
public GetIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
FlatSettings(bool?)
Return settings in flat format (default: false)
Declaration
public GetIndexDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type |
Name |
Description |
bool? |
flatsettings |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Ignore unavailable indexes (default: false)
Declaration
public GetIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type |
Name |
Description |
bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
IncludeDefaults(bool?)
Whether to return all default setting for each of the indices.
Declaration
public GetIndexDescriptor IncludeDefaults(bool? includedefaults = true)
Parameters
Type |
Name |
Description |
bool? |
includedefaults |
|
Returns
|
Edit this page
View Source
IncludeTypeName(bool?)
Whether to add the type name to the response (default: false)
Declaration
public GetIndexDescriptor 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 GetIndexDescriptor 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 GetIndexDescriptor 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 GetIndexDescriptor Local(bool? local = true)
Parameters
Type |
Name |
Description |
bool? |
local |
|
Returns
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public GetIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
Implements
Extension Methods