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>
@@ -3533,58 +3853,89 @@ In the latter case it is advised to set the field-cursor to the data-structure's
auto-create-subnetworks: boolean
creation-timestamp: string
description: string
enable-ula-internal-ipv6: boolean
gateway-i-pv4: string
id: string
internal-ipv6-range: string
kind: string
mtu: integer
name: string
network-firewall-policy-enforcement-order: string
routing-config:
routing-mode: string
self-link: string
self-link-with-id: string
subnetworks: [string]
</code></pre>
<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 . i-pv4-range=eirmod</code><ul>
<li><code>-r . i-pv4-range=labore</code><ul>
<li>Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.</li>
</ul>
</li>
<li>
<p><code>auto-create-subnetworks=true</code></p>
<ul>
<li>
<p>Must be set to create a VPC network. If not set, a legacy network is created.</p>
<p>When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode.</p>
<p>An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges.</p>
<p>For custom mode VPC networks, you can add subnets using the subnetworks insert method.
<em> <code>creation-timestamp=justo</code>
- [Output Only] Creation timestamp in RFC3339 text format.
</em> <code>description=kasd</code>
- An optional description of this resource. Provide this field when you create the resource.
<em> <code>gateway-i-pv4=sea</code>
- [Output Only] The gateway address for default routing out of the network, selected by GCP.
</em> <code>id=et</code>
- [Output Only] The unique identifier for the resource. This identifier is defined by the server.
<em> <code>kind=tempor</code>
- [Output Only] Type of the resource. Always compute#network for networks.
</em> <code>mtu=3</code>
- Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes.
<em> <code>name=diam</code>
- Name of the resource. Provided by the client when the resource is created. The 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>. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
</em> <code>routing-config routing-mode=amet.</code>
- The network-wide routing mode to use. If set to REGIONAL, this network&#39;s Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network&#39;s Cloud Routers will advertise routes with all subnets of this network, across regions.</p>
<li><code>auto-create-subnetworks=false</code><ul>
<li>Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.</li>
</ul>
</li>
<li><code>creation-timestamp=aliquyam</code><ul>
<li>[Output Only] Creation timestamp in RFC3339 text format.</li>
</ul>
</li>
<li><code>description=consetetur</code><ul>
<li>An optional description of this resource. Provide this field when you create the resource.</li>
</ul>
</li>
<li><code>enable-ula-internal-ipv6=true</code><ul>
<li>Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .</li>
</ul>
</li>
<li><code>gateway-i-pv4=nonumy</code><ul>
<li>[Output Only] The gateway address for default routing out of the network, selected by GCP.</li>
</ul>
</li>
<li><code>id=diam</code><ul>
<li>[Output Only] The unique identifier for the resource. This identifier is defined by the server.</li>
</ul>
</li>
<li><code>internal-ipv6-range=et</code><ul>
<li>When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .</li>
</ul>
</li>
<li><code>kind=amet.</code><ul>
<li>[Output Only] Type of the resource. Always compute#network for networks.</li>
</ul>
</li>
<li><code>mtu=69</code><ul>
<li>Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. If unspecified, defaults to 1460.</li>
</ul>
</li>
<li><code>name=vero</code><ul>
<li>Name of the resource. Provided by the client when the resource is created. The 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>. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.</li>
</ul>
</li>
<li><code>network-firewall-policy-enforcement-order=ea</code><ul>
<li>The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.</li>
</ul>
</li>
<li>
<p><code>.. self-link=vero</code></p>
<p><code>routing-config routing-mode=et</code></p>
<ul>
<li>The network-wide routing mode to use. If set to REGIONAL, this network&#39;s Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network&#39;s Cloud Routers will advertise routes with all subnets of this network, across regions.</li>
</ul>
</li>
<li>
<p><code>.. self-link=lorem</code></p>
<ul>
<li>[Output Only] Server-defined URL for the resource.</li>
</ul>
</li>
<li><code>subnetworks=tempor</code><ul>
<li><code>self-link-with-id=erat</code><ul>
<li>[Output Only] Server-defined URL for this resource with the resource id.</li>
</ul>
</li>
<li><code>subnetworks=stet</code><ul>
<li>[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
@@ -3615,11 +3966,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>
@@ -3627,9 +3974,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>
@@ -3659,13 +4024,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>