Skip to main content

Class: EndpointTarget

nexus.v1.EndpointTarget

Target to route requests to.

Implements

Constructors

constructor

new EndpointTarget(properties?): EndpointTarget

Constructs a new EndpointTarget.

Parameters

NameTypeDescription
properties?IEndpointTargetProperties to set

Returns

EndpointTarget

Properties

external

Optional external: null | IExternal

EndpointTarget external.

Implementation of

IEndpointTarget.external


variant

Optional variant: "worker" | "external"

EndpointTarget variant.


worker

Optional worker: null | IWorker

EndpointTarget worker.

Implementation of

IEndpointTarget.worker

Methods

toJSON

toJSON(): Object

Converts this EndpointTarget to JSON.

Returns

Object

JSON object


create

create(properties?): EndpointTarget

Creates a new EndpointTarget instance using the specified properties.

Parameters

NameTypeDescription
properties?IEndpointTargetProperties to set

Returns

EndpointTarget

EndpointTarget instance


decode

decode(reader, length?): EndpointTarget

Decodes an EndpointTarget message from the specified reader or buffer.

Parameters

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

Returns

EndpointTarget

EndpointTarget

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): EndpointTarget

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

EndpointTarget

EndpointTarget

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): EndpointTarget

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

EndpointTarget

EndpointTarget


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for EndpointTarget

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 EndpointTarget message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageEndpointTargetEndpointTarget
options?IConversionOptionsConversion options

Returns

Object

Plain object