pubsublite1 命令行界面 (CLI) 允许您从终端舒适地使用 Google PubsubLite 服务的几乎所有功能。

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

如果请求数据结构，则这些数据结构将以美观打印的 JSON 返回，作为其他工具的输入非常有用。

有关 PubsubLite API 的其他所有信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-pubsublite1-cli

在 GitHub 上查找源代码。

用法

本文档是根据 PubsubLite API 在 20240224 版本中生成的。CLI 版本为 5.0.4。

pubsublite1 [options]
        admin
                projects-locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-operations-delete <name> [-p <v>]... [-o <out>]
                projects-locations-operations-get <name> [-p <v>]... [-o <out>]
                projects-locations-operations-list <name> [-p <v>]... [-o <out>]
                projects-locations-reservations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-reservations-delete <name> [-p <v>]... [-o <out>]
                projects-locations-reservations-get <name> [-p <v>]... [-o <out>]
                projects-locations-reservations-list <parent> [-p <v>]... [-o <out>]
                projects-locations-reservations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-reservations-topics-list <name> [-p <v>]... [-o <out>]
                projects-locations-subscriptions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-subscriptions-delete <name> [-p <v>]... [-o <out>]
                projects-locations-subscriptions-get <name> [-p <v>]... [-o <out>]
                projects-locations-subscriptions-list <parent> [-p <v>]... [-o <out>]
                projects-locations-subscriptions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-subscriptions-seek <name> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-topics-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-topics-delete <name> [-p <v>]... [-o <out>]
                projects-locations-topics-get <name> [-p <v>]... [-o <out>]
                projects-locations-topics-get-partitions <name> [-p <v>]... [-o <out>]
                projects-locations-topics-list <parent> [-p <v>]... [-o <out>]
                projects-locations-topics-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-topics-subscriptions-list <name> [-p <v>]... [-o <out>]
        cursor
                projects-locations-subscriptions-commit-cursor <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-subscriptions-cursors-list <parent> [-p <v>]... [-o <out>]
        topic-stats
                projects-locations-topics-compute-head-cursor <topic> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-topics-compute-message-stats <topic> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-locations-topics-compute-time-cursor <topic> (-r <kv>)... [-p <v>]... [-o <out>]
  pubsublite1 --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 文件中，文件名以 pubsublite1- 开头。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，会要求用户授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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