OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_datastream1_cli/projects_locations-streams-patch/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

530 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Locations Streams Patch - Datastream v3.0.0+20220207</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> Datastream v3.0.0+20220207</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-create">Locations Connection Profiles Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-delete">Locations Connection Profiles Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-discover">Locations Connection Profiles Discover</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-get">Locations Connection Profiles Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-list">Locations Connection Profiles List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-patch">Locations Connection Profiles Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-fetch-static-ips">Locations Fetch Static Ips</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-delete">Locations Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-create">Locations Private Connections Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-delete">Locations Private Connections Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-get">Locations Private Connections Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-list">Locations Private Connections List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-create">Locations Private Connections Routes Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-delete">Locations Private Connections Routes Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-get">Locations Private Connections Routes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-list">Locations Private Connections Routes List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-create">Locations Streams Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-delete">Locations Streams Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-get">Locations Streams Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-list">Locations Streams List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-get">Locations Streams Objects Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-list">Locations Streams Objects List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-lookup">Locations Streams Objects Lookup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-start-backfill-job">Locations Streams Objects Start Backfill Job</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-stop-backfill-job">Locations Streams Objects Stop Backfill Job</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Streams Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Locations Streams Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastream1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Use this method to update the configuration of a stream.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>datastream1 --scope &lt;scope&gt; projects locations-streams-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Output only. The stream&#39;s name.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>Stream:
create-time: string
customer-managed-encryption-key: string
destination-config:
destination-connection-profile: string
gcs-destination-config:
file-rotation-interval: string
file-rotation-mb: integer
json-file-format:
compression: string
schema-file-format: string
path: string
display-name: string
labels: { string: string }
name: string
source-config:
source-connection-profile: string
state: string
update-time: string
</code></pre>
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . create-time=consetetur</code><ul>
<li>Output only. The creation time of the stream.</li>
</ul>
</li>
<li><code>customer-managed-encryption-key=consetetur</code><ul>
<li>Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.</li>
</ul>
</li>
<li><code>destination-config destination-connection-profile=stet</code><ul>
<li>Required. Destination connection profile resource. Format: <code>projects/{project}/locations/{location}/connectionProfiles/{name}</code></li>
</ul>
</li>
<li><code>gcs-destination-config file-rotation-interval=est</code><ul>
<li>The maximum duration for which new events are added before a file is closed and a new file is created.</li>
</ul>
</li>
<li><code>file-rotation-mb=19</code><ul>
<li>The maximum file size to be saved in the bucket.</li>
</ul>
</li>
<li><code>json-file-format compression=elitr</code><ul>
<li>Compression of the loaded JSON file.</li>
</ul>
</li>
<li>
<p><code>schema-file-format=duo</code></p>
<ul>
<li>The schema file format along JSON data files.</li>
</ul>
</li>
<li>
<p><code>.. path=diam</code></p>
<ul>
<li>Path inside the Cloud Storage bucket to write data to.</li>
</ul>
</li>
<li>
<p><code>... display-name=est</code></p>
<ul>
<li>Required. Display name.</li>
</ul>
</li>
<li><code>labels=key=sit</code><ul>
<li>Labels.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>name=sed</code><ul>
<li>Output only. The stream&#39;s name.</li>
</ul>
</li>
<li>
<p><code>source-config source-connection-profile=eos</code></p>
<ul>
<li>Required. Source connection profile resoource. Format: <code>projects/{project}/locations/{location}/connectionProfiles/{name}</code></li>
</ul>
</li>
<li>
<p><code>.. state=lorem</code></p>
<ul>
<li>The state of the stream.</li>
</ul>
</li>
<li><code>update-time=ea</code><ul>
<li>Output only. The last update time of the stream.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
<ul>
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p force=boolean</strong></p>
<ul>
<li>Optional. Update the stream without validating it.</li>
</ul>
</li>
<li>
<p><strong>-p request-id=string</strong></p>
<ul>
<li>Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).</li>
</ul>
</li>
<li>
<p><strong>-p update-mask=string</strong></p>
<ul>
<li>Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.</li>
</ul>
</li>
<li>
<p><strong>-p validate-only=boolean</strong></p>
<ul>
<li>Optional. Only validate the stream with the changes, without actually updating it. The default is false.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_locations-streams-objects-stop-backfill-job" class="btn btn-neutral" title="Locations Streams Objects Stop Backfill Job"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_locations-streams-objects-stop-backfill-job" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink