#google-cloud #google #cli #command-line-interface #google-api #json-input #cloudprivatecatalogp

app google-cloudprivatecatalogproducer1_beta1-cli

一个完整的库,用于与Cloud PrivateCatalog Producer(协议v1beta1)交互

9个稳定版本 (3个主要版本)

5.0.4+20200405 2024年3月5日
3.1.0+20200405 2022年4月26日
2.0.4+20200405 2021年4月15日
1.0.14+20200405 2020年7月10日
1.0.10+20190622 2019年7月6日

#2926 in Web编程

Download history 20/week @ 2024-03-08 2/week @ 2024-03-15 67/week @ 2024-03-29 14/week @ 2024-04-05

每月167次下载

MIT 许可证

670KB
9K SLoC

cloudprivatecatalogproducer1-beta1 命令行界面(CLI)允许您从终端舒适地使用Google Cloud PrivateCatalog Producer服务的多数功能。

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

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

有关Cloud PrivateCatalog Producer API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-cloudprivatecatalogproducer1_beta1-cli

GitHub上找到源代码

用法

本文档是从版本20200405的Cloud PrivateCatalog Producer API生成的。CLI的版本是5.0.4

cloudprivatecatalogproducer1-beta1 [options]
        catalogs
                associations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                associations-delete <name> [-p <v>]... [-o <out>]
                associations-get <name> [-p <v>]... [-o <out>]
                associations-list <parent> [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-iam-policy <resource> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                products-copy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                products-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                products-delete <name> [-p <v>]... [-o <out>]
                products-get <name> [-p <v>]... [-o <out>]
                products-icons-upload <product> (-r <kv>)... [-p <v>]... [-o <out>]
                products-list <parent> [-p <v>]... [-o <out>]
                products-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                products-versions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                products-versions-delete <name> [-p <v>]... [-o <out>]
                products-versions-get <name> [-p <v>]... [-o <out>]
                products-versions-list <parent> [-p <v>]... [-o <out>]
                products-versions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                undelete <name> (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
  cloudprivatecatalogproducer1-beta1 --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文件中,文件名以cloudprivatecatalogproducer1-beta1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,用户会被要求授权。按照 CLI 提供的说明进行授权或拒绝。

如果用户验证了范围,相应的信息将被存储在配置目录中的 JSON 文件中,例如 ~/.google-service-cli/cloudprivatecatalogproducer1-beta1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~583K SLoC