mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 04:35:18 +01:00
294 lines
19 KiB
HTML
294 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="A complete library to interact with Datastream (protocol v1)" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-datastream1-cli/" />
|
|
<link rel="shortcut icon" href="img/favicon.ico" />
|
|
<title>Datastream v5.0.4+20240221</title>
|
|
<link rel="stylesheet" href="css/theme.css" />
|
|
<link rel="stylesheet" href="css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Home";
|
|
var mkdocs_page_input_path = "index.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-datastream1-cli/";
|
|
</script>
|
|
|
|
<script src="js/jquery-3.6.0.min.js" defer></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href="." class="icon icon-home"> Datastream v5.0.4+20240221
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href=".">Home</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-connection-profiles-create/">Locations Connection Profiles Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-connection-profiles-delete/">Locations Connection Profiles Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-connection-profiles-discover/">Locations Connection Profiles Discover</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-connection-profiles-get/">Locations Connection Profiles Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-connection-profiles-list/">Locations Connection Profiles List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-connection-profiles-patch/">Locations Connection Profiles Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-fetch-static-ips/">Locations Fetch Static Ips</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-get/">Locations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-list/">Locations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-operations-cancel/">Locations Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-operations-delete/">Locations Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-operations-get/">Locations Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-operations-list/">Locations Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-create/">Locations Private Connections Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-delete/">Locations Private Connections Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-get/">Locations Private Connections Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-list/">Locations Private Connections List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-routes-create/">Locations Private Connections Routes Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-routes-delete/">Locations Private Connections Routes Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-routes-get/">Locations Private Connections Routes Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-private-connections-routes-list/">Locations Private Connections Routes List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-create/">Locations Streams Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-delete/">Locations Streams Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-get/">Locations Streams Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-list/">Locations Streams List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-objects-get/">Locations Streams Objects Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-objects-list/">Locations Streams Objects List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-objects-lookup/">Locations Streams Objects Lookup</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-objects-start-backfill-job/">Locations Streams Objects Start Backfill Job</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-objects-stop-backfill-job/">Locations Streams Objects Stop Backfill Job</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-patch/">Locations Streams Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="projects_locations-streams-run/">Locations Streams Run</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href=".">Datastream v5.0.4+20240221</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="." class="icon icon-home" alt="Docs"></a> »</li>
|
|
<li>Home</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastream1-cli/edit/master/docs/index.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/generator/templates/cli/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
<p>The <code>datastream1</code> command-line interface <em>(CLI)</em> allows to use most features of the <em>Google Datastream</em> service from the comfort of your terminal.</p>
|
|
<p>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.</p>
|
|
<p>If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools.</p>
|
|
<p>Everything else about the <em>Datastream</em> API can be found at the
|
|
<a href="https://cloud.google.com/datastream/">official documentation site</a>.</p>
|
|
<h1 id="installation-and-source-code">Installation and Source Code</h1>
|
|
<p>Install the command-line interface with cargo using:</p>
|
|
<pre><code class="language-bash">cargo install google-datastream1-cli
|
|
</code></pre>
|
|
<p>Find the source code <a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastream1-cli">on github</a>.</p>
|
|
<h1 id="usage">Usage</h1>
|
|
<p>This documentation was generated from the <em>Datastream</em> API at revision <em>20240221</em>. The CLI is at version <em>5.0.4</em>.</p>
|
|
<pre><code class="language-bash">datastream1 [options]
|
|
projects
|
|
locations-connection-profiles-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-connection-profiles-delete <name> [-p <v>]... [-o <out>]
|
|
locations-connection-profiles-discover <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-connection-profiles-get <name> [-p <v>]... [-o <out>]
|
|
locations-connection-profiles-list <parent> [-p <v>]... [-o <out>]
|
|
locations-connection-profiles-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-fetch-static-ips <name> [-p <v>]... [-o <out>]
|
|
locations-get <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-private-connections-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-private-connections-delete <name> [-p <v>]... [-o <out>]
|
|
locations-private-connections-get <name> [-p <v>]... [-o <out>]
|
|
locations-private-connections-list <parent> [-p <v>]... [-o <out>]
|
|
locations-private-connections-routes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-private-connections-routes-delete <name> [-p <v>]... [-o <out>]
|
|
locations-private-connections-routes-get <name> [-p <v>]... [-o <out>]
|
|
locations-private-connections-routes-list <parent> [-p <v>]... [-o <out>]
|
|
locations-streams-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-streams-delete <name> [-p <v>]... [-o <out>]
|
|
locations-streams-get <name> [-p <v>]... [-o <out>]
|
|
locations-streams-list <parent> [-p <v>]... [-o <out>]
|
|
locations-streams-objects-get <name> [-p <v>]... [-o <out>]
|
|
locations-streams-objects-list <parent> [-p <v>]... [-o <out>]
|
|
locations-streams-objects-lookup <parent> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-streams-objects-start-backfill-job <object> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-streams-objects-stop-backfill-job <object> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-streams-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
locations-streams-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
|
|
datastream1 --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]
|
|
|
|
</code></pre>
|
|
<h1 id="configuration">Configuration</h1>
|
|
<p>The program will store all persistent data in the <code>~/.google-service-cli</code> directory in <em>JSON</em> files prefixed with <code>datastream1-</code>. You can change the directory used to store configuration with the <code>--config-dir</code> flag on a per-invocation basis.</p>
|
|
<p>More information about the various kinds of persistent data are given in the following paragraphs.</p>
|
|
<h1 id="authentication">Authentication</h1>
|
|
<p>Most APIs require a user to authenticate any request. If this is the case, the <a href="https://developers.google.com/+/api/oauth#scopes">scope</a> determines the
|
|
set of permissions granted. The granularity of these is usually no more than <em>read-only</em> or <em>full-access</em>.</p>
|
|
<p>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 <code>--scope</code> flag to specify a scope directly.
|
|
All applicable scopes are documented in the respective method's CLI documentation.</p>
|
|
<p>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.</p>
|
|
<p>If a scope was authenticated by the user, the respective information will be stored as <em>JSON</em> in the configuration
|
|
directory, e.g. <code>~/.google-service-cli/datastream1-token-<scope-hash>.json</code>. No manual management of these tokens
|
|
is necessary.</p>
|
|
<p>To revoke granted authentication, please refer to the <a href="http://webapps.stackexchange.com/a/30849">official documentation</a>.</p>
|
|
<h1 id="application-secrets">Application Secrets</h1>
|
|
<p>In order to allow any application to use Google services, it will need to be registered using the
|
|
<a href="https://console.developers.google.com/">Google Developer Console</a>. 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.</p>
|
|
<p>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.</p>
|
|
<p>You can workaround this limitation by putting your own secrets file at this location:
|
|
<code>~/.google-service-cli/datastream1-secret.json</code>, assuming that the required <em>datastream</em> API
|
|
was enabled for it. Such a secret file can be downloaded in the <em>Google Developer Console</em> at
|
|
<em>APIs & auth -> Credentials -> Download JSON</em> and used as is.</p>
|
|
<p>Learn more about how to setup Google projects and enable APIs using the <a href="https://developers.google.com/console/help/new/">official documentation</a>.</p>
|
|
<h1 id="debugging">Debugging</h1>
|
|
<p>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 <em>as-is</em>.</p>
|
|
<p>The <code>--debug</code> flag will print errors using the <code>Debug</code> representation to standard error.</p>
|
|
<p>You may consider redirecting standard error into a file for ease of use, e.g. <code>datastream1 --debug <resource> <method> [options] 2>debug.txt</code>.</p>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="projects_locations-connection-profiles-create/" class="btn btn-neutral float-right" title="Locations Connection Profiles Create">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 2015-2020, `Sebastian Thiel`</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<span>
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastream1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
|
|
<span><a href="projects_locations-connection-profiles-create/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '.';</script>
|
|
<script src="js/theme_extra.js" defer></script>
|
|
<script src="js/theme.js" defer></script>
|
|
<script src="search/main.js" defer></script>
|
|
<script defer>
|
|
window.onload = function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
};
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|
|
|
|
<!--
|
|
MkDocs version : 1.3.1
|
|
Build Date UTC : 2024-03-05 20:04:45.841252+00:00
|
|
-->
|