OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_firestore1_cli/projects_databases-collection-groups-fields-list/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

431 lines
16 KiB
HTML
Raw Blame History

<!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>Databases Collection Groups Fields List - Firestore v3.0.0+20220221</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"> Firestore v3.0.0+20220221</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-collection-groups-fields-get">Databases Collection Groups Fields Get</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Databases Collection Groups Fields List</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</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="../projects_databases-collection-groups-fields-patch">Databases Collection Groups Fields Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-collection-groups-indexes-create">Databases Collection Groups Indexes Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-collection-groups-indexes-delete">Databases Collection Groups Indexes Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-collection-groups-indexes-get">Databases Collection Groups Indexes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-collection-groups-indexes-list">Databases Collection Groups Indexes List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-batch-get">Databases Documents Batch Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-batch-write">Databases Documents Batch Write</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-begin-transaction">Databases Documents Begin Transaction</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-commit">Databases Documents Commit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-create-document">Databases Documents Create Document</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-delete">Databases Documents Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-get">Databases Documents Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-list">Databases Documents List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-list-collection-ids">Databases Documents List Collection Ids</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-listen">Databases Documents Listen</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-partition-query">Databases Documents Partition Query</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-patch">Databases Documents Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-rollback">Databases Documents Rollback</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-run-query">Databases Documents Run Query</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-documents-write">Databases Documents Write</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-export-documents">Databases Export Documents</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-get">Databases Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-import-documents">Databases Import Documents</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-list">Databases List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-operations-cancel">Databases Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-operations-delete">Databases Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-operations-get">Databases Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-operations-list">Databases Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_databases-patch">Databases Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</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>Databases Collection Groups Fields List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firestore1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to <code>indexConfig.usesAncestorConfig:false</code> .</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/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/datastore</em></li>
</ul>
<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>firestore1 --scope &lt;scope&gt; projects databases-collection-groups-fields-list ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</strong> <em>(string)</em><ul>
<li>Required. A parent name of the form <code>projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}</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>The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes <code>indexConfig.usesAncestorConfig:false</code> .</li>
</ul>
</li>
<li>
<p><strong>-p page-size=integer</strong></p>
<ul>
<li>The number of results to return.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.</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_databases-collection-groups-fields-patch" class="btn btn-neutral float-right" title="Databases Collection Groups Fields Patch"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_databases-collection-groups-fields-get" class="btn btn-neutral" title="Databases Collection Groups Fields Get"><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="../projects_databases-collection-groups-fields-get" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_databases-collection-groups-fields-patch" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink