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 ">
@@ -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>
@@ -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>
@@ -3580,154 +3900,154 @@ 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 . creation-timestamp=est</code><ul>
<li><code>-r . creation-timestamp=nonumy</code><ul>
<li>[Output Only] Creation timestamp in RFC3339 text format.</li>
</ul>
</li>
<li><code>description=vero</code><ul>
<li><code>description=sed</code><ul>
<li>No description provided.</li>
</ul>
</li>
<li><code>group-placement-policy availability-domain-count=87</code><ul>
<li><code>group-placement-policy availability-domain-count=83</code><ul>
<li>The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network</li>
</ul>
</li>
<li><code>collocation=justo</code><ul>
<li><code>collocation=amet</code><ul>
<li>Specifies network collocation</li>
</ul>
</li>
<li>
<p><code>vm-count=69</code></p>
<p><code>vm-count=54</code></p>
<ul>
<li>Number of vms in this placement group</li>
</ul>
</li>
<li>
<p><code>.. id=sit</code></p>
<p><code>.. id=amet.</code></p>
<ul>
<li>[Output Only] The unique identifier for the resource. This identifier is defined by the server.</li>
</ul>
</li>
<li><code>instance-schedule-policy expiration-time=justo</code><ul>
<li><code>instance-schedule-policy expiration-time=amet.</code><ul>
<li>The expiration time of the schedule. The timestamp is an RFC3339 string.</li>
</ul>
</li>
<li><code>start-time=sit</code><ul>
<li><code>start-time=lorem</code><ul>
<li>The start time of the schedule. The timestamp is an RFC3339 string.</li>
</ul>
</li>
<li><code>time-zone=elitr</code><ul>
<li><code>time-zone=eos</code><ul>
<li>Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: http://en.wikipedia.org/wiki/Tz_database.</li>
</ul>
</li>
<li>
<p><code>vm-start-schedule schedule=consetetur</code></p>
<p><code>vm-start-schedule schedule=duo</code></p>
<ul>
<li>Specifies the frequency for the operation, using the unix-cron format.</li>
</ul>
</li>
<li>
<p><code>..vm-stop-schedule schedule=tempor</code></p>
<p><code>..vm-stop-schedule schedule=amet</code></p>
<ul>
<li>Specifies the frequency for the operation, using the unix-cron format.</li>
</ul>
</li>
<li>
<p><code>... kind=duo</code></p>
<p><code>... kind=accusam</code></p>
<ul>
<li>[Output Only] Type of the resource. Always compute#resource_policies for resource policies.</li>
</ul>
</li>
<li><code>name=ea</code><ul>
<li><code>name=erat</code><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>region=ea</code><ul>
<li><code>region=diam</code><ul>
<li>No description provided.</li>
</ul>
</li>
<li><code>resource-status.instance-schedule-policy last-run-start-time=invidunt</code><ul>
<li><code>resource-status.instance-schedule-policy last-run-start-time=dolore</code><ul>
<li>[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.</li>
</ul>
</li>
<li>
<p><code>next-run-start-time=amet.</code></p>
<p><code>next-run-start-time=lorem</code></p>
<ul>
<li>[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.</li>
</ul>
</li>
<li>
<p><code>... self-link=et</code></p>
<p><code>... self-link=lorem</code></p>
<ul>
<li>[Output Only] Server-defined fully-qualified URL for this resource.</li>
</ul>
</li>
<li><code>snapshot-schedule-policy.retention-policy max-retention-days=6</code><ul>
<li><code>snapshot-schedule-policy.retention-policy max-retention-days=58</code><ul>
<li>Maximum age of the snapshot that is allowed to be kept.</li>
</ul>
</li>
<li>
<p><code>on-source-disk-delete=ipsum</code></p>
<p><code>on-source-disk-delete=duo</code></p>
<ul>
<li>Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.</li>
</ul>
</li>
<li>
<p><code>..schedule.daily-schedule days-in-cycle=90</code></p>
<p><code>..schedule.daily-schedule days-in-cycle=43</code></p>
<ul>
<li>Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.</li>
<li>Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.</li>
</ul>
</li>
<li><code>duration=dolor</code><ul>
<li><code>duration=sea</code><ul>
<li>[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.</li>
</ul>
</li>
<li>
<p><code>start-time=dolores</code></p>
<p><code>start-time=amet</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>..hourly-schedule duration=ea</code></p>
<p><code>..hourly-schedule duration=labore</code></p>
<ul>
<li>[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.</li>
</ul>
</li>
<li><code>hours-in-cycle=83</code><ul>
<li><code>hours-in-cycle=37</code><ul>
<li>Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.</li>
</ul>
</li>
<li>
<p><code>start-time=voluptua.</code></p>
<p><code>start-time=est</code></p>
<ul>
<li>Time within the window to start the operations. It must be in format &#34;HH:MM&#34;, where HH : [00-23] and MM : [00-00] GMT.</li>
</ul>
</li>
<li>
<p><code>...snapshot-properties chain-name=stet</code></p>
<p><code>...snapshot-properties chain-name=consetetur</code></p>
<ul>
<li>Chain name that the snapshot is created in.</li>
</ul>
</li>
<li><code>guest-flush=false</code><ul>
<li><code>guest-flush=true</code><ul>
<li>Indication to perform a &#39;guest aware&#39; snapshot.</li>
</ul>
</li>
<li><code>labels=key=rebum.</code><ul>
<li><code>labels=key=eos</code><ul>
<li>Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li>
<p><code>storage-locations=est</code></p>
<p><code>storage-locations=amet</code></p>
<ul>
<li>Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li>
<p><code>... status=erat</code></p>
<p><code>... status=justo</code></p>
<ul>
<li>[Output Only] The status of resource policy creation.</li>
</ul>
@@ -3758,11 +4078,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>
@@ -3770,9 +4086,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>
@@ -3802,13 +4136,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>