Class: Worker
v1.EndpointTarget.Worker
Target a worker polling on a Nexus task queue in a specific namespace.
Implements
Constructors
constructor
• new Worker(properties?): Worker
Constructs a new Worker.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorker | Properties to set |
Returns
Properties
namespace
• namespace: string
Namespace to route requests to.
Implementation of
taskQueue
• taskQueue: string
Nexus task queue to route requests to.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Worker to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Worker
Creates a new Worker instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorker | Properties to set |
Returns
Worker instance
decode
▸ decode(reader, length?): Worker
Decodes a Worker message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Worker
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Worker
Decodes a Worker message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Worker
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 Worker message. Does not implicitly temporal.api.nexus.v1.EndpointTarget.Worker.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorker | Worker message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Worker message, length delimited. Does not implicitly temporal.api.nexus.v1.EndpointTarget.Worker.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorker | Worker message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Worker
Creates a Worker message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Worker
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Worker
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Worker message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Worker | Worker |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object