Class ClusterAllocationExplainDescriptor

Descriptor for AllocationExplain

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

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

Methods

| Edit this page View Source

IncludeDiskInfo(bool?)

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

Declaration
public ClusterAllocationExplainDescriptor IncludeDiskInfo(bool? includediskinfo = true)
Parameters
Type Name Description
bool? includediskinfo
Returns
Type Description
ClusterAllocationExplainDescriptor
| Edit this page View Source

IncludeYesDecisions(bool?)

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 ClusterAllocationExplainDescriptor IncludeYesDecisions(bool? includeyesdecisions = true)
Parameters
Type Name Description
bool? includeyesdecisions
Returns
Type Description
ClusterAllocationExplainDescriptor
| Edit this page View Source

Index(IndexName)

The name of the index to provide an explanation for

Declaration
public ClusterAllocationExplainDescriptor Index(IndexName index)
Parameters
Type Name Description
IndexName index
Returns
Type Description
ClusterAllocationExplainDescriptor
| Edit this page View Source

Index<TDocument>()

The name of the index to provide an explanation for

Declaration
public ClusterAllocationExplainDescriptor Index<TDocument>()
Returns
Type Description
ClusterAllocationExplainDescriptor
Type Parameters
Name Description
TDocument
| Edit this page View Source

Primary(bool?)

Whether to explain a primary or replica shard

Declaration
public ClusterAllocationExplainDescriptor Primary(bool? primary = true)
Parameters
Type Name Description
bool? primary
Returns
Type Description
ClusterAllocationExplainDescriptor
| Edit this page View Source

Shard(int?)

The shard id to provide an explanation for

Declaration
public ClusterAllocationExplainDescriptor Shard(int? shard)
Parameters
Type Name Description
int? shard
Returns
Type Description
ClusterAllocationExplainDescriptor

Implements

Extension Methods