Class EndpointOptions

Namespace

Steeltoe.Management.Configuration

Assembly

Steeltoe.Management.Abstractions.dll

public abstract class EndpointOptions

Inheritance

object

EndpointOptions

Derived

CloudFoundryEndpointOptions

DbMigrationsEndpointOptions

EnvironmentEndpointOptions

HealthEndpointOptions

HeapDumpEndpointOptions

HttpExchangesEndpointOptions

HypermediaEndpointOptions

InfoEndpointOptions

LoggersEndpointOptions

RefreshEndpointOptions

RouteMappingsEndpointOptions

ServicesEndpointOptions

ThreadDumpEndpointOptions

PrometheusEndpointOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowedVerbs

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

public IList<string> AllowedVerbs { get; }

Property Value

IList<string>

Enabled

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

public virtual bool? Enabled { get; set; }

Property Value

bool?

Id

Gets or sets the unique ID of this endpoint.

public virtual string? Id { get; set; }

Property Value

string

Path

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

public virtual string? Path { get; set; }

Property Value

string

RequiredPermissions

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

public EndpointPermissions RequiredPermissions { get; set; }

Property Value

EndpointPermissions

Methods

GetDefaultAllowedVerbs()

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

protected virtual IList<string> GetDefaultAllowedVerbs()

Returns

IList<string>

RequiresExactMatch()

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

public virtual bool RequiresExactMatch()

Returns

bool