ControllerActionEndpointConventionBuilder Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Builder

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

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

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

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

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

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: ControllerActionEndpointConventionBuilder.cs

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 EndpointBuilder instances.

public ref class ControllerActionEndpointConventionBuilder sealed : Microsoft::AspNetCore::Builder::IEndpointConventionBuilder

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

type ControllerActionEndpointConventionBuilder = class
    interface IEndpointConventionBuilder

Public NotInheritable Class ControllerActionEndpointConventionBuilder
Implements IEndpointConventionBuilder

Inheritance: Object
ControllerActionEndpointConventionBuilder

Implements: IEndpointConventionBuilder

Remarks

This interface is used at application startup to customize endpoints for the application.

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

WithStaticAssets(ControllerActionEndpointConventionBuilder, String)	Adds a ResourceAssetCollection metadata instance to the endpoints.
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.

Applies to

Share via