mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
remove changes to gen
This commit is contained in:
OMGeeky
168
gen/cloudchannel1-cli/README.md
Normal file
168
gen/cloudchannel1-cli/README.md
Normal file
@@ -0,0 +1,168 @@
|
||||
<!---
|
||||
DO NOT EDIT !
|
||||
This file was generated automatically from 'src/generator/templates/cli/README.md.mako'
|
||||
DO NOT EDIT !
|
||||
-->
|
||||
The `cloudchannel1` command-line interface *(CLI)* allows to use most features of the *Google Cloudchannel* service from the comfort of your terminal.
|
||||
|
||||
By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's
|
||||
capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero.
|
||||
|
||||
If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.
|
||||
|
||||
Everything else about the *Cloudchannel* API can be found at the
|
||||
[official documentation site](https://cloud.google.com/channel).
|
||||
|
||||
# Installation and Source Code
|
||||
|
||||
Install the command-line interface with cargo using:
|
||||
|
||||
```bash
|
||||
cargo install google-cloudchannel1-cli
|
||||
```
|
||||
|
||||
Find the source code [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/cloudchannel1-cli).
|
||||
|
||||
# Usage
|
||||
|
||||
This documentation was generated from the *Cloudchannel* API at revision *20240303*. The CLI is at version *5.0.4*.
|
||||
|
||||
```bash
|
||||
cloudchannel1 [options]
|
||||
accounts
|
||||
channel-partner-links-channel-partner-repricing-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
channel-partner-links-channel-partner-repricing-configs-delete <name> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-channel-partner-repricing-configs-get <name> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-channel-partner-repricing-configs-list <parent> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-channel-partner-repricing-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
channel-partner-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
channel-partner-links-customers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
channel-partner-links-customers-delete <name> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-customers-get <name> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-customers-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
channel-partner-links-customers-list <parent> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-customers-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
channel-partner-links-get <name> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-list <parent> [-p <v>]... [-o <out>]
|
||||
channel-partner-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
check-cloud-identity-accounts-exist <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-customer-repricing-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-customer-repricing-configs-delete <name> [-p <v>]... [-o <out>]
|
||||
customers-customer-repricing-configs-get <name> [-p <v>]... [-o <out>]
|
||||
customers-customer-repricing-configs-list <parent> [-p <v>]... [-o <out>]
|
||||
customers-customer-repricing-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-delete <name> [-p <v>]... [-o <out>]
|
||||
customers-entitlements-activate <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-change-offer <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-change-parameters <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-change-renewal-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-get <name> [-p <v>]... [-o <out>]
|
||||
customers-entitlements-list <parent> [-p <v>]... [-o <out>]
|
||||
customers-entitlements-list-entitlement-changes <parent> [-p <v>]... [-o <out>]
|
||||
customers-entitlements-lookup-offer <entitlement> [-p <v>]... [-o <out>]
|
||||
customers-entitlements-start-paid-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-entitlements-suspend <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-get <name> [-p <v>]... [-o <out>]
|
||||
customers-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-list <parent> [-p <v>]... [-o <out>]
|
||||
customers-list-purchasable-offers <customer> [-p <v>]... [-o <out>]
|
||||
customers-list-purchasable-skus <customer> [-p <v>]... [-o <out>]
|
||||
customers-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-provision-cloud-identity <customer> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-query-eligible-billing-accounts <customer> [-p <v>]... [-o <out>]
|
||||
customers-transfer-entitlements <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
customers-transfer-entitlements-to-google <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
list-subscribers <account> [-p <v>]... [-o <out>]
|
||||
list-transferable-offers <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
list-transferable-skus <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
offers-list <parent> [-p <v>]... [-o <out>]
|
||||
register <account> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
report-jobs-fetch-report-results <report-job> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
reports-list <parent> [-p <v>]... [-o <out>]
|
||||
reports-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
||||
sku-groups-billable-skus-list <parent> [-p <v>]... [-o <out>]
|
||||
sku-groups-list <parent> [-p <v>]... [-o <out>]
|
||||
unregister <account> (-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 <name> [-p <v>]... [-o <out>]
|
||||
products
|
||||
list [-p <v>]... [-o <out>]
|
||||
skus-list <parent> [-p <v>]... [-o <out>]
|
||||
cloudchannel1 --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]
|
||||
|
||||
```
|
||||
|
||||
# Configuration
|
||||
|
||||
The program will store all persistent data in the `~/.google-service-cli` directory in *JSON* files prefixed with `cloudchannel1-`. You can change the directory used to store configuration with the `--config-dir` flag on a per-invocation basis.
|
||||
|
||||
More information about the various kinds of persistent data are given in the following paragraphs.
|
||||
|
||||
# Authentication
|
||||
|
||||
Most APIs require a user to authenticate any request. If this is the case, the [scope][scopes] determines the
|
||||
set of permissions granted. The granularity of these is usually no more than *read-only* or *full-access*.
|
||||
|
||||
If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a
|
||||
method that is read-only, it will ask only for a read-only scope.
|
||||
You may use the `--scope` flag to specify a scope directly.
|
||||
All applicable scopes are documented in the respective method's CLI documentation.
|
||||
|
||||
The first time a scope is used, the user is asked for permission. Follow the instructions given
|
||||
by the CLI to grant permissions, or to decline.
|
||||
|
||||
If a scope was authenticated by the user, the respective information will be stored as *JSON* in the configuration
|
||||
directory, e.g. `~/.google-service-cli/cloudchannel1-token-<scope-hash>.json`. No manual management of these tokens
|
||||
is necessary.
|
||||
|
||||
To revoke granted authentication, please refer to the [official documentation][revoke-access].
|
||||
|
||||
# Application Secrets
|
||||
|
||||
In order to allow any application to use Google services, it will need to be registered using the
|
||||
[Google Developer Console][google-dev-console]. APIs the application may use are then enabled for it
|
||||
one by one. Most APIs can be used for free and have a daily quota.
|
||||
|
||||
To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI
|
||||
comes with a default application secret that is configured accordingly. This also means that heavy usage
|
||||
all around the world may deplete the daily quota.
|
||||
|
||||
You can workaround this limitation by putting your own secrets file at this location:
|
||||
`~/.google-service-cli/cloudchannel1-secret.json`, assuming that the required *cloudchannel* API
|
||||
was enabled for it. Such a secret file can be downloaded in the *Google Developer Console* at
|
||||
*APIs & auth -> Credentials -> Download JSON* and used as is.
|
||||
|
||||
Learn more about how to setup Google projects and enable APIs using the [official documentation][google-project-new].
|
||||
|
||||
|
||||
# Debugging
|
||||
|
||||
Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know
|
||||
what exactly led to a particular issue. This is done by allowing all client-server communication to be
|
||||
output to standard error *as-is*.
|
||||
|
||||
The `--debug` flag will print errors using the `Debug` representation to standard error.
|
||||
|
||||
You may consider redirecting standard error into a file for ease of use, e.g. `cloudchannel1 --debug <resource> <method> [options] 2>debug.txt`.
|
||||
|
||||
|
||||
[scopes]: https://developers.google.com/+/api/oauth#scopes
|
||||
[revoke-access]: http://webapps.stackexchange.com/a/30849
|
||||
[google-dev-console]: https://console.developers.google.com/
|
||||
[google-project-new]: https://developers.google.com/console/help/new/
|
||||
Reference in New Issue
Block a user