docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
index 1c81002..8dc94ef 100644
--- a/docs/dyn/compute_alpha.instances.html
+++ b/docs/dyn/compute_alpha.instances.html
@@ -93,6 +93,9 @@
<code><a href="#bulkInsert">bulkInsert(project, zone, body=None, requestId=None)</a></code></p>
<p class="firstline">Creates multiple instances. Count specifies the number of instances to create.</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">
@@ -447,6 +450,10 @@
{ # Represents an Instance resource.
#
# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"confidentialInstanceConfig": { # A set of Confidential Instance options.
"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
@@ -462,7 +469,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.
#
@@ -517,6 +524,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -542,7 +550,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.
@@ -563,7 +571,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.
@@ -630,7 +638,7 @@
],
"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
#
# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
#
@@ -721,12 +729,13 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
},
],
- "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
@@ -739,17 +748,13 @@
"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.
+ "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
+ "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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -764,6 +769,9 @@
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
},
+ "secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.
+ "A String",
+ ],
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
@@ -784,16 +792,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.
@@ -817,8 +825,8 @@
],
},
"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.
- "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.
- "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.
+ "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
+ "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
"type": "A String", # Defines the type of maintenance.
},
"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
@@ -888,7 +896,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.
#
@@ -943,6 +951,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -968,7 +977,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.
@@ -989,7 +998,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.
@@ -1041,7 +1050,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.
@@ -1127,6 +1136,10 @@
"instance": { # Represents an Instance resource.
#
# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"confidentialInstanceConfig": { # A set of Confidential Instance options.
"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
@@ -1142,7 +1155,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.
#
@@ -1197,6 +1210,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -1222,7 +1236,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.
@@ -1243,7 +1257,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.
@@ -1310,7 +1324,7 @@
],
"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
#
# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
#
@@ -1401,12 +1415,13 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
},
],
- "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
@@ -1419,17 +1434,13 @@
"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.
+ "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
+ "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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -1444,6 +1455,9 @@
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
},
+ "secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.
+ "A String",
+ ],
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
@@ -1464,16 +1478,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.
@@ -1497,20 +1511,322 @@
],
},
"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.
- "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.
- "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.
+ "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
+ "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
"type": "A String", # Defines the type of maintenance.
},
"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
},
+ "instanceProperties": { # The instance properties for the request. Required if sourceInstanceTemplate is not provided.
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
+ "canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.
+ "confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
+ "enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
+ },
+ "description": "A String", # An optional text description for the instances that are created from these properties.
+ "disks": [ # An array of disks that are associated with the instances that are created from these properties.
+ { # An instance-attached disk resource.
+ "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+ "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+ "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": { # 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.
+ #
+ # If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.
+ #
+ # If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
+ #
+ # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
+ "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.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ },
+ "diskSizeGb": "A String", # The size of the disk in GB.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
+ },
+ ],
+ "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.
+ "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ #
+ # This property is mutually exclusive with the source property; you can only define one or the other, but not both.
+ "description": "A String", # An optional description. Provide this property when creating the disk.
+ "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
+ "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
+ "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:
+ # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+ #
+ #
+ # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+ # - projects/project/zones/zone/diskTypes/diskType
+ # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
+ "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
+ #
+ # Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
+ { # Guest OS features.
+ "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.
+ },
+ ],
+ "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
+ "a_key": "A String",
+ },
+ "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
+ "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
+ "replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
+ "A String",
+ ],
+ "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
+ "A String",
+ ],
+ "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
+ #
+ # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:
+ # projects/debian-cloud/global/images/family/debian-9
+ #
+ #
+ # Alternatively, use a specific version of a public operating system image:
+ # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+ #
+ #
+ # To create a disk with a custom image that you created, specify the image name in the following format:
+ # global/images/my-custom-image
+ #
+ #
+ # You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:
+ # global/images/family/my-image-family
+ #
+ #
+ # If the source image is deleted later, this field will not be set.
+ "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.
+ "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.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ },
+ "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.
+ #
+ # To create a disk with a snapshot that you created, specify the snapshot name in the following format:
+ # global/snapshots/my-backup
+ #
+ #
+ # If the source snapshot is deleted later, this field will not be set.
+ "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.
+ "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+ #
+ # The key must meet the following requirements before you can provide it to Compute Engine:
+ # - The key is wrapped using a RSA public key certificate provided by Google.
+ # - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:
+ # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+ "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
+ },
+ },
+ "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
+ "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
+ "licenses": [ # [Output Only] Any valid publicly visible licenses.
+ "A String",
+ ],
+ "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
+ "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.
+ "shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk
+ "dbs": [ # The Key Database (db).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "dbxs": [ # The forbidden key database (dbx).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "keks": [ # The Key Exchange Key (KEK).
+ {
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ ],
+ "pk": { # The Platform Key (PK).
+ "content": "A String", # The raw content in the secure keys file.
+ "fileType": "A String", # The file type of source file.
+ },
+ },
+ "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
+ #
+ # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.
+ #
+ # Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
+ "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
+ },
+ ],
+ "displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer
+ "enableDisplay": True or False, # Defines whether the instance has Display enabled.
+ },
+ "guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.
+ { # A specification of the type and number of accelerator cards attached to the instance.
+ "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
+ "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
+ },
+ ],
+ "labels": { # Labels to apply to instances that are created from these properties.
+ "a_key": "A String",
+ },
+ "machineType": "A String", # The machine type to use for instances that are created from these properties.
+ "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.
+ #
+ # To see the latest fingerprint, make a get() request to retrieve the resource.
+ "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+ {
+ "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
+ "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+ },
+ ],
+ "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.
+ },
+ "minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.
+ "networkInterfaces": [ # An array of network access configurations for this interface.
+ { # A network interface resource attached to an instance.
+ "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+ { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+ "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.
+ "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.
+ "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
+ "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
+ #
+ # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.
+ #
+ # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
+ "publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.
+ "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.
+ "setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.
+ "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+ "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.
+ },
+ ],
+ "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+ { # An alias IP range attached to an instance's network interface.
+ "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
+ "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+ },
+ ],
+ "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.
+ "ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.
+ "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
+ "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.
+ "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.
+ #
+ # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+ # - projects/project/global/networks/network
+ # - global/networks/default
+ "networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
+ "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
+ # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
+ # - regions/region/subnetworks/subnetwork
+ },
+ ],
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
+ "privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.
+ "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
+ "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.
+ "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
+ "values": [ # Corresponds to the label values of a reservation resource.
+ "A String",
+ ],
+ },
+ "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.
+ "A String",
+ ],
+ "scheduling": { # Sets the scheduling options for an Instance. NextID: 13 # Specifies the scheduling options for the instances that are created from these properties.
+ "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.
+ "latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
+ "locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
+ "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
+ "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+ "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
+ { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+ "key": "A String", # Corresponds to the label key of Node resource.
+ "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
+ "values": [ # Corresponds to the label values of Node resource.
+ "A String",
+ ],
+ },
+ ],
+ "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
+ "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
+ },
+ "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
+ { # A service account.
+ "email": "A String", # Email address of the service account.
+ "scopes": [ # The list of scopes to be made available for this service account.
+ "A String",
+ ],
+ },
+ ],
+ "shieldedInstanceConfig": { # A set of Shielded Instance options.
+ "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.
+ "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.
+ "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.
+ },
+ "shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.
+ "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.
+ },
+ "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
+ "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.
+ #
+ # To see the latest fingerprint, make get() request to the instance.
+ "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+ "A String",
+ ],
+ },
+ },
"minCount": "A String", # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created.
"predefinedNames": [ # List of predefined names. The number of names provided must be equal to count.
"A String",
],
- "sourceInstanceTemplate": "A String", # Specifies the instance template from which to create the instance. This field is optional. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:
+ "sourceInstanceTemplate": "A String", # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396.
+ #
+ # It can be a full or partial URL. For example, the following are all valid URLs to an instance template:
# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
# - projects/project/global/instanceTemplates/instanceTemplate
# - global/instanceTemplates/instanceTemplate
+ #
+ # This field is optional.
}
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.
@@ -1584,6 +1900,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.
@@ -1835,6 +2156,10 @@
{ # Represents an Instance resource.
#
# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"confidentialInstanceConfig": { # A set of Confidential Instance options.
"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
@@ -1850,7 +2175,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.
#
@@ -1905,6 +2230,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -1930,7 +2256,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.
@@ -1951,7 +2277,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.
@@ -2018,7 +2344,7 @@
],
"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
#
# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
#
@@ -2109,12 +2435,13 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
},
],
- "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
@@ -2127,17 +2454,13 @@
"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.
+ "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
+ "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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -2152,6 +2475,9 @@
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
},
+ "secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.
+ "A String",
+ ],
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
@@ -2172,16 +2498,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.
@@ -2205,8 +2531,8 @@
],
},
"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.
- "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.
- "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.
+ "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
+ "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
"type": "A String", # Defines the type of maintenance.
},
"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
@@ -2339,7 +2665,7 @@
],
},
],
- "srcIpRanges": [ # CIDR IP address range.
+ "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
"A String",
],
},
@@ -2372,11 +2698,20 @@
"preview": True or False, # If set to true, the specified action is not enforced.
"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
"rateLimitOptions": { # Must be specified if the action is "rate_based_blacklist" or "throttle". Cannot be specified for any other actions.
- "blockDuration": 42, # Can only be specifed if the action for the rule is "rate_based_blacklist" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds.
+ "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+ "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+ "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+ "intervalSec": 42, # Interval over which the threshold is computed.
+ },
+ "blockDuration": 42, # Can only be specified if the action for the rule is "rate_based_ban" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. [Deprecated] This field is deprecated.
"conformAction": "A String", # Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload".
"enforceOnKey": "A String", # Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule.
"exceedAction": "A String", # When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.
- "thresholdRps": 42, # Rate in requests per second at which to begin ratelimiting.
+ "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+ "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+ "intervalSec": 42, # Interval over which the threshold is computed.
+ },
+ "thresholdRps": 42, # Rate in requests per second at which to begin ratelimiting. [Deprecated] This field is deprecated.
},
"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.
"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
@@ -2487,6 +2822,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.
@@ -2647,9 +2983,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:
@@ -2657,9 +2997,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>
@@ -2726,6 +3066,10 @@
{ # Represents an Instance resource.
#
# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"confidentialInstanceConfig": { # A set of Confidential Instance options.
"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
@@ -2741,7 +3085,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.
#
@@ -2796,6 +3140,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -2821,7 +3166,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.
@@ -2842,7 +3187,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.
@@ -2909,7 +3254,7 @@
],
"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
#
# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
#
@@ -3000,12 +3345,13 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
},
],
- "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
@@ -3018,17 +3364,13 @@
"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.
+ "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
+ "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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -3043,6 +3385,9 @@
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
},
+ "secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.
+ "A String",
+ ],
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
@@ -3063,16 +3408,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.
@@ -3096,8 +3441,8 @@
],
},
"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.
- "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.
- "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.
+ "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
+ "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
"type": "A String", # Defines the type of maintenance.
},
"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
@@ -3217,6 +3562,10 @@
{ # Represents an Instance resource.
#
# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"confidentialInstanceConfig": { # A set of Confidential Instance options.
"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
@@ -3232,7 +3581,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.
#
@@ -3287,6 +3636,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -3312,7 +3662,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.
@@ -3333,7 +3683,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.
@@ -3400,7 +3750,7 @@
],
"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
#
# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
#
@@ -3491,12 +3841,13 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
},
],
- "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
@@ -3509,17 +3860,13 @@
"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.
+ "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
+ "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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -3534,6 +3881,9 @@
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
},
+ "secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.
+ "A String",
+ ],
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
@@ -3554,16 +3904,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.
@@ -3587,8 +3937,8 @@
],
},
"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.
- "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.
- "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.
+ "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
+ "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
"type": "A String", # Defines the type of maintenance.
},
"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
@@ -3877,7 +4227,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.
@@ -3892,7 +4242,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.
@@ -4151,6 +4501,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.
@@ -4258,6 +4609,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.
@@ -4445,6 +4797,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.
@@ -5119,17 +5472,12 @@
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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -5732,7 +6080,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.
@@ -5747,7 +6095,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 start will not succeed.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
@@ -6033,6 +6381,10 @@
{ # Represents an Instance resource.
#
# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)
+ "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.
+ "enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
+ "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
+ },
"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
"confidentialInstanceConfig": { # A set of Confidential Instance options.
"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.
@@ -6048,7 +6400,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.
#
@@ -6103,6 +6455,7 @@
},
"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.
"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.
+ "provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.
"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
"A String",
],
@@ -6128,7 +6481,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.
@@ -6149,7 +6502,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.
@@ -6216,7 +6569,7 @@
],
"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- "instanceEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
+ "instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.
#
# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.
#
@@ -6307,12 +6660,13 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
},
],
- "postKeyRevocationActionType": "A String", # Specifies whether this instance will be shut down on key revocation.
+ "postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.
"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.
@@ -6325,17 +6679,13 @@
"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.
+ "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
+ "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.
"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.
"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
- "longTermRelease": True or False, # DEPRECATED, please use maintenance_freeze_duration_hours. TODO(b/154158138): Remove this field. Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
- #
- # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
- #
- # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.
"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
@@ -6350,6 +6700,9 @@
"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.
},
+ "secureLabels": [ # Secure labels to apply to this instance. These can be later modified by the update method. Maximum number of secure labels allowed is 300.
+ "A String",
+ ],
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
@@ -6370,16 +6723,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.
@@ -6403,8 +6756,8 @@
],
},
"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.
- "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format.
- "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format.
+ "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
+ "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.
"type": "A String", # Defines the type of maintenance.
},
"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
@@ -6722,6 +7075,7 @@
# - projects/project/global/networks/network
# - global/networks/default
"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+ "queueCount": 42, # The networking queue count for the network interface. Both Rx and Tx queues will be set to this number. If it's not specified by the user, a default number of queues will be assigned. For Virtio-net, each interface will get (min(#vCPU, 32) / #vNIC) queues. For gVNIC, each interface will get (min(#vCPU / 2, 16) / #vNIC) qeueus.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork