Files
google-apis-rs/google_bigquery2_cli/tables_get/index.html
2022-03-08 15:36:16 +08:00

474 lines
15 KiB
HTML

<!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>Get - bigquery v3.0.0+20220222</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"> bigquery v3.0.0+20220222</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Datasets</span>
<li class="toctree-l1 ">
<a class="" href="../datasets_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../datasets_update">Update</a>
</li>
<span>Jobs</span>
<li class="toctree-l1 ">
<a class="" href="../jobs_cancel">Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_get-query-results">Get Query Results</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../jobs_query">Query</a>
</li>
<span>Models</span>
<li class="toctree-l1 ">
<a class="" href="../models_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../models_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../models_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../models_patch">Patch</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_get-service-account">Get Service Account</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_list">List</a>
</li>
<span>Routines</span>
<li class="toctree-l1 ">
<a class="" href="../routines_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../routines_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../routines_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../routines_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../routines_update">Update</a>
</li>
<span>Row Access Policies</span>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../row-access-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Tabledata</span>
<li class="toctree-l1 ">
<a class="" href="../tabledata_insert-all">Insert All</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tabledata_list">List</a>
</li>
<span>Tables</span>
<li class="toctree-l1 ">
<a class="" href="../tables_delete">Delete</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Get</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</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>
<li class="toctree-l1 ">
<a class="" href="../tables_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_test-iam-permissions">Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../tables_update">Update</a>
</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>Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/bigquery2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this 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/bigquery</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/bigquery</em>.
You can set the scope for this method like this: <code>bigquery2 --scope &lt;scope&gt; tables get ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Project ID of the requested table</li>
</ul>
</li>
<li><strong>&lt;dataset-id&gt;</strong> <em>(string)</em><ul>
<li>Dataset ID of the requested table</li>
</ul>
</li>
<li><strong>&lt;table-id&gt;</strong> <em>(string)</em><ul>
<li>Table ID of the requested table</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><strong>-p selected-fields=string</strong><ul>
<li>List of fields to return (comma-separated). If unspecified, all fields are returned</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 alt=string</strong></p>
<ul>
<li>Data format for the response.</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>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../tables_get-iam-policy" class="btn btn-neutral float-right" title="Get Iam Policy"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../tables_delete" class="btn btn-neutral" title="Delete"><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="../tables_delete" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../tables_get-iam-policy" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>