Class HealthRequestParameters

Request options for Health

https://opensearch.org/docs/latest/security/access-control/api/#health-check

Inheritance

object

RequestParameters<HealthRequestParameters>

HealthRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<HealthRequestParameters>.CustomResponseBuilder

RequestParameters<HealthRequestParameters>.QueryString

RequestParameters<HealthRequestParameters>.RequestConfiguration

RequestParameters<HealthRequestParameters>.ContainsQueryString(string)

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

RequestParameters<HealthRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<HealthRequestParameters>.SetQueryString(string, object)

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

RequestParameters<HealthRequestParameters>.Q(string, object)

RequestParameters<HealthRequestParameters>.SetAcceptHeader(string)

RequestParameters<HealthRequestParameters>.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.SecurityApi

Assembly: OpenSearch.Net.dll

Syntax

public class HealthRequestParameters : RequestParameters<HealthRequestParameters>, IRequestParameters

Properties

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<HealthRequestParameters>.DefaultHttpMethod

Mode

A flag that determines whether to consider the security status before returning a response for a health query response. For example, strict mode indicates service should check the Security plugin status.

Declaration

public string Mode { get; set; }

Property Value

Type	Description
string

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<HealthRequestParameters>.SupportsBody

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)