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>Insert - compute v2.0.4+20210316</title>
<title>Insert - 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 ">
@@ -2045,6 +2208,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../region-commitments_update">Update</a>
</li>
@@ -2362,6 +2530,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 ">
@@ -2611,6 +2870,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../reservations_update">Update</a>
</li>
@@ -2799,6 +3063,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 ">
@@ -2816,6 +3131,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>
@@ -3564,18 +3884,18 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r .autoscaling-policy max-nodes=83</code><ul>
<li><code>-r .autoscaling-policy max-nodes=15</code><ul>
<li>The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.</li>
</ul>
</li>
<li><code>min-nodes=82</code><ul>
<li><code>min-nodes=9</code><ul>
<li>The minimum number of nodes that the group should have.</li>
</ul>
</li>
<li>
<p><code>mode=amet.</code></p>
<p><code>mode=justo</code></p>
<ul>
<li>The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.</li>
<li>The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.</li>
</ul>
</li>
<li>
@@ -3584,69 +3904,69 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<li>[Output Only] Creation timestamp in RFC3339 text format.</li>
</ul>
</li>
<li><code>description=takimata</code><ul>
<li><code>description=ut</code><ul>
<li>An optional description of this resource. Provide this property when you create the resource.</li>
</ul>
</li>
<li><code>fingerprint=no</code><ul>
<li><code>fingerprint=voluptua.</code><ul>
<li>No description provided.</li>
</ul>
</li>
<li><code>id=at</code><ul>
<li><code>id=amet.</code><ul>
<li>[Output Only] The unique identifier for the resource. This identifier is defined by the server.</li>
</ul>
</li>
<li><code>kind=no</code><ul>
<li><code>kind=et</code><ul>
<li>[Output Only] The type of the resource. Always compute#nodeGroup for node group.</li>
</ul>
</li>
<li><code>location-hint=et</code><ul>
<li><code>location-hint=rebum.</code><ul>
<li>An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.</li>
</ul>
</li>
<li><code>maintenance-policy=sed</code><ul>
<li>Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.</li>
<li><code>maintenance-policy=takimata</code><ul>
<li>Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.</li>
</ul>
</li>
<li><code>maintenance-window.maintenance-duration nanos=16</code><ul>
<li><code>maintenance-window.maintenance-duration nanos=9</code><ul>
<li>Span of time that&#39;s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 <code>seconds</code> field and a positive <code>nanos</code> field. Must be from 0 to 999,999,999 inclusive.</li>
</ul>
</li>
<li>
<p><code>seconds=sed</code></p>
<p><code>seconds=et</code></p>
<ul>
<li>Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years</li>
</ul>
</li>
<li>
<p><code>.. start-time=diam</code></p>
<p><code>.. start-time=sea</code></p>
<ul>
<li>Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.</li>
</ul>
</li>
<li>
<p><code>.. name=sit</code></p>
<p><code>.. name=tempor</code></p>
<ul>
<li>The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression <code>[a-z]([-a-z0-9]*[a-z0-9])?</code> which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.</li>
</ul>
</li>
<li><code>node-template=consetetur</code><ul>
<li><code>node-template=est</code><ul>
<li>URL of the node template to create the node group from.</li>
</ul>
</li>
<li><code>self-link=diam</code><ul>
<li><code>self-link=ipsum</code><ul>
<li>[Output Only] Server-defined URL for the resource.</li>
</ul>
</li>
<li><code>size=56</code><ul>
<li><code>size=89</code><ul>
<li>[Output Only] The total number of nodes in the node group.</li>
</ul>
</li>
<li><code>status=erat</code><ul>
<li><code>status=et</code><ul>
<li>No description provided.</li>
</ul>
</li>
<li><code>zone=dolores</code><ul>
<li><code>zone=gubergren</code><ul>
<li>[Output Only] The name of the zone where the node group resides, such as us-central1-a.</li>
</ul>
</li>
@@ -3676,11 +3996,7 @@ or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> eve
<code>-p</code> for completeness.</p>
<ul>
<li><strong>-p request-id=string</strong><ul>
<li>
<p>An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.</p>
<p>For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.</p>
<p>The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).</p>
</li>
<li>An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).</li>
</ul>
</li>
</ul>
@@ -3688,9 +4004,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>
@@ -3720,13 +4054,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>