Skip to main content

Class: Endpoint

A cluster-global binding from an endpoint ID to a target for dispatching incoming Nexus requests.

Properties​

createdTime?​

optional createdTime?: $Properties | null

The date and time when the endpoint was created. (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Not following linter rules. --)

id​

id: string

Unique server-generated endpoint ID.

lastModifiedTime?​

optional lastModifiedTime?: $Properties | null

The date and time when the endpoint was last modified. Will not be set if the endpoint has never been modified. (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Not following linter rules. --)

spec?​

optional spec?: $Properties | null

Spec for the endpoint.

urlPrefix​

urlPrefix: string

Server exposed URL prefix for invocation of operations on this endpoint. This doesn't include the protocol, hostname or port as the server does not know how it should be accessed publicly. The URL is stable in the face of endpoint renames.

version​

version: Long

Data version for this endpoint, incremented for every update issued via the UpdateNexusEndpoint API.

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.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.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​

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