datastream1命令行界面（CLI）允许您在终端舒适地使用Google Datastream服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-datastream1-cli

在GitHub上找到源代码。

用法

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

datastream1 [options]
        projects
                locations-connection-profiles-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connection-profiles-delete <name> [-p <v>]... [-o <out>]
                locations-connection-profiles-discover <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connection-profiles-get <name> [-p <v>]... [-o <out>]
                locations-connection-profiles-list <parent> [-p <v>]... [-o <out>]
                locations-connection-profiles-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-fetch-static-ips <name> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-private-connections-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-private-connections-delete <name> [-p <v>]... [-o <out>]
                locations-private-connections-get <name> [-p <v>]... [-o <out>]
                locations-private-connections-list <parent> [-p <v>]... [-o <out>]
                locations-private-connections-routes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-private-connections-routes-delete <name> [-p <v>]... [-o <out>]
                locations-private-connections-routes-get <name> [-p <v>]... [-o <out>]
                locations-private-connections-routes-list <parent> [-p <v>]... [-o <out>]
                locations-streams-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-streams-delete <name> [-p <v>]... [-o <out>]
                locations-streams-get <name> [-p <v>]... [-o <out>]
                locations-streams-list <parent> [-p <v>]... [-o <out>]
                locations-streams-objects-get <name> [-p <v>]... [-o <out>]
                locations-streams-objects-list <parent> [-p <v>]... [-o <out>]
                locations-streams-objects-lookup <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-streams-objects-start-backfill-job <object> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-streams-objects-stop-backfill-job <object> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-streams-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-streams-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
  datastream1 --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文件中，文件名以datastream1开头。您可以使用--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。根据CLI的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以方便使用，例如：datastream1 --debug <资源> <方法> [选项] 2>debug.txt。