Class ManagementWebApplicationBuilderExtensions

Namespace

Steeltoe.Management.Endpoint

Assembly

Steeltoe.Management.EndpointCore.dll

public static class ManagementWebApplicationBuilderExtensions

Inheritance

object

ManagementWebApplicationBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddAllActuators(WebApplicationBuilder, Action<IEndpointConventionBuilder>, MediaTypeVersion, Action<CorsPolicyBuilder>)

Adds all Steeltoe Actuators to the application

public static WebApplicationBuilder AddAllActuators(this WebApplicationBuilder applicationBuilder, Action<IEndpointConventionBuilder> configureEndpoints = null, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2, Action<CorsPolicyBuilder> buildCorsPolicy = null)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

configureEndpoints Action<IEndpointConventionBuilder>

IEndpointConventionBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

buildCorsPolicy Action<CorsPolicyBuilder>

Customize the CORS policy.

Returns

WebApplicationBuilder

AddCloudFoundryActuator(WebApplicationBuilder)

Adds the Cloud Foundry actuator to the application

public static WebApplicationBuilder AddCloudFoundryActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddDbMigrationsActuator(WebApplicationBuilder)

Adds the Database Migrations actuator to the application

public static WebApplicationBuilder AddDbMigrationsActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddEnvActuator(WebApplicationBuilder)

Adds the Environment actuator to the application

public static WebApplicationBuilder AddEnvActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddHealthActuator(WebApplicationBuilder)

Adds the Health actuator to the application

public static WebApplicationBuilder AddHealthActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddHealthActuator(WebApplicationBuilder, IHealthAggregator, Type[])

Adds the Health actuator to the application

public static WebApplicationBuilder AddHealthActuator(this WebApplicationBuilder applicationBuilder, IHealthAggregator aggregator, Type[] contributors)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

aggregator IHealthAggregator

Custom health aggregator

contributors Type[]

Types that contribute to the overall health of the app

Returns

WebApplicationBuilder

AddHealthActuator(WebApplicationBuilder, Type[])

Adds the Health actuator to the application

public static WebApplicationBuilder AddHealthActuator(this WebApplicationBuilder applicationBuilder, Type[] contributors)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

contributors Type[]

Types that contribute to the overall health of the app

Returns

WebApplicationBuilder

AddHeapDumpActuator(WebApplicationBuilder)

Adds the HeapDump actuator to the application

public static WebApplicationBuilder AddHeapDumpActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddHypermediaActuator(WebApplicationBuilder)

Adds the Hypermedia actuator to the application

public static WebApplicationBuilder AddHypermediaActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddInfoActuator(WebApplicationBuilder)

Adds the Info actuator to the application

public static WebApplicationBuilder AddInfoActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddInfoActuator(WebApplicationBuilder, IInfoContributor[])

Adds the Info actuator to the application

public static WebApplicationBuilder AddInfoActuator(this WebApplicationBuilder applicationBuilder, IInfoContributor[] contributors)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

contributors IInfoContributor[]

Contributors to application information

Returns

WebApplicationBuilder

AddLoggersActuator(WebApplicationBuilder)

Adds the Loggers actuator to the application

public static WebApplicationBuilder AddLoggersActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddMappingsActuator(WebApplicationBuilder)

Adds the Mappings actuator to the application

public static WebApplicationBuilder AddMappingsActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddMetricsActuator(WebApplicationBuilder)

Adds the Metrics actuator to the application

[Obsolete("This feature will be removed in the next major version. See https://steeltoe.io/docs/v3/obsolete for details.")]
public static WebApplicationBuilder AddMetricsActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddRefreshActuator(WebApplicationBuilder)

Adds the Refresh actuator to the application

public static WebApplicationBuilder AddRefreshActuator(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder

AddThreadDumpActuator(WebApplicationBuilder, MediaTypeVersion)

Adds the ThreadDump actuator to the application

public static WebApplicationBuilder AddThreadDumpActuator(this WebApplicationBuilder applicationBuilder, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

Returns

WebApplicationBuilder

AddTraceActuator(WebApplicationBuilder, MediaTypeVersion)

Adds the Trace actuator to the application

public static WebApplicationBuilder AddTraceActuator(this WebApplicationBuilder applicationBuilder, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

Returns

WebApplicationBuilder

AddWavefrontMetrics(WebApplicationBuilder)

Add Wavefront Metrics Exporter

[Obsolete("This feature will be removed in the next major version. See https://steeltoe.io/docs/v3/obsolete for details.")]
public static WebApplicationBuilder AddWavefrontMetrics(this WebApplicationBuilder applicationBuilder)

Parameters

applicationBuilder WebApplicationBuilder

Your WebApplicationBuilder

Returns

WebApplicationBuilder