Files
google-apis-rs/google_bigtableadmin2_cli/build_html/projects_instances-tables-patch/index.html
2024-03-05 21:06:01 +01:00

439 lines
23 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-bigtableadmin2-cli/projects_instances-tables-patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Instances Tables Patch - Bigtable Admin 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 = "Instances Tables Patch";
var mkdocs_page_input_path = "projects_instances-tables-patch.md";
var mkdocs_page_url = "/google-apis-rs/google-bigtableadmin2-cli/projects_instances-tables-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"> Bigtable Admin 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>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations_projects-operations-list/">Projects Operations List</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_instances-app-profiles-create/">Instances App Profiles Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-delete/">Instances App Profiles Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-get/">Instances App Profiles Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-list/">Instances App Profiles List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-app-profiles-patch/">Instances App Profiles Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-copy/">Instances Clusters Backups Copy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-create/">Instances Clusters Backups Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-delete/">Instances Clusters Backups Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-get/">Instances Clusters Backups Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-get-iam-policy/">Instances Clusters Backups Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-list/">Instances Clusters Backups List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-patch/">Instances Clusters Backups Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-set-iam-policy/">Instances Clusters Backups Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-backups-test-iam-permissions/">Instances Clusters Backups Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-create/">Instances Clusters Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-delete/">Instances Clusters Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-get/">Instances Clusters Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-hot-tablets-list/">Instances Clusters Hot Tablets List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-list/">Instances Clusters List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-partial-update-cluster/">Instances Clusters Partial Update Cluster</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-clusters-update/">Instances Clusters Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-create/">Instances Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-delete/">Instances Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-get/">Instances Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-get-iam-policy/">Instances Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-list/">Instances List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-partial-update-instance/">Instances Partial Update Instance</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-set-iam-policy/">Instances Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-check-consistency/">Instances Tables Check Consistency</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-create/">Instances Tables Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-delete/">Instances Tables Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-drop-row-range/">Instances Tables Drop Row Range</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-generate-consistency-token/">Instances Tables Generate Consistency Token</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-get/">Instances Tables Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-get-iam-policy/">Instances Tables Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-list/">Instances Tables List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-modify-column-families/">Instances Tables Modify Column Families</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Instances Tables Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-restore/">Instances Tables Restore</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-set-iam-policy/">Instances Tables Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-test-iam-permissions/">Instances Tables Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-tables-undelete/">Instances Tables Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-test-iam-permissions/">Instances Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_instances-update/">Instances Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</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="..">Bigtable Admin 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> &raquo;</li>
<li>Projects &raquo;</li>
<li>Instances Tables Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigtableadmin2-cli/edit/master/docs/projects_instances-tables-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 a specified table.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/bigtable.admin</em></li>
<li><em>https://www.googleapis.com/auth/bigtable.admin.table</em></li>
<li><em>https://www.googleapis.com/auth/cloud-bigtable.admin</em></li>
<li><em>https://www.googleapis.com/auth/cloud-bigtable.admin.table</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigtable.admin</em>.
You can set the scope for this method like this: <code>bigtableadmin2 --scope &lt;scope&gt; projects instances-tables-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The unique name of the table. Values are of the form <code>projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*</code>. Views: <code>NAME_ONLY</code>, <code>SCHEMA_VIEW</code>, <code>REPLICATION_VIEW</code>, <code>STATS_VIEW</code>, <code>FULL</code></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>Table:
change-stream-config:
retention-period: string
deletion-protection: boolean
granularity: string
name: string
restore-info:
backup-info:
backup: string
end-time: string
source-backup: string
source-table: string
start-time: string
source-type: string
stats:
average-cells-per-column: number
average-columns-per-row: number
logical-data-bytes: string
row-count: int64
</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>
<p><code>-r .change-stream-config retention-period=sadipscing</code></p>
<ul>
<li>How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.</li>
</ul>
</li>
<li>
<p><code>.. deletion-protection=true</code></p>
<ul>
<li>Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.</li>
</ul>
</li>
<li><code>granularity=sadipscing</code><ul>
<li>Immutable. The granularity (i.e. <code>MILLIS</code>) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to <code>MILLIS</code>. Views: <code>SCHEMA_VIEW</code>, <code>FULL</code>.</li>
</ul>
</li>
<li><code>name=erat</code><ul>
<li>The unique name of the table. Values are of the form <code>projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*</code>. Views: <code>NAME_ONLY</code>, <code>SCHEMA_VIEW</code>, <code>REPLICATION_VIEW</code>, <code>STATS_VIEW</code>, <code>FULL</code></li>
</ul>
</li>
<li><code>restore-info.backup-info backup=aliquyam</code><ul>
<li>Output only. Name of the backup.</li>
</ul>
</li>
<li><code>end-time=amet</code><ul>
<li>Output only. This time that the backup was finished. Row data in the backup will be no newer than this timestamp.</li>
</ul>
</li>
<li><code>source-backup=est</code><ul>
<li>Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/</li>
</ul>
</li>
<li><code>source-table=et</code><ul>
<li>Output only. Name of the table the backup was created from.</li>
</ul>
</li>
<li>
<p><code>start-time=sea</code></p>
<ul>
<li>Output only. The time that the backup was started. Row data in the backup will be no older than this timestamp.</li>
</ul>
</li>
<li>
<p><code>.. source-type=consetetur</code></p>
<ul>
<li>The type of the restore source.</li>
</ul>
</li>
<li>
<p><code>..stats average-cells-per-column=0.4299445546232471</code></p>
<ul>
<li>How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in &#34;family:col&#34; and 1 cell in &#34;other:col&#34; (4 cells / 2 columns) * A row with 1 cell in &#34;family:col&#34;, 7 cells in &#34;family:other_col&#34;, and 7 cells in &#34;other:data&#34; (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.</li>
</ul>
</li>
<li><code>average-columns-per-row=0.7410819677361549</code><ul>
<li>How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in &#34;family:col&#34; and &#34;other:col&#34; (2 distinct columns) * A row with cells in &#34;family:col&#34;, &#34;family:other_col&#34;, and &#34;other:data&#34; (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.</li>
</ul>
</li>
<li><code>logical-data-bytes=aliquyam</code><ul>
<li>This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).</li>
</ul>
</li>
<li><code>row-count=-94</code><ul>
<li>How many rows are in the table.</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. The list of fields to update. A mask specifying which fields (e.g. <code>change_stream_config</code>) in the <code>table</code> field should be updated. This mask is relative to the <code>table</code> field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * <code>change_stream_config</code> * <code>change_stream_config.retention_period</code> * <code>deletion_protection</code> If <code>column_families</code> is set in <code>update_mask</code>, it will return an UNIMPLEMENTED error.</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_instances-tables-modify-column-families/" class="btn btn-neutral float-left" title="Instances Tables Modify Column Families"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_instances-tables-restore/" class="btn btn-neutral float-right" title="Instances Tables Restore">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 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/bigtableadmin2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_instances-tables-modify-column-families/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_instances-tables-restore/" style="color: #fcfcfc">Next &raquo;</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>