mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
Update documentation
This commit is contained in:
Sebastian Thiel
@@ -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,6 +3853,7 @@ You can set the scope for this method like this: <code>compute1 --scope <scop
|
||||
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
||||
<p>For example, a structure like this:</p>
|
||||
<pre><code>Commitment:
|
||||
auto-renew: boolean
|
||||
category: string
|
||||
creation-timestamp: string
|
||||
description: string
|
||||
@@ -3550,51 +3871,56 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
start-timestamp: string
|
||||
status: string
|
||||
status-message: string
|
||||
type: 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 . category=et</code><ul>
|
||||
<li><code>-r . auto-renew=true</code><ul>
|
||||
<li>Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>category=rebum.</code><ul>
|
||||
<li>The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>creation-timestamp=lorem</code><ul>
|
||||
<li><code>creation-timestamp=duo</code><ul>
|
||||
<li>[Output Only] Creation timestamp in RFC3339 text format.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>description=amet</code><ul>
|
||||
<li><code>description=clita</code><ul>
|
||||
<li>An optional description of this resource. Provide this property when you create the resource.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>end-timestamp=ipsum</code><ul>
|
||||
<li><code>end-timestamp=et</code><ul>
|
||||
<li>[Output Only] Commitment end time in RFC3339 text format.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>id=diam</code><ul>
|
||||
<li><code>id=sea</code><ul>
|
||||
<li>[Output Only] The unique identifier for the resource. This identifier is defined by the server.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>kind=magna</code><ul>
|
||||
<li><code>kind=invidunt</code><ul>
|
||||
<li>[Output Only] Type of the resource. Always compute#commitment for commitments.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>license-resource amount=dolores</code><ul>
|
||||
<li><code>license-resource amount=at</code><ul>
|
||||
<li>The number of licenses purchased.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>cores-per-license=est</code><ul>
|
||||
<li><code>cores-per-license=voluptua.</code><ul>
|
||||
<li>Specifies the core range of the instance for which this license applies.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>license=ut</code></p>
|
||||
<p><code>license=labore</code></p>
|
||||
<ul>
|
||||
<li>Any applicable license URI.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><code>.. name=justo</code></p>
|
||||
<p><code>.. name=nonumy</code></p>
|
||||
<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> 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>
|
||||
@@ -3603,26 +3929,30 @@ In the latter case it is advised to set the field-cursor to the data-structure's
|
||||
<li>The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>region=sanctus</code><ul>
|
||||
<li><code>region=rebum.</code><ul>
|
||||
<li>[Output Only] URL of the region where this commitment may be used.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>self-link=et</code><ul>
|
||||
<li><code>self-link=aliquyam</code><ul>
|
||||
<li>[Output Only] Server-defined URL for the resource.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>start-timestamp=stet</code><ul>
|
||||
<li><code>start-timestamp=dolor</code><ul>
|
||||
<li>[Output Only] Commitment start time in RFC3339 text format.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>status=amet.</code><ul>
|
||||
<li><code>status=diam</code><ul>
|
||||
<li>[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>status-message=takimata</code><ul>
|
||||
<li><code>status-message=et</code><ul>
|
||||
<li>[Output Only] An optional, human-readable explanation of the status.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><code>type=diam</code><ul>
|
||||
<li>The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h3 id="about-cursors">About Cursors</h3>
|
||||
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
||||
@@ -3649,11 +3979,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>
|
||||
@@ -3661,9 +3987,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>
|
||||
@@ -3693,13 +4037,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. "media", "multipart").</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>-p upload-protocol=string</strong></p>
|
||||
<ul>
|
||||
<li>Upload protocol for media (e.g. "raw", "multipart").</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>
|
||||
|
||||
Reference in New Issue
Block a user