#google #cli #命令行界面 #google-api #eventarc

应用程序 google-eventarc1-cli

一个与Eventarc(协议v1)交互的完整库

6个稳定版本

5.0.4+20240223 2024年3月5日
3.1.0+20220301 2022年4月26日
3.0.0+20220301 2022年3月8日
2.0.4+20210325 2021年4月15日

#2567 in Web编程

Download history 25/week @ 2024-03-08 3/week @ 2024-03-15 48/week @ 2024-03-29 11/week @ 2024-04-05

117 每月下载量

MIT 许可证

775KB
10K SLoC

eventarc1命令行界面(CLI)允许您在终端中舒适地使用Google Eventarc服务的多数功能。

默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接重定向到文件,而不考虑shell的能力。错误将打印到标准错误,并将程序的退出代码设置为非零。

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

有关Eventarc API的所有其他信息,请参阅官方文档站点

安装和源代码

使用cargo安装命令行界面:

cargo install google-eventarc1-cli

GitHub上找到源代码。

使用方法

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

eventarc1 [options]
        projects
                locations-channel-connections-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-channel-connections-delete <name> [-p <v>]... [-o <out>]
                locations-channel-connections-get <name> [-p <v>]... [-o <out>]
                locations-channel-connections-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-channel-connections-list <parent> [-p <v>]... [-o <out>]
                locations-channel-connections-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-channel-connections-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-channels-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-channels-delete <name> [-p <v>]... [-o <out>]
                locations-channels-get <name> [-p <v>]... [-o <out>]
                locations-channels-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-channels-list <parent> [-p <v>]... [-o <out>]
                locations-channels-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-channels-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-channels-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-google-channel-config <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-providers-get <name> [-p <v>]... [-o <out>]
                locations-providers-list <parent> [-p <v>]... [-o <out>]
                locations-triggers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-triggers-delete <name> [-p <v>]... [-o <out>]
                locations-triggers-get <name> [-p <v>]... [-o <out>]
                locations-triggers-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-triggers-list <parent> [-p <v>]... [-o <out>]
                locations-triggers-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-triggers-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-triggers-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-update-google-channel-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
  eventarc1 --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文件中,文件名以eventarc1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,系统会要求用户授权。按照CLI提供的说明授权或拒绝权限。

如果用户已对范围进行身份验证,则相应的信息将以JSON格式存储在配置目录中,例如~/.google-service-cli/eventarc1-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销已授予的认证,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以提高使用方便性,例如:eventarc1 --debug <resource> <method> [options] 2>debug.txt

依赖关系

~20–31MB
~581K SLoC