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

334 lines
12 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>List - Cloud Functions v3.0.0+20220224</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"> Cloud Functions v3.0.0+20220224</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">List</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</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>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-call">Locations Functions Call</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-create">Locations Functions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-delete">Locations Functions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-generate-download-url">Locations Functions Generate Download Url</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-generate-upload-url">Locations Functions Generate Upload Url</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-get">Locations Functions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-get-iam-policy">Locations Functions Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-list">Locations Functions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-patch">Locations Functions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-set-iam-policy">Locations Functions Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-functions-test-iam-permissions">Locations Functions Test Iam Permissions</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>List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudfunctions1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Lists operations that match the specified filter in the request. If the server doesn&#39;t support this method, it returns <code>UNIMPLEMENTED</code>. NOTE: the <code>name</code> binding allows API services to override the binding to use different resource name schemes, such as <code>users/*/operations</code>. To override the binding, API services can add a binding such as <code>&amp;#34;/v1/{name=users/*}/operations&amp;#34;</code> to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</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>cloudfunctions1 --scope &lt;scope&gt; operations list ...</code></p>
<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>Required. A filter for matching the requested operations. The supported formats of <em>filter</em> are: To query for a specific function: project:<em>,location:</em>,function:<em> To query for all of the latest operations for a project: project:</em>,latest:true</li>
</ul>
</li>
<li>
<p><strong>-p name=string</strong></p>
<ul>
<li>Must not be set.</li>
</ul>
</li>
<li>
<p><strong>-p page-size=integer</strong></p>
<ul>
<li>The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set, the default page size is 100. Pagination is only supported when querying for a specific function.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>Token identifying which result to start with, which is returned by a previous list call. Pagination is only supported when querying for a specific function.</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_locations-functions-call" class="btn btn-neutral float-right" title="Locations Functions Call"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../operations_get" class="btn btn-neutral" title="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="../operations_get" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-functions-call" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>