Class: BatchOperationUpdateWorkflowExecutionOptions
batch.v1.BatchOperationUpdateWorkflowExecutionOptions
BatchOperationUpdateWorkflowExecutionOptions sends UpdateWorkflowExecutionOptions requests to batch workflows. Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.
Implements
Constructors
constructor
• new BatchOperationUpdateWorkflowExecutionOptions(properties?): BatchOperationUpdateWorkflowExecutionOptions
Constructs a new BatchOperationUpdateWorkflowExecutionOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationUpdateWorkflowExecutionOptions | Properties to set |
Returns
BatchOperationUpdateWorkflowExecutionOptions
Properties
identity
• identity: string
The identity of the worker/client.
Implementation of
IBatchOperationUpdateWorkflowExecutionOptions.identity
updateMask
• Optional updateMask: null | IFieldMask
Controls which fields from workflow_execution_options will be applied.
To unset a field, set it to null and use the update mask to indicate that it should be mutated.
Implementation of
IBatchOperationUpdateWorkflowExecutionOptions.updateMask
workflowExecutionOptions
• Optional workflowExecutionOptions: null | IWorkflowExecutionOptions
Workflow Execution options. Partial updates are accepted and controlled by update_mask.
Implementation of
IBatchOperationUpdateWorkflowExecutionOptions.workflowExecutionOptions
Methods
toJSON
▸ toJSON(): Object
Converts this BatchOperationUpdateWorkflowExecutionOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BatchOperationUpdateWorkflowExecutionOptions
Creates a new BatchOperationUpdateWorkflowExecutionOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBatchOperationUpdateWorkflowExecutionOptions | Properties to set |
Returns
BatchOperationUpdateWorkflowExecutionOptions
BatchOperationUpdateWorkflowExecutionOptions instance
decode
▸ decode(reader, length?): BatchOperationUpdateWorkflowExecutionOptions
Decodes a BatchOperationUpdateWorkflowExecutionOptions 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
BatchOperationUpdateWorkflowExecutionOptions
BatchOperationUpdateWorkflowExecutionOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BatchOperationUpdateWorkflowExecutionOptions
Decodes a BatchOperationUpdateWorkflowExecutionOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BatchOperationUpdateWorkflowExecutionOptions
BatchOperationUpdateWorkflowExecutionOptions
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 BatchOperationUpdateWorkflowExecutionOptions message. Does not implicitly temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationUpdateWorkflowExecutionOptions | BatchOperationUpdateWorkflowExecutionOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BatchOperationUpdateWorkflowExecutionOptions message, length delimited. Does not implicitly temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBatchOperationUpdateWorkflowExecutionOptions | BatchOperationUpdateWorkflowExecutionOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BatchOperationUpdateWorkflowExecutionOptions
Creates a BatchOperationUpdateWorkflowExecutionOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BatchOperationUpdateWorkflowExecutionOptions
BatchOperationUpdateWorkflowExecutionOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BatchOperationUpdateWorkflowExecutionOptions
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 BatchOperationUpdateWorkflowExecutionOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BatchOperationUpdateWorkflowExecutionOptions | BatchOperationUpdateWorkflowExecutionOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object