RouteHandlerBuilder Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Builder

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Builds conventions that will be used for customization of MapAction EndpointBuilder instances.

public sealed class RouteHandlerBuilder : Microsoft.AspNetCore.Builder.IEndpointConventionBuilder

type RouteHandlerBuilder = class
    interface IEndpointConventionBuilder

Public NotInheritable Class RouteHandlerBuilder
Implements IEndpointConventionBuilder

Inheritance: Object
RouteHandlerBuilder

Implements: IEndpointConventionBuilder

Constructors

RouteHandlerBuilder(IEnumerable<IEndpointConventionBuilder>)

Instantiates a new RouteHandlerBuilder given multiple IEndpointConventionBuilder instances.

Methods

Add(Action<EndpointBuilder>)	Adds the specified convention to the builder. Conventions are used to customize EndpointBuilder instances.
Finally(Action<EndpointBuilder>)	Registers the specified convention for execution after conventions registered via Add(Action<EndpointBuilder>)

Extension Methods

DisableRequestTimeout(IEndpointConventionBuilder)	Disables request timeout on the endpoint(s).
WithRequestTimeout(IEndpointConventionBuilder, RequestTimeoutPolicy)	Specifies a timeout policy for to the endpoint(s).
WithRequestTimeout(IEndpointConventionBuilder, String)	Specifies a timeout policy for to the endpoint(s).
WithRequestTimeout(IEndpointConventionBuilder, TimeSpan)	Specifies a timeout for the endpoint(s).
ShortCircuit(IEndpointConventionBuilder, Nullable<Int32>)	Short circuit the endpoint(s). The execution of the endpoint will happen in UseRouting middleware instead of UseEndpoint.
AddEndpointFilter<TFilterType>(RouteHandlerBuilder)	Registers a filter of type `TFilterType` onto the route handler.
Accepts(RouteHandlerBuilder, Type, Boolean, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by `builder`.
Accepts(RouteHandlerBuilder, Type, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by `builder`.
Accepts<TRequest>(RouteHandlerBuilder, Boolean, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by `builder`.
Accepts<TRequest>(RouteHandlerBuilder, String, String[])	Adds IAcceptsMetadata to Metadata for all endpoints produced by `builder`.
ExcludeFromDescription(RouteHandlerBuilder)	Adds the IExcludeFromDescriptionMetadata to Metadata for all endpoints produced by `builder`.
Produces(RouteHandlerBuilder, Int32, Type, String, String[])	Adds an IProducesResponseTypeMetadata to Metadata for all endpoints produced by `builder`.
Produces<TResponse>(RouteHandlerBuilder, Int32, String, String[])	Adds an IProducesResponseTypeMetadata to Metadata for all endpoints produced by `builder`.
ProducesProblem(RouteHandlerBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a ProblemDetails type to Metadata for all endpoints produced by `builder`.
ProducesValidationProblem(RouteHandlerBuilder, Int32, String)	Adds an IProducesResponseTypeMetadata with a HttpValidationProblemDetails type to Metadata for all endpoints produced by `builder`.
WithTags(RouteHandlerBuilder, String[])	Adds the ITagsMetadata to Metadata for all endpoints produced by `builder`.

Applies to