6个稳定版本

5.0.4+20240202 2024年3月5日
3.1.0+20220211 2022年4月26日
3.0.0+20220211 2022年3月8日
2.0.4+20210309 2021年4月15日

#6 in #jobs

Download history

每月下载量 109

MIT 许可证

655KB
8K SLoC

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

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-jobs4-cli

github 上找到源代码。

用法

此文档是从 Cloud Talent Solution API 版本 20240202 生成的。CLI 版本为 5.0.4

jobs4 [options]
        projects
                operations-get <name> [-p <v>]... [-o <out>]
                tenants-client-events-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-companies-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-companies-delete <name> [-p <v>]... [-o <out>]
                tenants-companies-get <name> [-p <v>]... [-o <out>]
                tenants-companies-list <parent> [-p <v>]... [-o <out>]
                tenants-companies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-complete-query <tenant> [-p <v>]... [-o <out>]
                tenants-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-delete <name> [-p <v>]... [-o <out>]
                tenants-get <name> [-p <v>]... [-o <out>]
                tenants-jobs-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-jobs-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-jobs-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-jobs-delete <name> [-p <v>]... [-o <out>]
                tenants-jobs-get <name> [-p <v>]... [-o <out>]
                tenants-jobs-list <parent> [-p <v>]... [-o <out>]
                tenants-jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-jobs-search <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-jobs-search-for-alert <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                tenants-list <parent> [-p <v>]... [-o <out>]
                tenants-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  jobs4 --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 目录中存储所有持久数据,以 jobs4- 前缀的 JSON 文件。您可以使用 --config-dir 标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,用户会被要求授权。根据 CLI 的说明授权权限,或拒绝。

如果用户验证了作用域,则相应信息将作为JSON存储在配置目录中,例如~/.google-service-cli/jobs4-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销授权的验证,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~580K SLoC