Skip to main content

Class: Endpoint

nexus.v1.Endpoint

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

Implements

Constructors

constructor

new Endpoint(properties?): Endpoint

Constructs a new Endpoint.

Parameters

NameTypeDescription
properties?IEndpointProperties to set

Returns

Endpoint

Properties

createdTime

Optional createdTime: null | ITimestamp

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

Implementation of

IEndpoint.createdTime


id

id: string

Unique server-generated endpoint ID.

Implementation of

IEndpoint.id


lastModifiedTime

Optional lastModifiedTime: null | ITimestamp

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

Implementation of

IEndpoint.lastModifiedTime


spec

Optional spec: null | IEndpointSpec

Spec for the endpoint.

Implementation of

IEndpoint.spec


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.

Implementation of

IEndpoint.urlPrefix


version

version: Long

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

Implementation of

IEndpoint.version

Methods

toJSON

toJSON(): Object

Converts this Endpoint to JSON.

Returns

Object

JSON object


create

create(properties?): Endpoint

Creates a new Endpoint instance using the specified properties.

Parameters

NameTypeDescription
properties?IEndpointProperties to set

Returns

Endpoint

Endpoint instance


decode

decode(reader, length?): Endpoint

Decodes an Endpoint message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Endpoint

Endpoint

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Endpoint

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Endpoint

Endpoint

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIEndpointEndpoint message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIEndpointEndpoint message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): Endpoint

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Endpoint

Endpoint


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Endpoint

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageEndpointEndpoint
options?IConversionOptionsConversion options

Returns

Object

Plain object