该 workflowexecutions1 命令行界面（CLI）允许您从终端舒适地使用Google工作流程执行服务的大多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过标志将其定向到文件，而不依赖于shell的能力。错误将打印到标准错误，并使程序退出代码非零。

如果请求数据结构，则这些结构将作为格式化的JSON返回，以便作为其他工具的输入。

有关工作流程执行API的其他所有信息，请参阅官方文档站点。

安装和源代码

使用cargo通过以下命令安装命令行界面

cargo install google-workflowexecutions1-cli

在GitHub上找到源代码。

用法

本文档是根据工作流程执行 API的20240220修订版本生成的。CLI的版本为5.0.4。

workflowexecutions1 [options]
        projects
                locations-workflows-executions-callbacks-list <parent> [-p <v>]... [-o <out>]
                locations-workflows-executions-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workflows-executions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workflows-executions-export-data <name> [-p <v>]... [-o <out>]
                locations-workflows-executions-get <name> [-p <v>]... [-o <out>]
                locations-workflows-executions-list <parent> [-p <v>]... [-o <out>]
                locations-workflows-executions-step-entries-get <name> [-p <v>]... [-o <out>]
                locations-workflows-executions-step-entries-list <parent> [-p <v>]... [-o <out>]
                locations-workflows-trigger-pubsub-execution <workflow> (-r <kv>)... [-p <v>]... [-o <out>]
  workflowexecutions1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将把所有持久数据存储在~/.google-service-cli目录中的JSON文件中，这些文件以前缀workflowexecutions1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数API要求用户对任何请求进行身份验证。如果是这种情况，作用域确定授予的权限集合。这些的粒度通常不超过只读或完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如在调用只读方法时，它只会请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围在各自方法的 CLI 文档中有记录。

第一次使用范围时，用户将被要求授予权限。根据 CLI 的指示授予权限或拒绝。

如果用户验证了范围，相关信息将被存储在配置目录中，例如 ~/.google-service-cli/workflowexecutions1-token-<scope-hash>.json 作为 JSON。无需手动管理这些令牌。

要撤销授予的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用 Google 服务，它需要使用Google 开发者控制台进行注册。然后依次启用应用程序可能使用的 API。大多数 API 可以免费使用，并且有每日配额。

为了在不强迫任何人注册自己的应用程序的情况下更舒适地使用 CLI，CLI 随附一个默认应用程序密钥，已相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/workflowexecutions1-secret.json，假设已为它启用了所需的 workflowexecutions API。这样的密钥文件可以从 Google 开发者控制台 在 APIs & auth -> Credentials -> Download JSON 下载并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息，请参阅官方文档。

调试

尽管 CLI 尽力提供可用的错误消息，但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以标准错误的形式输出。

使用 --debug 标志将错误打印到标准错误，使用 Debug 表示形式。

您可以考虑将标准错误重定向到文件以方便使用，例如 workflowexecutions1 --debug <resource> <method> [options] 2>debug.txt。