Class ManagementOptions

Provides configuration settings for management endpoints (actuators).

Inheritance

System.Object

ManagementOptions

Namespace: Steeltoe.Management.Endpoint.Configuration

Assembly: Steeltoe.Management.Endpoint.dll

Syntax

public sealed class ManagementOptions : object

Properties

CustomJsonConverters

Gets a list of assembly-qualified custom JSON converters.

Declaration

public IList<string> CustomJsonConverters { get; }

Property Value

Type	Description
IList<System.String>

Enabled

Gets or sets a value indicating whether management endpoints are enabled. Default value: true.

Declaration

public bool? Enabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Path

Gets or sets the HTTP request path at which management endpoints are exposed. Default value: /actuator.

Declaration

public string? Path { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Port

Gets or sets the alternate HTTP port at which management endpoints are exposed.

Declaration

public string? Port { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

SerializerOptions

Gets or sets the JSON serialization options.

Declaration

public JsonSerializerOptions SerializerOptions { get; set; }

Property Value

Type	Description
JsonSerializerOptions

SslEnabled

Gets or sets a value indicating whether Port applies to HTTP or HTTPS requests. Default value: false.

Declaration

public bool SslEnabled { get; set; }

Property Value

Type	Description
System.Boolean

UseStatusCodeFromResponse

Gets or sets a value indicating whether the HTTP response status code is based on the health status. This setting can be overruled by sending an X-Use-Status-Code-From-Response HTTP header. Default value: true.

Declaration

public bool UseStatusCodeFromResponse { get; set; }

Property Value

Type	Description
System.Boolean