How do I run the workflow commands from the shell?
Table of Contents
This file documents declared operations at the shell, one section per command. Every command is a subcommand of workflow, and every section exports its own script into projects/ores.shell/scripts/library/. Loading a script runs that one command, so a failure names the command it came from.
1. Commands
1.1. step-result
Sends get_step_result_request and prints get_step_result_response, so the shape is the protocol's and the meaning is the service's. It reads step_id, tenant_id, in that order. The caller must have established a session first.
The command is shaped like this:
workflow step-result <step_id> <tenant_id>
It is addressed at workflow.v1.ops.get_step_result.
workflow step-result __none__ __none__
1.2. instances
Sends list_workflow_instance_summaries_request and prints list_workflow_instance_summaries_response, so the shape is the protocol's and the meaning is the service's. The caller must have established a session first.
The command is shaped like this:
workflow instances [--limit <v>] [--status_filter <v>] [--type_filter <v>] [--target_kind_filter <v>] [--target_id_filter <v>] [--target_ids_filter <v>]
It is addressed at workflow.v1.instances.list.
workflow instances
1.3. steps
Sends get_workflow_steps_request and prints get_workflow_steps_response, so the shape is the protocol's and the meaning is the service's. It reads workflow_instance_id, in that order. The caller must have established a session first.
The command is shaped like this:
workflow steps <workflow_instance_id>
It is addressed at workflow.v1.ops.get_workflow_steps.
workflow steps __none__
1.4. definitions
Sends list_workflow_definitions_request and prints list_workflow_definitions_response, so the shape is the protocol's and the meaning is the service's. The caller must have established a session first.
The command is shaped like this:
workflow definitions
It is addressed at workflow.v1.definitions.list.
workflow definitions
1.5. retry
Sends retry_workflow_instance_request and prints retry_workflow_instance_response, so the shape is the protocol's and the meaning is the service's. It reads workflow_instance_id, in that order. The caller must have established a session first.
The command is shaped like this:
workflow retry <workflow_instance_id> [--step_name <v>]
It is addressed at workflow.v1.ops.retry_workflow_instance.
workflow retry __none__