Class: BatchOperationSignal
BatchOperationSignal sends signals to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.
Properties
header
• Optional header: null | $Properties
Headers that are passed with the signal to the processing workflow. These can include things like auth or tracing tokens.
identity
• identity: string
The identity of the worker/client
input
• Optional input: null | $Properties
Serialized value(s) to provide with the signal
signal
• signal: string
The workflow author-defined name of the signal to send to the workflow
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationSignal to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationSignal & $Properties
Creates a new BatchOperationSignal instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
BatchOperationSignal & $Properties
BatchOperationSignal instance
▸ create(properties?): BatchOperationSignal
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): BatchOperationSignal & $Properties
Decodes a BatchOperationSignal 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
BatchOperationSignal & $Properties
BatchOperationSignal
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationSignal & $Properties
Decodes a BatchOperationSignal message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationSignal & $Properties
BatchOperationSignal
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 BatchOperationSignal message. Does not implicitly temporal.api.batch.v1.BatchOperationSignal.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationSignal message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationSignal message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationSignal.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | BatchOperationSignal message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationSignal
Creates a BatchOperationSignal message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationSignal
toObject
▸ toObject(message, options?): Object
Creates a plain object from a BatchOperationSignal message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationSignal | BatchOperationSignal |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object