Skip to main content

Class: WorkerTargetSpec

nexus.v1.WorkerTargetSpec

Represents a WorkerTargetSpec.

Properties

namespaceId

namespaceId: string

The target cloud namespace to route requests to. Namespace must be in same account as the endpoint. This field is mutable.


taskQueue

taskQueue: string

The task queue on the cloud namespace to route requests to. This field is mutable.

Methods

toJSON

toJSON(): Object

Converts this WorkerTargetSpec to JSON.

Returns

Object

JSON object


create

create(properties?): WorkerTargetSpec & $Properties

Creates a new WorkerTargetSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

WorkerTargetSpec & $Properties

WorkerTargetSpec instance

create(properties?): WorkerTargetSpec

Parameters

NameType
properties?$Properties

Returns

WorkerTargetSpec


decode

decode(reader, length?): WorkerTargetSpec & $Properties

Decodes a WorkerTargetSpec message from the specified reader or buffer.

Parameters

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

Returns

WorkerTargetSpec & $Properties

WorkerTargetSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkerTargetSpec & $Properties

Decodes a WorkerTargetSpec message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkerTargetSpec & $Properties

WorkerTargetSpec

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

Parameters

NameTypeDescription
message$PropertiesWorkerTargetSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesWorkerTargetSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): WorkerTargetSpec

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkerTargetSpec

WorkerTargetSpec


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageWorkerTargetSpecWorkerTargetSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object