X

Class HealthEndpointOptions

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

Properties

| Edit this page View Source

Claim

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

Declaration
public EndpointClaim Claim { get; set; }
Property Value
Type Description
EndpointClaim
| Edit this page View Source

Groups

Gets the configured health groups.

Declaration
public IDictionary<string, HealthGroupOptions> Groups { get; }
Property Value
Type Description
IDictionary<System.String, HealthGroupOptions>
| Edit this page View Source

Role

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

Declaration
public string? Role { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Edit this page View Source

ShowComponents

Gets or sets when to show components in responses.

Declaration
public ShowValues ShowComponents { get; set; }
Property Value
Type Description
ShowValues
| Edit this page View Source

ShowDetails

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

Declaration
public ShowValues ShowDetails { get; set; }
Property Value
Type Description
ShowValues

Methods

| Edit this page View Source

RequiresExactMatch()

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

Declaration
public override bool RequiresExactMatch()
Returns
Type Description
System.Boolean
Overrides