Class: WorkerCommandResult
The result of executing a WorkerCommand.
Implements
Constructors
constructor
• new WorkerCommandResult(properties?): WorkerCommandResult
Constructs a new WorkerCommandResult.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerCommandResult | Properties to set |
Returns
Properties
cancelActivity
• Optional cancelActivity: null | ICancelActivityResult
WorkerCommandResult cancelActivity.
Implementation of
IWorkerCommandResult.cancelActivity
type
• Optional type: "cancelActivity"
WorkerCommandResult type.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerCommandResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerCommandResult
Creates a new WorkerCommandResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerCommandResult | Properties to set |
Returns
WorkerCommandResult instance
decode
▸ decode(reader, length?): WorkerCommandResult
Decodes a WorkerCommandResult 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
WorkerCommandResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerCommandResult
Decodes a WorkerCommandResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerCommandResult
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 WorkerCommandResult message. Does not implicitly temporal.api.worker.v1.WorkerCommandResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerCommandResult | WorkerCommandResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerCommandResult message, length delimited. Does not implicitly temporal.api.worker.v1.WorkerCommandResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkerCommandResult | WorkerCommandResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerCommandResult
Creates a WorkerCommandResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerCommandResult
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkerCommandResult
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 WorkerCommandResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerCommandResult | WorkerCommandResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object