Class ClusterAllocationExplainRequest

Request for AllocationExplain

https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/

Inheritance
object
RequestBase<ClusterAllocationExplainRequestParameters>
PlainRequestBase<ClusterAllocationExplainRequestParameters>
ClusterAllocationExplainRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterAllocationExplainRequest : PlainRequestBase<ClusterAllocationExplainRequestParameters>, IClusterAllocationExplainRequest, IRequest<ClusterAllocationExplainRequestParameters>, IRequest

Properties

| 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

Index

The name of the index to provide an explanation for

Declaration
public IndexName Index { get; set; }
Property Value
Type Description
IndexName
| Edit this page View Source

Primary

Whether to explain a primary or replica shard

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

Self

Declaration
protected IClusterAllocationExplainRequest Self { get; }
Property Value
Type Description
IClusterAllocationExplainRequest
| Edit this page View Source

Shard

The shard id to provide an explanation for

Declaration
public int? Shard { get; set; }
Property Value
Type Description
int?

Implements

Extension Methods