Class GetIndexSettingsDescriptor

Descriptor for GetSettings

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

Inheritance
object
RequestBase<GetIndexSettingsRequestParameters>
RequestDescriptorBase<GetIndexSettingsDescriptor, GetIndexSettingsRequestParameters, IGetIndexSettingsRequest>
GetIndexSettingsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetIndexSettingsDescriptor : RequestDescriptorBase<GetIndexSettingsDescriptor, GetIndexSettingsRequestParameters, IGetIndexSettingsRequest>, IDescriptor, IGetIndexSettingsRequest, IRequest<GetIndexSettingsRequestParameters>, IRequest

Constructors

| Edit this page View Source

GetIndexSettingsDescriptor()

/_settings

Declaration
public GetIndexSettingsDescriptor()
| Edit this page View Source

GetIndexSettingsDescriptor(Indices)

/{index}/_settings

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

Optional, accepts null
| Edit this page View Source

GetIndexSettingsDescriptor(Indices, Names)

/{index}/_settings/{name}

Declaration
public GetIndexSettingsDescriptor(Indices index, Names name)
Parameters
Type Name Description
Indices index

Optional, accepts null
Names name

Optional, accepts null
| Edit this page View Source

GetIndexSettingsDescriptor(Names)

/_settings/{name}

Declaration
public GetIndexSettingsDescriptor(Names name)
Parameters
Type Name Description
Names name

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public GetIndexSettingsDescriptor AllIndices()
Returns
Type Description
GetIndexSettingsDescriptor
| 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 GetIndexSettingsDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
GetIndexSettingsDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public GetIndexSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
GetIndexSettingsDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| 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 GetIndexSettingsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
GetIndexSettingsDescriptor
| Edit this page View Source

FlatSettings(bool?)

If true, returns settings in flat format.

Declaration
public GetIndexSettingsDescriptor FlatSettings(bool? flatsettings = true)
Parameters
Type Name Description
bool? flatsettings
Returns
Type Description
GetIndexSettingsDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

If false, the request returns an error if it targets a missing or closed index.

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

IncludeDefaults(bool?)

If true, return all default settings in the response.

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public GetIndexSettingsDescriptor Index<TOther>() where TOther : class
Returns
Type Description
GetIndexSettingsDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

Local(bool?)

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

Declaration
public GetIndexSettingsDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
GetIndexSettingsDescriptor
| Edit this page View Source

MasterTimeout(Time)

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 GetIndexSettingsDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
GetIndexSettingsDescriptor
| Edit this page View Source

Name(Names)

Comma-separated list or wildcard expression of settings to retrieve.

Declaration
public GetIndexSettingsDescriptor Name(Names name)
Parameters
Type Name Description
Names name
Returns
Type Description
GetIndexSettingsDescriptor

Implements

Extension Methods