Skip to main content

Interface: IEndpointSpec

Properties of an EndpointSpec.

Extends​

Properties​

description?​

optional description?: $Properties | null

The markdown description of the endpoint - optional. temporal:versioning:min_version=v0.4.0

Inherited from​

$Properties.description

descriptionDeprecated?​

optional descriptionDeprecated?: string | null

Deprecated: Not supported after v0.4.0 api version. Use description instead. temporal:versioning:max_version=v0.4.0

Inherited from​

$Properties.descriptionDeprecated

name?​

optional name?: string | null

The name of the endpoint. Must be unique within an account. The name must match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$. This field is mutable.

Inherited from​

$Properties.name

policySpecs?​

optional policySpecs?: $Properties[] | null

The set of policies (e.g. authorization) for the endpoint. Each request's caller must match with at least one of the specs to be accepted by the endpoint. This field is mutable.

Inherited from​

$Properties.policySpecs

targetSpec?​

optional targetSpec?: $Properties | null

Indicates where the endpoint should forward received nexus requests to.

Inherited from​

$Properties.targetSpec