Class HealthRequestParameters

Request options for Health

<p>https://docs.opensearch.org/latest/security/access-control/api/#health-check</p>
Inheritance
object
RequestParameters<HealthRequestParameters>
HealthRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.SecurityApi
Assembly: OpenSearch.Net.dll
Syntax
public class HealthRequestParameters : RequestParameters<HealthRequestParameters>, 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

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
| 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