Skip to main content

Class: EndpointSpec

Contains mutable fields for an Endpoint.

Properties​

description?​

optional description?: $Properties | null

Markdown description serialized as a single JSON string. If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint. By default, the server enforces a limit of 20,000 bytes for this entire payload.

name​

name: string

Endpoint name, unique for this cluster. Must match [a-zA-Z_][a-zA-Z0-9_]*. Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.

target?​

optional target?: $Properties | null

Target to route 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.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.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​

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