mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
367 lines
18 KiB
HTML
367 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-pubsublite1-cli/admin_projects-locations-topics-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Projects Locations Topics Patch - PubsubLite v5.0.4+20240224</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 = "Projects Locations Topics Patch";
|
|
var mkdocs_page_input_path = "admin_projects-locations-topics-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-pubsublite1-cli/admin_projects-locations-topics-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"> PubsubLite v5.0.4+20240224
|
|
</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">Admin</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-operations-cancel/">Projects Locations Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-operations-delete/">Projects Locations Operations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-operations-get/">Projects Locations Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-operations-list/">Projects Locations Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-reservations-create/">Projects Locations Reservations Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-reservations-delete/">Projects Locations Reservations Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-reservations-get/">Projects Locations Reservations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-reservations-list/">Projects Locations Reservations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-reservations-patch/">Projects Locations Reservations Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-reservations-topics-list/">Projects Locations Reservations Topics List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-subscriptions-create/">Projects Locations Subscriptions Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-subscriptions-delete/">Projects Locations Subscriptions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-subscriptions-get/">Projects Locations Subscriptions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-subscriptions-list/">Projects Locations Subscriptions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-subscriptions-patch/">Projects Locations Subscriptions Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-subscriptions-seek/">Projects Locations Subscriptions Seek</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-topics-create/">Projects Locations Topics Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-topics-delete/">Projects Locations Topics Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-topics-get/">Projects Locations Topics Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-topics-get-partitions/">Projects Locations Topics Get Partitions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-topics-list/">Projects Locations Topics List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Projects Locations Topics Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../admin_projects-locations-topics-subscriptions-list/">Projects Locations Topics Subscriptions List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Cursor</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cursor_projects-locations-subscriptions-commit-cursor/">Projects Locations Subscriptions Commit Cursor</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cursor_projects-locations-subscriptions-cursors-list/">Projects Locations Subscriptions Cursors List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Topic Stats</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../topic-stats_projects-locations-topics-compute-head-cursor/">Projects Locations Topics Compute Head Cursor</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../topic-stats_projects-locations-topics-compute-message-stats/">Projects Locations Topics Compute Message Stats</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../topic-stats_projects-locations-topics-compute-time-cursor/">Projects Locations Topics Compute Time Cursor</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="..">PubsubLite v5.0.4+20240224</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>Admin »</li>
|
|
<li>Projects Locations Topics Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/pubsublite1-cli/edit/master/docs/admin_projects-locations-topics-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>Updates properties of the specified topic.</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>pubsublite1 --scope <scope> admin projects-locations-topics-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}</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>Topic:
|
|
name: string
|
|
partition-config:
|
|
capacity:
|
|
publish-mib-per-sec: integer
|
|
subscribe-mib-per-sec: integer
|
|
count: string
|
|
scale: integer
|
|
reservation-config:
|
|
throughput-reservation: string
|
|
retention-config:
|
|
per-partition-bytes: string
|
|
period: 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 . name=ipsum</code><ul>
|
|
<li>The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>partition-config.capacity publish-mib-per-sec=51</code><ul>
|
|
<li>Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>subscribe-mib-per-sec=94</code></p>
|
|
<ul>
|
|
<li>Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. count=gubergren</code></p>
|
|
<ul>
|
|
<li>The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>scale=84</code></p>
|
|
<ul>
|
|
<li>DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to <code>scale</code> times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with <code>scale</code> of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..reservation-config throughput-reservation=dolor</code></p>
|
|
<ul>
|
|
<li>The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..retention-config per-partition-bytes=lorem</code></p>
|
|
<ul>
|
|
<li>The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of <code>period</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>period=eos</code><ul>
|
|
<li>How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below <code>per_partition_bytes</code>.</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><strong>-p update-mask=string</strong><ul>
|
|
<li>Required. A mask specifying the topic fields to change.</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="../admin_projects-locations-topics-list/" class="btn btn-neutral float-left" title="Projects Locations Topics List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../admin_projects-locations-topics-subscriptions-list/" class="btn btn-neutral float-right" title="Projects Locations Topics Subscriptions List">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/pubsublite1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../admin_projects-locations-topics-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../admin_projects-locations-topics-subscriptions-list/" 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>
|