Class EndpointOptions

Inheritance

System.Object

EndpointOptions

CloudFoundryEndpointOptions

DbMigrationsEndpointOptions

EnvironmentEndpointOptions

HealthEndpointOptions

HeapDumpEndpointOptions

HttpExchangesEndpointOptions

HypermediaEndpointOptions

InfoEndpointOptions

LoggersEndpointOptions

RefreshEndpointOptions

RouteMappingsEndpointOptions

ServicesEndpointOptions

ThreadDumpEndpointOptions

Namespace: Steeltoe.Management.Configuration

Assembly: Steeltoe.Management.Abstractions.dll

Syntax

public abstract class EndpointOptions : object

Properties

AllowedVerbs

Gets the list of HTTP verbs that are allowed for this endpoint.

Declaration

public IList<string> AllowedVerbs { get; }

Property Value

Type	Description
IList<System.String>

Enabled

Gets or sets a value indicating whether this endpoint is enabled.

Declaration

public virtual bool? Enabled { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Id

Gets or sets the unique ID of this endpoint.

Declaration

public virtual string? Id { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Path

Gets or sets the relative path at which this endpoint is exposed.

Declaration

public virtual string? Path { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

RequiredPermissions

Gets or sets the permissions required to access this endpoint, when running on Cloud Foundry. Default value: Restricted.

Declaration

public EndpointPermissions RequiredPermissions { get; set; }

Property Value

Type	Description
EndpointPermissions

Methods

GetDefaultAllowedVerbs()

Gets the default list of HTTP verbs that are allowed for this endpoint.

Declaration

protected virtual IList<string> GetDefaultAllowedVerbs()

Returns

Type	Description
IList<System.String>

RequiresExactMatch()

Indicates whether this endpoint requires an exact match on the path.

Declaration

public virtual bool RequiresExactMatch()

Returns

Type	Description
System.Boolean