Skip to main content

Class: EndpointTarget

nexus.v1.EndpointTarget

Target to route requests to.

Properties​

external​

• Optional external: null | $Properties

EndpointTarget external.


variant​

• Optional variant: "worker" | "external"

EndpointTarget variant.


worker​

• Optional worker: null | $Properties

EndpointTarget worker.

Methods​

toJSON​

▸ toJSON(): Object

Converts this EndpointTarget to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): EndpointTarget & $Shape

Creates a new EndpointTarget instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

EndpointTarget & $Shape

EndpointTarget instance

▸ create(properties?): EndpointTarget

Parameters​

NameType
properties?$Properties

Returns​

EndpointTarget


decode​

▸ decode(reader, length?): EndpointTarget & $Shape

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 & $Shape

EndpointTarget

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): EndpointTarget & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

EndpointTarget & $Shape

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
message$PropertiesEndpointTarget 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
message$PropertiesEndpointTarget 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


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