Class ClusterAllocationExplainRequestParameters

Request options for AllocationExplain

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

Inheritance

object

RequestParameters<ClusterAllocationExplainRequestParameters>

ClusterAllocationExplainRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<ClusterAllocationExplainRequestParameters>.CustomResponseBuilder

RequestParameters<ClusterAllocationExplainRequestParameters>.QueryString

RequestParameters<ClusterAllocationExplainRequestParameters>.RequestConfiguration

RequestParameters<ClusterAllocationExplainRequestParameters>.ContainsQueryString(string)

RequestParameters<ClusterAllocationExplainRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<ClusterAllocationExplainRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<ClusterAllocationExplainRequestParameters>.SetQueryString(string, object)

RequestParameters<ClusterAllocationExplainRequestParameters>.Q<TOut>(string)

RequestParameters<ClusterAllocationExplainRequestParameters>.Q(string, object)

RequestParameters<ClusterAllocationExplainRequestParameters>.SetAcceptHeader(string)

RequestParameters<ClusterAllocationExplainRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.ClusterApi

Assembly: OpenSearch.Net.dll

Syntax

public class ClusterAllocationExplainRequestParameters : RequestParameters<ClusterAllocationExplainRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<ClusterAllocationExplainRequestParameters>.DefaultHttpMethod

IncludeDiskInfo

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

Declaration

public bool? IncludeDiskInfo { get; set; }

Property Value

Type	Description
bool?

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?

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<ClusterAllocationExplainRequestParameters>.SupportsBody

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)