Class HealthEndpoint

Namespace

Steeltoe.Management.Endpoint.Health

Assembly

Steeltoe.Management.EndpointBase.dll

public class HealthEndpoint : AbstractEndpoint<HealthCheckResult, ISecurityContext>, IEndpoint<HealthCheckResult, ISecurityContext>, IEndpoint

Inheritance

object

AbstractEndpoint

AbstractEndpoint<HealthCheckResult, ISecurityContext>

HealthEndpoint

Implements

IEndpoint<HealthCheckResult, ISecurityContext>

IEndpoint

Derived

HealthEndpointCore

Inherited Members

AbstractEndpoint<HealthCheckResult, ISecurityContext>.Invoke(ISecurityContext)

AbstractEndpoint.options

AbstractEndpoint.Id

AbstractEndpoint.Enabled

AbstractEndpoint.Sensitive

AbstractEndpoint.Path

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EndPointExtensions.IsEnabled(IEndpoint, IManagementOptions)

EndPointExtensions.IsExposed(IEndpoint, IManagementOptions)

EndPointExtensions.RequestVerbAndPathMatch(IEndpoint, string, string, IEnumerable<HttpMethod>, IEnumerable<IManagementOptions>, bool)

Constructors

HealthEndpoint(IHealthOptions, IHealthAggregator, IEnumerable<IHealthContributor>, ILogger<HealthEndpoint>)

public HealthEndpoint(IHealthOptions options, IHealthAggregator aggregator, IEnumerable<IHealthContributor> contributors, ILogger<HealthEndpoint> logger = null)

Parameters

options IHealthOptions

aggregator IHealthAggregator

contributors IEnumerable<IHealthContributor>

logger ILogger<HealthEndpoint>

Properties

Options

public IHealthOptions Options { get; }

Property Value

IHealthOptions

Methods

BuildHealth(IHealthAggregator, IList<IHealthContributor>, ISecurityContext)

protected virtual HealthCheckResult BuildHealth(IHealthAggregator aggregator, IList<IHealthContributor> contributors, ISecurityContext securityContext)

Parameters

aggregator IHealthAggregator

contributors IList<IHealthContributor>

securityContext ISecurityContext

Returns

HealthCheckResult

GetStatusCode(HealthCheckResult)

public int GetStatusCode(HealthCheckResult health)

Parameters

health HealthCheckResult

Returns

int

Invoke(ISecurityContext)

public override HealthCheckResult Invoke(ISecurityContext securityContext)

Parameters

securityContext ISecurityContext

Returns

HealthCheckResult