20 个稳定版本 (4 个主要版本)
5.0.4+20160428 | 2024 年 3 月 5 日 |
---|---|
3.1.0+20160428 | 2022 年 4 月 26 日 |
3.0.0+20160428 | 2022 年 3 月 8 日 |
2.0.4+20160428 | 2021 年 4 月 15 日 |
0.3.6+20160428 | 2016 年 9 月 11 日 |
#2250 在 网络编程
每月 426 次下载
235KB
3.5K SLoC
该 taskqueue1-beta2
命令行界面(CLI)允许您在终端中轻松使用 Google 任务队列服务的几乎所有功能。
默认情况下,所有输出都打印到标准输出,但可以使用标志将其定向到与 shell 功能无关的文件。错误将打印到标准错误,并导致程序退出代码不为零。
如果请求数据结构,则这些数据结构将以格式化的 JSON 返回,以便用作其他工具的输入。
有关任务队列 API 的所有其他信息,请参阅官方文档网站。
安装和源代码
使用 cargo 安装命令行界面:
cargo install google-taskqueue1_beta2-cli
在 GitHub 上查找源代码。
用法
本文档是根据修订版 20160428 中的 taskqueue API 生成的。CLI 版本为 5.0.4。
taskqueue1-beta2 [options]
taskqueues
get <project> <taskqueue> [-p <v>]... [-o <out>]
tasks
delete <project> <taskqueue> <task> [-p <v>]...
get <project> <taskqueue> <task> [-p <v>]... [-o <out>]
insert <project> <taskqueue> (-r <kv>)... [-p <v>]... [-o <out>]
lease <project> <taskqueue> <num-tasks> <lease-secs> [-p <v>]... [-o <out>]
list <project> <taskqueue> [-p <v>]... [-o <out>]
patch <project> <taskqueue> <task> <new-lease-seconds> (-r <kv>)... [-p <v>]... [-o <out>]
update <project> <taskqueue> <task> <new-lease-seconds> (-r <kv>)... [-p <v>]... [-o <out>]
taskqueue1-beta2 --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 文件中,这些文件以 taskqueue1-beta2-
为前缀。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落中提供了有关各种持久数据类型的信息。
身份验证
大多数 API 需要用户对任何请求进行身份验证。如果是这种情况,作用域 确定了授予的权限集。这些权限的粒度通常不超过 只读 或 完全访问。
如果未设置,系统将自动选择最小的可行作用域,例如,当调用只读方法时,它只会请求只读作用域。您可以使用 --scope
标志直接指定作用域。所有适用的作用域都在相应方法的 CLI 文档中有说明。
第一次使用作用域时,会要求用户进行授权。根据CLI的指示进行授权或拒绝。
如果用户验证了作用域,相应的信息将以JSON格式存储在配置目录中,例如:~/.google-service-cli/taskqueue1-beta2-token-<scope-hash>.json
。不需要手动管理这些令牌。
要撤销授权,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。然后逐个启用应用程序可能使用的API。大多数API可以免费使用,并且有每日配额。
为了使CLI的使用更加方便,而不必强迫任何人注册自己的应用程序,CLI附带了一个默认的应用程序密钥,已相应配置。这也意味着全球范围内的重度使用可能会耗尽每日配额。
您可以通过在此位置放置自己的密钥文件来解决这个问题:~/.google-service-cli/taskqueue1-beta2-secret.json
,假设已为它启用了所需的taskqueue API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载,并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽最大努力提供可用的错误消息,但有时可能需要知道导致特定问题确切原因。这是通过允许所有客户端-服务器通信直接输出到标准错误来实现的。
使用--debug
标志将错误打印到标准错误,使用Debug
表示法。
您可以考虑将标准错误重定向到文件以便于使用,例如:taskqueue1-beta2 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~19–32MB
~583K SLoC