Table of Contents

Class HealthEndpointOptions

Namespace
Steeltoe.Management.Endpoint.Actuators.Health
Assembly
Steeltoe.Management.Endpoint.dll
public sealed class HealthEndpointOptions : EndpointOptions
Inheritance
HealthEndpointOptions
Inherited Members

Properties

Claim

Gets or sets the claim requirements for retrieving components and/or details.

public EndpointClaim? Claim { get; set; }

Property Value

EndpointClaim

Groups

Gets the configured health groups.

public IDictionary<string, HealthGroupOptions> Groups { get; }

Property Value

IDictionary<string, HealthGroupOptions>

Role

Gets or sets the role required to retrieve components and/or details.

public string? Role { get; set; }

Property Value

string

ShowComponents

Gets or sets when to show components in responses.

public ShowValues ShowComponents { get; set; }

Property Value

ShowValues

ShowDetails

Gets or sets when to show details of components in responses.

public ShowValues ShowDetails { get; set; }

Property Value

ShowValues

Methods

RequiresExactMatch()

Indicates whether this endpoint requires an exact match on the path.

public override bool RequiresExactMatch()

Returns

bool