Skip to main content

Class: EndpointSpec

Represents an EndpointSpec.

Properties​

description?​

optional description?: $Properties | null

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

descriptionDeprecated​

descriptionDeprecated: string

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

name​

name: 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​

policySpecs: $Properties[]

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?: $Properties | null

Indicates where the endpoint should forward received nexus requests to.

Methods​

toJSON()​

toJSON(): object

Converts this EndpointSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): EndpointSpec & $Shape

Creates a new EndpointSpec instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

EndpointSpec & $Shape

EndpointSpec instance

Call Signature​

static create(properties?): EndpointSpec

Creates a new EndpointSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EndpointSpec

EndpointSpec instance

decode()​

static decode(reader, length?): EndpointSpec & $Shape

Decodes an EndpointSpec message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

EndpointSpec & $Shape

EndpointSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EndpointSpec & $Shape

Decodes an EndpointSpec message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EndpointSpec & $Shape

EndpointSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified EndpointSpec message. Does not implicitly temporal.api.cloud.nexus.v1.EndpointSpec.verify|verify messages.

Parameters​

message​

$Properties

EndpointSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified EndpointSpec message, length delimited. Does not implicitly temporal.api.cloud.nexus.v1.EndpointSpec.verify|verify messages.

Parameters​

message​

$Properties

EndpointSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EndpointSpec

Creates an EndpointSpec message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

EndpointSpec

EndpointSpec

toObject()​

static toObject(message, options?): object

Creates a plain object from an EndpointSpec message. Also converts values to other types if specified.

Parameters​

message​

EndpointSpec

EndpointSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object