Class GetIndexRequest

Request for Get

https://opensearch.org/docs/latest/api-reference/index-apis/get-index/

Inheritance
object
RequestBase<GetIndexRequestParameters>
PlainRequestBase<GetIndexRequestParameters>
GetIndexRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexRequest : PlainRequestBase<GetIndexRequestParameters>, IGetIndexRequest, IRequest<GetIndexRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetIndexRequest()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected GetIndexRequest()
| Edit this page View Source

GetIndexRequest(Indices)

/{index}

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

this parameter is required

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

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

ExpandWildcards

Type of index that wildcard expressions 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

FlatSettings

If true, returns settings in flat format.

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

IgnoreUnavailable

If false, requests that target a missing index return an error.

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

IncludeDefaults

If true, return all default settings in the response.

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

IncludeTypeName

Whether to add the type name to the response (default: false)

Declaration
public bool? IncludeTypeName { get; set; }
Property Value
Type Description
bool?
Remarks

Deprecated as of OpenSearch 2.0

| Edit this page View Source

Local

If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

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

MasterTimeout

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

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

Implements

Extension Methods