Update documentation

This commit is contained in:
Sebastian Thiel
2022-03-08 15:36:16 +08:00
parent b84384c010
commit a20241b241
10471 changed files with 1934132 additions and 64947 deletions

View File

@@ -5,7 +5,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>List - compute v2.0.4+20210316</title>
<title>List - compute v3.0.0+20220224</title>
@@ -34,7 +34,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> compute v2.0.4+20210316</a>
<a href=".." class="icon icon-home"> compute v3.0.0+20220224</a>
</div>
@@ -172,6 +172,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-buckets_set-edge-security-policy">Set Edge Security Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-buckets_update">Update</a>
@@ -228,6 +233,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-services_set-edge-security-policy">Set Edge Security Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../backend-services_set-security-policy">Set Security Policy</a>
@@ -852,6 +862,17 @@
<span>Image Family Views</span>
<li class="toctree-l1 ">
<a class="" href="../image-family-views_get">Get</a>
</li>
<span>Images</span>
<li class="toctree-l1 ">
@@ -1213,6 +1234,16 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_resume">Resume</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_send-diagnostic-interrupt">Send Diagnostic Interrupt</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_set-deletion-protection">Set Deletion Protection</a>
@@ -1293,6 +1324,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_suspend">Suspend</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../instances_test-iam-permissions">Test Iam Permissions</a>
@@ -1472,6 +1508,47 @@
<span>Machine Images</span>
<li class="toctree-l1 ">
<a class="" href="../machine-images_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../machine-images_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Machine Types</span>
<li class="toctree-l1 ">
@@ -1544,6 +1621,92 @@
<span>Network Firewall Policies</span>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_add-association">Add Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_add-rule">Add Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_clone-rules">Clone Rules</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get-association">Get Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_get-rule">Get Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_patch-rule">Patch Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_remove-association">Remove Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_remove-rule">Remove Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../network-firewall-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Networks</span>
<li class="toctree-l1 ">
@@ -2021,6 +2184,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../region-commitments_update">Update</a>
</li>
@@ -2338,6 +2506,97 @@
<span>Region Network Firewall Policies</span>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_add-association">Add Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_add-rule">Add Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_clone-rules">Clone Rules</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-association">Get Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-effective-firewalls">Get Effective Firewalls</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_get-rule">Get Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_patch-rule">Patch Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_remove-association">Remove Association</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_remove-rule">Remove Rule</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../region-network-firewall-policies_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Region Notification Endpoints</span>
<li class="toctree-l1 ">
@@ -2587,6 +2846,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../reservations_update">Update</a>
</li>
@@ -2775,6 +3039,57 @@
<span>Service Attachments</span>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_aggregated-list">Aggregated List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_get-iam-policy">Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_patch">Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_set-iam-policy">Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../service-attachments_test-iam-permissions">Test Iam Permissions</a>
</li>
<span>Snapshots</span>
<li class="toctree-l1 ">
@@ -2792,6 +3107,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../snapshots_insert">Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../snapshots_list">List</a>
@@ -3539,12 +3859,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
<li>
<p><strong>-p filter=string</strong></p>
<ul>
<li>
<p>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>.</p>
<p>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>.</p>
<p>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.</p>
<p>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></p>
</li>
<li>A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either <code>=</code>, <code>!=</code>, <code>&amp;gt;</code>, <code>&amp;lt;</code>, <code>&amp;lt;=</code>, <code>&amp;gt;=</code> or <code>:</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>. The <code>:</code> operator can be used with string fields to match substrings. For non-string fields it is equivalent to the <code>=</code> operator. The <code>:*</code> comparison can be used to test whether a key has been defined. For example, to find all objects with <code>owner</code> label use: <code>labels.owner:*</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>
@@ -3556,11 +3871,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
<li>
<p><strong>-p order-by=string</strong></p>
<ul>
<li>
<p>Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.</p>
<p>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.</p>
<p>Currently, only sorting by <code>name</code> or <code>creationTimestamp desc</code> is supported.</p>
</li>
<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>
@@ -3580,9 +3891,27 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
<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 the response.</li>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
@@ -3612,13 +3941,25 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
<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>
<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>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
<li>Legacy name for parameter that has been superseded by <code>quotaUser</code>.</li>
</ul>
</li>
</ul>