package temporal.api.batch.v1
Get desktop application:
View/edit binary Protocol Buffers messages
message
message.proto:60BatchOperationCancellation sends cancel requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest. Ignore first_execution_run_id because this is used for single workflow operation.
Used in:
string identity = 1
The identity of the worker/client
message
message.proto:67BatchOperationDeletion sends deletion requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.DeleteWorkflowExecutionRequest.
Used in:
string identity = 1
The identity of the worker/client
message
message.proto:22Used in:
string job_id = 1
Batch job ID
enums.v1.BatchOperationState state = 2
Batch operation state
optional start_time = 3
Batch operation start time
optional close_time = 4
Batch operation close time
message
message.proto:74BatchOperationReset sends reset requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest.
Used in:
string identity = 3
The identity of the worker/client.
optional options = 4
Describes what to reset to and how. If set, `reset_type` and `reset_reapply_type` are ignored.
enums.v1.ResetType reset_type = 1
Deprecated. Use `options`.
enums.v1.ResetReapplyType reset_reapply_type = 2
Deprecated. Use `options`.
repeated post_reset_operations = 5
Operations to perform after the workflow has been reset. These operations will be applied to the *new* run of the workflow execution in the order they are provided. All operations are applied to the workflow before the first new workflow task is generated
message
message.proto:142BatchOperationResetActivities sends activity reset requests in a batch. NOTE: keep in sync with temporal.api.workflowservice.v1.ResetActivityRequest
Used in:
string identity = 1
The identity of the worker/client.
oneof activity
The activities to reset. If match_all is set to true, all activities will be reset.
string type = 2
bool match_all = 3
bool reset_attempts = 4
Setting this flag will also reset the number of attempts.
bool reset_heartbeat = 5
Setting this flag will also reset the heartbeat details.
bool keep_paused = 6
If activity is paused, it will remain paused after reset
optional jitter = 7
If set, the activity will start at a random time within the specified jitter duration, introducing variability to the start time.
bool restore_original_options = 8
If set, the activity options will be restored to the defaults. Default options are then options activity was created with. They are part of the first ActivityTaskScheduled event.
message
message.proto:45BatchOperationSignal sends signals to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.
Used in:
string signal = 1
The workflow author-defined name of the signal to send to the workflow
optional input = 2
Serialized value(s) to provide with the signal
optional header = 3
Headers that are passed with the signal to the processing workflow. These can include things like auth or tracing tokens.
string identity = 4
The identity of the worker/client
message
message.proto:36BatchOperationTermination sends terminate requests to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.TerminateWorkflowExecutionRequest. Ignore first_execution_run_id because this is used for single workflow operation.
Used in:
optional details = 1
Serialized value(s) to provide to the termination event
string identity = 2
The identity of the worker/client
message
message.proto:128BatchOperationTriggerWorkflowRule sends TriggerWorkflowRule requests to batch workflows.
string identity = 1
The identity of the worker/client.
oneof rule
string id = 2
ID of existing rule.
spec = 3
Rule specification to be applied to the workflow without creating a new rule.
message
message.proto:106BatchOperationUnpauseActivities sends unpause requests to batch workflows.
Used in:
string identity = 1
The identity of the worker/client.
oneof activity
The activity to unpause. If match_all is set to true, all activities will be unpaused.
string type = 2
bool match_all = 3
bool reset_attempts = 4
Setting this flag will also reset the number of attempts.
bool reset_heartbeat = 5
Setting this flag will also reset the heartbeat details.
optional jitter = 6
If set, the activity will start at a random time within the specified jitter duration, introducing variability to the start time.
message
message.proto:173BatchOperationUpdateActivityOptions sends an update-activity-options requests in a batch. NOTE: keep in sync with temporal.api.workflowservice.v1.UpdateActivityRequest
Used in:
string identity = 1
The identity of the worker/client.
oneof activity
The activity to update. If match_all is set to true, all activities will be updated.
string type = 2
bool match_all = 3
optional activity_options = 4
Update Activity options. Partial updates are accepted and controlled by update_mask.
optional update_mask = 5
Controls which fields from `activity_options` will be applied
bool restore_original = 6
If set, the activity options will be restored to the default. Default options are then options activity was created with. They are part of the first ActivityTaskScheduled event. This flag cannot be combined with any other option; if you supply restore_original together with other options, the request will be rejected.
message
message.proto:93BatchOperationUpdateWorkflowExecutionOptions sends UpdateWorkflowExecutionOptions requests to batch workflows. Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.
Used in:
string identity = 1
The identity of the worker/client.
optional workflow_execution_options = 2
Update Workflow options that were originally specified via StartWorkflowExecution. Partial updates are accepted and controlled by update_mask.
optional update_mask = 3
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.