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
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_deploymentmanager2_cli/deployments_list/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

388 lines
14 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>List - Deployment Manager v2.0.0+20210320</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"> Deployment Manager v2.0.0+20210320</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Deployments</span>
<li class="toctree-l1 ">
<a class="" href="../deployments_cancel-preview">Cancel Preview</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_insert">Insert</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="#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="../deployments_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_stop">Stop</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_test-iam-permissions">Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../deployments_update">Update</a>
</li>
<span>Manifests</span>
<li class="toctree-l1 ">
<a class="" href="../manifests_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../manifests_list">List</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_list">List</a>
</li>
<span>Resources</span>
<li class="toctree-l1 ">
<a class="" href="../resources_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../resources_list">List</a>
</li>
<span>Types</span>
<li class="toctree-l1 ">
<a class="" href="../types_list">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/master/gen/deploymentmanager2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Lists all deployments for a given project.</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/cloud-platform.read-only</em></li>
<li><em>https://www.googleapis.com/auth/ndev.cloudman</em></li>
<li><em>https://www.googleapis.com/auth/ndev.cloudman.readonly</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/ndev.cloudman.readonly</em>.
You can set the scope for this method like this: <code>deploymentmanager2 --scope &lt;scope&gt; deployments list ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;project&gt;</strong> <em>(string)</em><ul>
<li>The project ID for this request.</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 resources 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 either <code>=</code>, <code>!=</code>, <code>&amp;gt;</code>, or <code>&amp;lt;</code>. For example, if you are filtering Compute Engine instances, you can exclude instances named <code>example-instance</code> by specifying <code>name != example-instance</code>. You can also filter nested fields. For example, you could specify <code>scheduling.automaticRestart = false</code> to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: <code>(scheduling.automaticRestart = true) (cpuPlatform = &amp;#34;Intel Skylake&amp;#34;)</code> By default, each expression is an <code>AND</code> expression. However, you can include <code>AND</code> and <code>OR</code> expressions explicitly. For example: <code>(cpuPlatform = &amp;#34;Intel Skylake&amp;#34;) OR (cpuPlatform = &amp;#34;Intel Broadwell&amp;#34;) AND (scheduling.automaticRestart = true)</code></li>
</ul>
</li>
<li>
<p><strong>-p max-results=integer</strong></p>
<ul>
<li>The maximum number of results per page that should be returned. If the number of available results is larger than <code>maxResults</code>, Compute Engine returns a <code>nextPageToken</code> that can be used to get the next page of results in subsequent list requests. Acceptable values are <code>0</code> to <code>500</code>, inclusive. (Default: <code>500</code>)</li>
</ul>
</li>
<li>
<p><strong>-p order-by=string</strong></p>
<ul>
<li>Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using <code>orderBy=&amp;#34;creationTimestamp desc&amp;#34;</code>. This sorts results based on the <code>creationTimestamp</code> field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by <code>name</code> or <code>creationTimestamp desc</code> is supported.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>Specifies a page token to use. Set <code>pageToken</code> to the <code>nextPageToken</code> returned by a previous list request 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="../deployments_patch" class="btn btn-neutral float-right" title="Patch"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../deployments_insert" class="btn btn-neutral" title="Insert"><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="../deployments_insert" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../deployments_patch" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink