Class ClusterAllocationExplainRequestParameters

Request options for AllocationExplain

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

Properties

| Edit this page View Source

DefaultHttpMethod

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

IncludeDiskInfo

When true, returns information about disk usage and shard sizes.

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

IncludeYesDecisions

When true, returns any YES decisions in the allocation explanation. YES decisions indicate when a particular shard allocation attempt was successful for the given node.

Declaration
public bool? IncludeYesDecisions { get; set; }
Property Value
Type Description
bool?
| 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

SupportsBody

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

Implements

Extension Methods