Skip to main content

Class: Endpoint

An endpoint that receives and then routes Nexus requests

Properties​

asyncOperationId​

asyncOperationId: string

The id of any ongoing async operation that is creating, updating, or deleting the endpoint, if any.

createdTime?​

optional createdTime?: $Properties | null

The date and time when the endpoint was created.

id​

id: string

The id of the endpoint. This is generated by the server and is immutable.

lastModifiedTime?​

optional lastModifiedTime?: $Properties | null

The date and time when the endpoint was last modified.

resourceVersion​

resourceVersion: string

The current version of the endpoint specification. The next update operation must include this version.

spec?​

optional spec?: $Properties | null

The endpoint specification.

state​

state: ResourceState

The current state of the endpoint. For any failed state, reach out to Temporal Cloud support for remediation.

Methods​

toJSON()​

toJSON(): object

Converts this Endpoint to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Endpoint & $Shape

Creates a new Endpoint instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Endpoint & $Shape

Endpoint instance

Call Signature​

static create(properties?): Endpoint

Creates a new Endpoint instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Endpoint

Endpoint instance

decode()​

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

Decodes an Endpoint 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​

Endpoint & $Shape

Endpoint

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Endpoint & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Endpoint & $Shape

Endpoint

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 Endpoint message. Does not implicitly temporal.api.cloud.nexus.v1.Endpoint.verify|verify messages.

Parameters​

message​

$Properties

Endpoint message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Endpoint message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Endpoint

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Endpoint

Endpoint

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Endpoint

Endpoint

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object