docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html
index 62e69af..6e24e75 100644
--- a/docs/dyn/compute_beta.instances.html
+++ b/docs/dyn/compute_beta.instances.html
@@ -81,7 +81,7 @@
<code><a href="#addResourcePolicies">addResourcePolicies(project, zone, instance, body=None, requestId=None)</a></code></p>
<p class="firstline">Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.</p>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
<p class="firstline">Retrieves aggregated list of all of the instances in your project across all regions and zones.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -90,6 +90,9 @@
<code><a href="#attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None)</a></code></p>
<p class="firstline">Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#delete">delete(project, zone, instance, requestId=None)</a></code></p>
<p class="firstline">Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.</p>
<p class="toc_element">
@@ -126,10 +129,10 @@
<code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None)</a></code></p>
<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>
<p class="toc_element">
- <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
<p class="firstline">Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed instance group, the referrers list includes the managed instance group. For more information, read Viewing Referrers to VM Instances.</p>
<p class="toc_element">
<code><a href="#listReferrers_next">listReferrers_next(previous_request, previous_response)</a></code></p>
@@ -171,6 +174,9 @@
<code><a href="#setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None)</a></code></p>
<p class="firstline">Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.</p>
<p class="toc_element">
+ <code><a href="#setName">setName(project, zone, instance, body=None, requestId=None)</a></code></p>
+<p class="firstline">Sets name of an instance.</p>
+<p class="toc_element">
<code><a href="#setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</a></code></p>
<p class="firstline">Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.</p>
<p class="toc_element">
@@ -404,7 +410,7 @@
</div>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Retrieves aggregated list of all of the instances in your project across all regions and zones.
Args:
@@ -424,6 +430,7 @@
Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Returns:
An object of the form:
@@ -451,7 +458,7 @@
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
#
# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.
#
# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
#
@@ -528,7 +535,7 @@
#
#
# If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
#
# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -549,7 +556,7 @@
#
#
# If the source snapshot is deleted later, this field will not be set.
- "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.
+ "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -697,7 +704,7 @@
"resourcePolicies": [ # Resource policies applied to this instance.
"A String",
],
- "scheduling": { # Sets the scheduling options for an Instance. NextID: 12 # Sets the scheduling options for this instance.
+ "scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
#
# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
@@ -733,16 +740,16 @@
"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
- "shieldedVmConfig": { # A set of Shielded VM options.
+ "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.
},
- "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.
+ "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
"sourceMachineImage": "A String", # Source machine image
- "sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.
+ "sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -784,6 +791,9 @@
"kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+ "unreachables": [ # [Output Only] Unreachable resources.
+ "A String",
+ ],
"warning": { # [Output Only] Informational warning message.
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
@@ -829,7 +839,7 @@
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
#
# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.
#
# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
#
@@ -906,7 +916,7 @@
#
#
# If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
#
# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -927,7 +937,7 @@
#
#
# If the source snapshot is deleted later, this field will not be set.
- "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.
+ "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -978,7 +988,7 @@
"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
}
- forceAttach: boolean, Whether to force attach the disk even if it's currently attached to another instance.
+ forceAttach: boolean, Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
requestId: string, 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.
@@ -1049,6 +1059,11 @@
</div>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>
<pre>Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
@@ -1312,7 +1327,7 @@
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
#
# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.
#
# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
#
@@ -1389,7 +1404,7 @@
#
#
# If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
#
# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -1410,7 +1425,7 @@
#
#
# If the source snapshot is deleted later, this field will not be set.
- "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.
+ "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -1558,7 +1573,7 @@
"resourcePolicies": [ # Resource policies applied to this instance.
"A String",
],
- "scheduling": { # Sets the scheduling options for an Instance. NextID: 12 # Sets the scheduling options for this instance.
+ "scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
#
# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
@@ -1594,16 +1609,16 @@
"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
- "shieldedVmConfig": { # A set of Shielded VM options.
+ "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.
},
- "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.
+ "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
"sourceMachineImage": "A String", # Source machine image
- "sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.
+ "sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -1741,7 +1756,7 @@
],
},
],
- "srcIpRanges": [ # CIDR IP address range.
+ "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
"A String",
],
},
@@ -1882,6 +1897,7 @@
],
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the current request.
@@ -2042,9 +2058,13 @@
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- instance: string, Name of the instance scoping this request. (required)
+ instance: string, Name of the instance for this request. (required)
port: integer, Specifies which COM or serial port to retrieve data from.
- start: string, Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call.
+ start: string, Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`.
+
+If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value.
+
+You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.
Returns:
An object of the form:
@@ -2052,9 +2072,9 @@
{ # An instance's serial console output.
"contents": "A String", # [Output Only] The contents of the console output.
"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.
- "next": "A String", # [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.
+ "next": "A String", # [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
- "start": "A String", # The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.
+ "start": "A String", # The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.
}</pre>
</div>
@@ -2136,7 +2156,7 @@
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
#
# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.
#
# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
#
@@ -2213,7 +2233,7 @@
#
#
# If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
#
# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -2234,7 +2254,7 @@
#
#
# If the source snapshot is deleted later, this field will not be set.
- "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.
+ "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -2382,7 +2402,7 @@
"resourcePolicies": [ # Resource policies applied to this instance.
"A String",
],
- "scheduling": { # Sets the scheduling options for an Instance. NextID: 12 # Sets the scheduling options for this instance.
+ "scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
#
# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
@@ -2418,16 +2438,16 @@
"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
- "shieldedVmConfig": { # A set of Shielded VM options.
+ "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.
},
- "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.
+ "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
"sourceMachineImage": "A String", # Source machine image
- "sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.
+ "sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -2535,7 +2555,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Retrieves the list of instances contained within the specified zone.
Args:
@@ -2555,6 +2575,7 @@
Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Returns:
An object of the form:
@@ -2580,7 +2601,7 @@
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
#
# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.
#
# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
#
@@ -2657,7 +2678,7 @@
#
#
# If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
#
# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -2678,7 +2699,7 @@
#
#
# If the source snapshot is deleted later, this field will not be set.
- "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.
+ "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -2826,7 +2847,7 @@
"resourcePolicies": [ # Resource policies applied to this instance.
"A String",
],
- "scheduling": { # Sets the scheduling options for an Instance. NextID: 12 # Sets the scheduling options for this instance.
+ "scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
#
# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
@@ -2862,16 +2883,16 @@
"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
- "shieldedVmConfig": { # A set of Shielded VM options.
+ "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.
},
- "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.
+ "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
"sourceMachineImage": "A String", # Source machine image
- "sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.
+ "sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -2915,7 +2936,7 @@
</div>
<div class="method">
- <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
<pre>Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed instance group, the referrers list includes the managed instance group. For more information, read Viewing Referrers to VM Instances.
Args:
@@ -2936,6 +2957,7 @@
Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Returns:
An object of the form:
@@ -3177,7 +3199,7 @@
#
# If the disk is not protected with a customer-supplied encryption key it should not be specified.
{
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
+ "diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -3192,7 +3214,7 @@
"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.
},
],
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.
#
# If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -3448,6 +3470,7 @@
{
"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.
{ # Associates `members` with a `role`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the current request.
@@ -3555,6 +3578,7 @@
],
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the current request.
@@ -3742,6 +3766,7 @@
],
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the current request.
@@ -4315,6 +4340,91 @@
</div>
<div class="method">
+ <code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>
+ <pre>Sets name of an instance.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ instance: string, The instance name for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.
+ "name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.
+ }
+
+ requestId: string, 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).
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
+ #
+ # Operations can be global, regional or zonal.
+ # - For global operations, use the `globalOperations` resource.
+ # - For regional operations, use the `regionOperations` resource.
+ # - For zonal operations, use the `zonalOperations` resource.
+ #
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</code>
<pre>Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
@@ -4325,7 +4435,7 @@
body: object, The request body.
The object takes the form of:
-{ # Sets the scheduling options for an Instance. NextID: 12
+{ # Sets the scheduling options for an Instance. NextID: 13
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
#
# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
@@ -4923,7 +5033,7 @@
#
# If the disk is not protected with a customer-supplied encryption key it should not be specified.
{
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Decrypts data associated with the disk with a customer-supplied encryption key.
+ "diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -5221,7 +5331,7 @@
"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.
#
# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
- "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key.
+ "diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.
#
# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.
#
@@ -5298,7 +5408,7 @@
#
#
# If the source image is deleted later, this field will not be set.
- "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
+ "sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
#
# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -5319,7 +5429,7 @@
#
#
# If the source snapshot is deleted later, this field will not be set.
- "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot.
+ "sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
@@ -5467,7 +5577,7 @@
"resourcePolicies": [ # Resource policies applied to this instance.
"A String",
],
- "scheduling": { # Sets the scheduling options for an Instance. NextID: 12 # Sets the scheduling options for this instance.
+ "scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Sets the scheduling options for this instance.
"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
#
# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.
@@ -5503,16 +5613,16 @@
"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
- "shieldedVmConfig": { # A set of Shielded VM options.
+ "shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.
},
- "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured.
+ "shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.
"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.
},
"sourceMachineImage": "A String", # Source machine image
- "sourceMachineImageEncryptionKey": { # Represents a customer-supplied encryption key # Source GMI encryption key when creating an instance from GMI.
+ "sourceMachineImageEncryptionKey": { # Source GMI encryption key when creating an instance from GMI.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.