Class ActuatorRouteBuilderExtensions

Namespace

Steeltoe.Management.Endpoint

Assembly

Steeltoe.Management.EndpointCore.dll

public static class ActuatorRouteBuilderExtensions

Inheritance

object

ActuatorRouteBuilderExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

LookupMiddleware(Type)

public static (Type middleware, Type options) LookupMiddleware(Type endpointType)

Parameters

endpointType Type

Returns

(Type middleware, Type options)

MapAllActuators(IEndpointRouteBuilder)

Maps all actuators that have been registered in Microsoft.Extensions.DependencyInjection.IServiceCollection

[Obsolete("Use MapAllActuators(this IEndpointRouteBuilder endpoints, Action<IEndpointConventionBuilder> convention) instead")]
public static IEndpointConventionBuilder MapAllActuators(this IEndpointRouteBuilder endpoints)

Parameters

endpoints IEndpointRouteBuilder

The endpoint builder

Returns

IEndpointConventionBuilder

Endpoint convention builder

MapAllActuators(IEndpointRouteBuilder, MediaTypeVersion)

Maps all actuators that have been registered in Microsoft.Extensions.DependencyInjection.IServiceCollection

[Obsolete("MediaTypeVersion parameter is not used")]
public static void MapAllActuators(this IEndpointRouteBuilder endpoints, MediaTypeVersion version)

Parameters

endpoints IEndpointRouteBuilder

The endpoint builder

version MediaTypeVersion

Media Version

MapAllActuators(IEndpointRouteBuilder, Action<IEndpointConventionBuilder>)

Maps all actuators that have been registered in Microsoft.Extensions.DependencyInjection.IServiceCollection

public static void MapAllActuators(this IEndpointRouteBuilder endpoints, Action<IEndpointConventionBuilder> convention)

Parameters

endpoints IEndpointRouteBuilder

The endpoint builder

convention Action<IEndpointConventionBuilder>

The convention action to apply

Map<TEndpoint>(IEndpointRouteBuilder, EndpointCollectionConventionBuilder)

Generic routebuilder extension for Actuators.

public static IEndpointConventionBuilder Map<TEndpoint>(this IEndpointRouteBuilder endpoints, EndpointCollectionConventionBuilder conventionBuilder) where TEndpoint : IEndpoint

Parameters

endpoints IEndpointRouteBuilder

IEndpointRouteBuilder to Map route.

conventionBuilder EndpointCollectionConventionBuilder

A convention builder that applies a convention to the whole collection.

Returns

IEndpointConventionBuilder

Type Parameters

TEndpoint

Middleware for which the route is mapped.

Exceptions

InvalidOperationException

When T is not found in service container

Map<TEndpoint>(IEndpointRouteBuilder, Action<IEndpointConventionBuilder>)

Generic routebuilder extension for Actuators.

public static void Map<TEndpoint>(this IEndpointRouteBuilder endpoints, Action<IEndpointConventionBuilder> convention = null) where TEndpoint : IEndpoint

Parameters

endpoints IEndpointRouteBuilder

IEndpointRouteBuilder to Map route.

convention Action<IEndpointConventionBuilder>

A convention builder action that applies a convention to the whole collection.

Type Parameters

TEndpoint

Middleware for which the route is mapped.

Exceptions

InvalidOperationException

When T is not found in service container