Interface: IEndpointSpec

nexus.v1.IEndpointSpec

Properties of an EndpointSpec.

Implemented by

• EndpointSpec

Properties

description

• Optional description: null | IPayload

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

---

descriptionDeprecated

• Optional descriptionDeprecated: null | string

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

---

name

• Optional name: null | string

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.

---

policySpecs

• Optional policySpecs: null | IEndpointPolicySpec[]

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.

---

targetSpec

• Optional targetSpec: null | IEndpointTargetSpec

Indicates where the endpoint should forward received nexus requests to.