Class DescribeSettingsRequestParameters

Request options for DescribeSettings

<p>https://docs.opensearch.org/latest/api-reference/cluster-api/describe-cluster-settings/</p>
Inheritance
object
RequestParameters<DescribeSettingsRequestParameters>
DescribeSettingsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.ClusterApi
Assembly: OpenSearch.Net.dll
Syntax
public class DescribeSettingsRequestParameters : RequestParameters<DescribeSettingsRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

ClusterManagerTimeout

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

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

Supported by OpenSearch servers of version 3.10.0 or greater.

| Edit this page View Source

DefaultHttpMethod

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

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Settings

A comma-separated list of exact setting names to describe. Wildcards are not supported; each name must be an exact, valid setting key. At least one name is required.

Declaration
public string[] Settings { get; set; }
Property Value
Type Description
string[]
Remarks

Supported by OpenSearch servers of version 3.10.0 or greater.

| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides

Implements

Extension Methods