mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
370 lines
18 KiB
HTML
370 lines
18 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" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-eventarc1-cli/projects_locations-channels-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Channels Patch - Eventarc v5.0.4+20240223</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 = "Locations Channels Patch";
|
|
var mkdocs_page_input_path = "projects_locations-channels-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-eventarc1-cli/projects_locations-channels-patch/";
|
|
</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"> Eventarc v5.0.4+20240223
|
|
</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>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-create/">Locations Channel Connections Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-delete/">Locations Channel Connections Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-get/">Locations Channel Connections Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-get-iam-policy/">Locations Channel Connections Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-list/">Locations Channel Connections List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-set-iam-policy/">Locations Channel Connections Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channel-connections-test-iam-permissions/">Locations Channel Connections Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-create/">Locations Channels Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-delete/">Locations Channels Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-get/">Locations Channels Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-get-iam-policy/">Locations Channels Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-list/">Locations Channels List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Channels Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-set-iam-policy/">Locations Channels Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-channels-test-iam-permissions/">Locations Channels Test Iam Permissions</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-get-google-channel-config/">Locations Get Google Channel Config</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-providers-get/">Locations Providers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-list/">Locations Providers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-create/">Locations Triggers Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-delete/">Locations Triggers Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-get/">Locations Triggers Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-get-iam-policy/">Locations Triggers Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-list/">Locations Triggers List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-patch/">Locations Triggers Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-set-iam-policy/">Locations Triggers Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-triggers-test-iam-permissions/">Locations Triggers Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-update-google-channel-config/">Locations Update Google Channel Config</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="..">Eventarc v5.0.4+20240223</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>Projects »</li>
|
|
<li>Locations Channels Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/eventarc1-cli/edit/master/docs/projects_locations-channels-patch.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">
|
|
|
|
<p>Update a single channel.</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>eventarc1 --scope <scope> projects locations-channels-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>Required. The resource name of the channel. Must be unique within the location on the project and must be in <code>projects/{project}/locations/{location}/channels/{channel_id}</code> format.</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>Channel:
|
|
activation-token: string
|
|
create-time: string
|
|
crypto-key-name: string
|
|
name: string
|
|
provider: string
|
|
pubsub-topic: string
|
|
state: string
|
|
uid: 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 . activation-token=ipsum</code><ul>
|
|
<li>Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>create-time=invidunt</code><ul>
|
|
<li>Output only. The creation time.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>crypto-key-name=amet</code><ul>
|
|
<li>Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern <code>projects/*/locations/*/keyRings/*/cryptoKeys/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=duo</code><ul>
|
|
<li>Required. The resource name of the channel. Must be unique within the location on the project and must be in <code>projects/{project}/locations/{location}/channels/{channel_id}</code> format.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>provider=ipsum</code><ul>
|
|
<li>The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: <code>projects/{project}/locations/{location}/providers/{provider_id}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pubsub-topic=sed</code><ul>
|
|
<li>Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: <code>projects/{project}/topics/{topic_id}</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=ut</code><ul>
|
|
<li>Output only. The state of a Channel.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>uid=gubergren</code><ul>
|
|
<li>Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=rebum.</code><ul>
|
|
<li>Output only. The last-modified time.</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 update-mask=string</strong></p>
|
|
<ul>
|
|
<li>The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*".</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p validate-only=boolean</strong></p>
|
|
<ul>
|
|
<li>Optional. If set, validate the request and preview the review, but do not post it.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_locations-channels-list/" class="btn btn-neutral float-left" title="Locations Channels List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-channels-set-iam-policy/" class="btn btn-neutral float-right" title="Locations Channels Set Iam Policy">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/eventarc1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-channels-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-channels-set-iam-policy/" 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>
|