mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
357 lines
20 KiB
HTML
357 lines
20 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-clusters-backups-list/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Instances Clusters Backups List - 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 Clusters Backups List";
|
|
var mkdocs_page_input_path = "projects_instances-clusters-backups-list.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-bigtableadmin2-cli/projects_instances-clusters-backups-list/";
|
|
</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 current"><a class="reference internal current" href="./">Instances Clusters Backups List</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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"><a class="reference internal" href="../projects_instances-tables-patch/">Instances Tables Patch</a>
|
|
</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> »</li>
|
|
<li>Projects »</li>
|
|
<li>Instances Clusters Backups List</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-clusters-backups-list.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>Lists Cloud Bigtable backups. Returns both completed and pending backups.</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 <scope> projects instances-clusters-backups-list ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The cluster to list backups from. Values are of the form <code>projects/{project}/instances/{instance}/clusters/{cluster}</code>. Use <code>{cluster} = &#39;-&#39;</code> to list backups for all clusters in an instance, e.g., <code>projects/{project}/instances/{instance}/clusters/-</code>.</li>
|
|
</ul>
|
|
</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 filter=string</strong></p>
|
|
<ul>
|
|
<li>A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are: * <code>name</code> * <code>source_table</code> * <code>state</code> * <code>start_time</code> (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * <code>end_time</code> (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * <code>expire_time</code> (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * <code>size_bytes</code> To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are: * <code>name:&#34;exact&#34;</code> --> The backup's name is the string "exact". * <code>name:howl</code> --> The backup's name contains the string "howl". * <code>source_table:prod</code> --> The source_table's name contains the string "prod". * <code>state:CREATING</code> --> The backup is pending creation. * <code>state:READY</code> --> The backup is fully created and ready for use. * <code>(name:howl) AND (start_time &lt; \&#34;2018-03-28T14:50:00Z\&#34;)</code> --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z. * <code>size_bytes &gt; 10000000000</code> --> The backup's size is greater than 10GB</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p order-by=string</strong></p>
|
|
<ul>
|
|
<li>An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted by <code>start_time</code> in descending order starting from the most recently created backup.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-size=integer</strong></p>
|
|
<ul>
|
|
<li>Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p page-token=string</strong></p>
|
|
<ul>
|
|
<li>If non-empty, <code>page_token</code> should contain a next_page_token from a previous ListBackupsResponse to the same <code>parent</code> and with the same <code>filter</code>.</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_instances-clusters-backups-get-iam-policy/" class="btn btn-neutral float-left" title="Instances Clusters Backups Get Iam Policy"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_instances-clusters-backups-patch/" class="btn btn-neutral float-right" title="Instances Clusters Backups Patch">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/bigtableadmin2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_instances-clusters-backups-get-iam-policy/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_instances-clusters-backups-patch/" 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>
|