pubsub1-beta2 命令行界面（CLI）允许您在终端中方便地使用Google Pubsub服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接重定向到文件，而无需依赖于您的shell功能。错误将打印到标准错误，并导致程序退出代码不为零。

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

有关Pubsub API的其余信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-pubsub1_beta2-cli

在GitHub上找到源代码。

用法

本文档是根据修订版20240227的Pubsub API生成的。CLI版本为5.0.4。

pubsub1-beta2 [options]
        projects
                subscriptions-acknowledge <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-delete <subscription> [-p <v>]... [-o <out>]
                subscriptions-get <subscription> [-p <v>]... [-o <out>]
                subscriptions-get-iam-policy <resource> [-p <v>]... [-o <out>]
                subscriptions-list <project> [-p <v>]... [-o <out>]
                subscriptions-modify-ack-deadline <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-modify-push-config <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-pull <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-delete <topic> [-p <v>]... [-o <out>]
                topics-get <topic> [-p <v>]... [-o <out>]
                topics-get-iam-policy <resource> [-p <v>]... [-o <out>]
                topics-list <project> [-p <v>]... [-o <out>]
                topics-publish <topic> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-subscriptions-list <topic> [-p <v>]... [-o <out>]
                topics-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  pubsub1-beta2 --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文件中，文件名以pubsub1-beta2-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，系统会要求用户授权。按照CLI给出的说明授权或拒绝授权。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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