Close httplib2 connections.
delete(project, machineImage, requestId=None, x__xgafv=None)
Deletes the specified machine image. Deleting a machine image is permanent
get(project, machineImage, x__xgafv=None)
Returns the specified machine image.
getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. May be empty if no such
insert(project, body=None, requestId=None, sourceInstance=None, x__xgafv=None)
Creates a machine image in the specified project using the
Retrieves a list of machine images that are contained within
Retrieves the next page of results.
setIamPolicy(project, resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource.
setLabels(project, resource, body=None, x__xgafv=None)
Sets the labels on a machine image. To learn more about labels, read theLabeling
testIamPermissions(project, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
close()
Close httplib2 connections.
delete(project, machineImage, requestId=None, x__xgafv=None)
Deletes the specified machine image. Deleting a machine image is permanent
and cannot be undone.
Args:
project: string, Project ID for this request. (required)
machineImage: string, The name of the machine image to delete. (required)
requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Operation resource.
#
# Google Compute Engine has three Operation resources:
#
# * [Global](/compute/docs/reference/rest/v1/globalOperations)
# * [Regional](/compute/docs/reference/rest/v1/regionOperations)
# * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
#
# You can use an operation resource to manage asynchronous API requests.
# For more information, readHandling
# API responses.
#
# Operations can be global, regional or zonal.
#
# - For global operations, use the `globalOperations`
# resource.
# - For regional operations, use the
# `regionOperations` resource.
# - For zonal operations, use
# the `zoneOperations` resource.
#
#
#
# For more information, read
# Global, Regional, and Zonal Resources.
#
# Note that completed Operation resources have a limited
# retention period.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
# Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is
# set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
# text format.
"error": { # [Output Only] If errors are generated during processing of the operation,
# this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this
# operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
"errorDetails": [ # [Output Only] An optional list of messages that contain the error
# details. There is a set of defined message types to use for providing
# details.The syntax depends on the error code. For example,
# QuotaExceededInfo will have details when the error code is
# QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details.
#
# Example of an error when contacting the "pubsub.googleapis.com" API when it
# is not enabled:
#
# { "reason": "API_DISABLED"
# "domain": "googleapis.com"
# "metadata": {
# "resource": "projects/123",
# "service": "pubsub.googleapis.com"
# }
# }
#
# This response indicates that the pubsub.googleapis.com API is not enabled.
#
# Example of an error that is returned when attempting to create a Spanner
# instance in a region that is out of stock:
#
# { "reason": "STOCKOUT"
# "domain": "spanner.googleapis.com",
# "metadata": {
# "availableRegions": "us-central1,us-east2"
# }
# }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
# is typically the registered service name of the tool or product that
# generates the error. Example: "pubsub.googleapis.com". If the error is
# generated by some common infrastructure, the error domain must be a
# globally unique value that identifies the infrastructure. For Google API
# infrastructure, the error domain is "googleapis.com".
"metadatas": { # Additional structured details about this error.
#
# Keys must match a regular expression of `a-z+` but should
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in
# length. When identifying the current value of an exceeded limit, the units
# should be contained in the key, not the value. For example, rather than
# `{"instanceLimit": "100/request"}`, should be returned as,
# `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
# instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the
# proximate cause of the error. Error reasons are unique within a particular
# domain of errors. This should be at most 63 characters and match a
# regular expression of `A-Z+[A-Z0-9]`, which represents
# UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action.
#
# For example, if a quota check failed with an error indicating the calling
# project hasn't enabled the accessed service, this can contain a URL pointing
# directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user
# which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
# Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
# type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
# or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error.
# This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
# operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
}
get(project, machineImage, x__xgafv=None)
Returns the specified machine image.
Args:
project: string, Project ID for this request. (required)
machineImage: string, The name of the machine image. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a machine image resource.
#
# A machine image is a Compute Engine resource that stores all the
# configuration, metadata, permissions, and data from one or more disks
# required to create a Virtual machine (VM) instance. For more information, seeMachine images.
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this machine image inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"guestFlush": True or False, # [Input Only] Whether to attempt an application consistent machine image by
# informing the OS to prepare for the snapshot process.
"id": "A String", # [Output Only] A unique identifier for this machine image. The server
# defines this identifier.
"instanceProperties": { # [Output Only] Properties of source instance
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
# Note that for MachineImage, this is not supported yet.
# 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 anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
# disabled).
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.
"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance.
"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.
"turboMode": "A String", # Turbo frequency mode to use for the instance.
# Supported modes include:
# * ALL_CORE_MAX
#
# Using empty string or not setting this field will use the platform-specific
# default turbo mode.
"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by
# the number of threads per core to compute the total number of virtual
# CPUs to expose to the instance. If unset, the number of cores is
# inferred from the instance's nominal CPU count and the underlying
# platform's SMT width.
},
"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 tofalse. See theEnable IP forwarding
# documentation for more information.
"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
# Note that for MachineImage, this is not supported yet.
"confidentialInstanceType": "A String", # Defines the type of technology used by the confidential instance.
"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.
"architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
# or X86_64.
"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 acustomer-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.
#
# Note:
#
# Instance templates do not storecustomer-supplied
# encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
#
# You cannot create VMs that have disks with customer-supplied keys using
# the bulk
# insert method.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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.
"forceAttach": True or False, # [Input Only] 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.
"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. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"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 # [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.
# alongside the new instance. Use initialization parameters to create boot
# disks or local SSDs attached to the new instance.
#
# This field is persisted and returned for instanceTemplate and not returned
# in the context of instance.
#
# This property is mutually exclusive with the source property;
# you can only define one or the other, but not both.
"architecture": "A String", # The architecture of the attached disk. Valid values are
# arm64 or x86_64.
"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
#
#
# For a full list of acceptable values, seePersistent disk
# types. If you specify this field when creating a VM, you can provide
# either the full or partial URL. For example, the following values are
# valid:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
# - projects/project/zones/zone/diskTypes/diskType
# - zones/zone/diskTypes/diskType
#
#
# If you specify this field when creating or updating an instance template
# or all-instances configuration, specify the type of the disk, not the
# URL. For example: pd-standard.
"enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
"labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
# persistent disks.
"a_key": "A String",
},
"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
"A String",
],
"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 to provision for the disk. This sets the number
# of I/O operations per second that the disk can handle. Values must be
# between 10,000 and 120,000. For more details, see theExtreme persistent
# disk documentation.
"provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
# number of throughput mb per second that the disk can handle. Values must
# greater than or equal to 1.
"replicaZones": [ # Required for each regional disk associated with the instance. Specify
# the URLs of the zones where the disk should be replicated to.
# You must provide exactly two replica zones, and one zone must be the same
# as the instance zone.
"A String",
],
"resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT
# & PATCH) when empty.
"a_key": "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 boot
# disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
# is required.
#
# To create a disk with one of the public operating system
# images, specify the image by its family name. For example, specifyfamily/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": { # Thecustomer-supplied
# encryption key of the source image. Required if the source image is
# protected by a customer-supplied encryption key.
#
# InstanceTemplate and InstancePropertiesPatch do not storecustomer-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.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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
# boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
# is required.
#
# 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.
#
# Note: You cannot create VMs in bulk using a snapshot as the source. Use
# an image instead when you create VMs using
# the bulk
# insert method.
"sourceSnapshotEncryptionKey": { # Thecustomer-supplied
# encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"storagePool": "A String", # The storage pool in which the new disk is created. You can provide
# this as a partial or full URL to the resource. For example, the following
# are valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
# - projects/project/zones/zone/storagePools/storagePool
# - zones/zone/storagePools/storagePool
},
"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
# either SCSI or NVME. For most machine types, the
# default is SCSI. Local SSDs can use either NVME or SCSI.
# In certain configurations, persistent disks can use NVMe. For more
# information, seeAbout
# persistent disks.
"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#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 orREAD_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, # [Output Only] shielded vm initial state stored on disk
# these are public keys which are safe to store in public
"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 boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
# is required.
#
# 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 for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
},
],
"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.
},
],
"keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and
# "NONE". The default value is "NONE" if it is not specified.
"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.
# This field only accepts a machine type name, for example `n2-standard-4`.
# If you use the machine type full or partial URL, for example
# `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
# the request will result in an `INTERNAL_ERROR`.
"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. SeeProject 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 error412 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.
{ # Metadata
"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 asminCpuPlatform: "Intel Haswell" orminCpuPlatform: "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 noaccessConfigs 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.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"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 as10.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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
"internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
# one IPv6 access config, DIRECT_IPV6, is supported. If there
# is no ipv6AccessConfig specified, then this instance will
# have no external IPv6 Internet access.
{ # An access configuration attached to an instance's network interface.
# Only one access config per instance is supported.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
# accessed from the Internet. This field is always inherited from its
# subnetwork.
#
# Valid only if stackType is IPV4_IPV6.
"ipv6Address": "A String", # An IPv6 internal network address for this network interface. To
# use a static internal IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an internal IPv6 address from the instance's subnetwork.
"kind": "compute#networkInterface", # [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
"name": "A String", # [Output Only] The name of the network interface, which is generated by the
# server. For a VM, the network interface uses the nicN naming
# format. Where N is a value between 0 and7. The default interface value is nic0.
"network": "A String", # URL of the VPC 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
# selected project doesn't have the default network, you must specify a
# network or subnet. 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
"networkAttachment": "A String", # The URL of the network attachment that this interface should connect
# to in the following format:
# projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"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.
"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or
# VirtioNet.
"parentNicName": "A String", # Name of the parent network interface of a dynamic network interface.
"queueCount": 42, # The networking queue count that's specified by users for the network
# interface. Both Rx and Tx queues will be set to this number. It'll be empty
# if not specified by the users.
"stackType": "A String", # The stack type for this network interface. To assign only IPv4 addresses,
# use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
#
# This field can be both set at instance creation and update network
# interface operations.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network
# resource is inlegacy
# 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
"vlan": 42, # VLAN tag of a dynamic network interface, must be an integer in the range
# from 2 to 255 inclusively.
},
],
"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet.
"totalEgressBandwidthTier": "A String",
},
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs.
# If not specified, use INHERIT_FROM_SUBNETWORK as default.
# Note that for MachineImage, this is not supported yet.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
# Note that for MachineImage, this is not supported yet.
"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 aSPECIFIC_RESERVATION by name, specifygoogleapis.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. This can be
# either a name to a reservation in the same project or
# "projects/different-project/reservations/some-reservation-name" to target a
# shared reservation in the same zone but in a different project.
"A String",
],
},
"resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
# PATCH) when empty.
"a_key": "A String",
},
"resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from
# these properties.
# Note that for MachineImage, this is not supported yet.
"A String",
],
"scheduling": { # Sets the scheduling options for an Instance. # 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.
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value
# must be a number between 1 and the number of availability domains
# specified in the spread placement policy attached to the instance.
"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be
# within the range of [90, 330] with the increment of 30, if unset, the
# default behavior of host error recovery will be used.
"instanceTerminationAction": "A String", # Specifies the termination action for the instance.
"localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
# recovery of the Local Ssd state is attempted. Its value should be in
# between 0 and 168 hours with hour granularity and the default value being 1
# hour.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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.
"maxRunDuration": { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
# the instance termination action will be performed at the end of the run
# duration.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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 toConfiguring 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 areIN 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. Forpreemptible instances,
# the default and only possible behavior is TERMINATE. For more
# information, see
# Set
# VM host maintenance policy.
"onInstanceStopAction": { # Defines the behaviour for instances with the instance_termination_actionSTOP.
"discardLocalSsd": True or False, # If true, the contents of any attached Local SSD disks will be discarded
# else, the Local SSD data will be preserved when the instance is stopped
# at the end of the run duration/termination time.
},
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
# Off for Standard VMs and 30 seconds for Spot VMs.
"terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
# termination action will be performed at the termination time.
},
"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. # Note that for MachineImage, this is not supported yet.
"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.
},
"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",
],
},
},
"kind": "compute#machineImage", # [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
# essentially a hash of the labels set used for optimistic locking. The
# fingerprint is initially generated by Compute Engine and changes after
# every request to modify or update labels. You must always provide an
# up-to-date fingerprint hash in order to update or change labels.
#
# To see the latest fingerprint, make get() request to the
# machine image.
"labels": { # Labels to apply to this machine image. These can be later modified by
# the setLabels method.
"a_key": "A String",
},
"machineImageEncryptionKey": { # Encrypts the machine image using acustomer-supplied
# encryption key.
#
# After you encrypt a machine image using a customer-supplied key, you must
# provide the same key if you use the machine image later. For example, you
# must provide the encryption key when you create an instance from the
# encrypted machine image in a future request.
#
# Customer-supplied encryption keys do not protect access to metadata of the
# machine image.
#
# If you do not provide an encryption key when creating the machine image,
# then the machine image will be encrypted using an automatically generated
# key and you do not need to provide a key to use the machine image later.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"name": "A String", # Name of the resource; provided by the client when the resource is created.
# The name must be 1-63 characters long, and comply withRFC1035.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"savedDisks": [ # An array of Machine Image specific properties for disks attached to the
# source instance
{ # An instance-attached disk resource.
"architecture": "A String", # [Output Only] The architecture of the attached disk.
"kind": "compute#savedDisk", # [Output Only] Type of the resource. Always compute#savedDisk
# for attached disks.
"sourceDisk": "A String", # Specifies a URL of the disk attached to the source instance.
"storageBytes": "A String", # [Output Only] Size of the individual disk snapshot used by this machine
# image.
"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a
# stable state or it is being adjusted as a result of shared storage
# reallocation. This status can either be UPDATING, meaning
# the size of the snapshot is being updated, or UP_TO_DATE,
# meaning the size of the snapshot is up-to-date.
},
],
"selfLink": "A String", # [Output Only] The URL for this machine image. The server defines this URL.
"sourceDiskEncryptionKeys": [ # [Input Only] Thecustomer-supplied
# encryption key of the disks attached to the source instance. Required
# if the source disk is protected by a customer-supplied encryption key.
{
"diskEncryptionKey": { # Thecustomer-supplied
# encryption key of the source disk. Required if the source disk is
# protected by a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"sourceDisk": "A String", # URL of the disk attached to the source instance. This can be a full or
# valid partial URL. For example, the following are valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
},
],
"sourceInstance": "A String", # The source instance used to create the machine image. You can provide this
# as a partial or full URL to the resource. For example, the following are
# valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
# - projects/project/zones/zone/instances/instance
"sourceInstanceProperties": { # DEPRECATED: Please use compute#instanceProperties instead. # [Output Only] DEPRECATED: Please use instance_properties
# instead for source instance related properties. New properties will not be
# added to this field.
# New properties will not be added to this field.
"canIpForward": True or False, # Enables instances created based on this machine image 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 tofalse. See theEnable IP forwarding
# documentation for more information.
"deletionProtection": True or False, # Whether the instance created from this machine image should be protected
# against deletion.
"description": "A String", # An optional text description for the instances that are created from this
# machine image.
"disks": [ # An array of disks that are associated with the instances that are created
# from this machine image.
{ # DEPRECATED: Please use compute#savedDisk instead.
# 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 the name of the disk attached to the source instance.
"diskEncryptionKey": { # The encryption key for the disk.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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 base-2 GB.
"diskType": "A String", # [Output Only] URL of the disk type resource. For example:projects/project/zones/zone/diskTypes/pd-standard or
# pd-ssd
"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. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"index": 42, # Specifies zero-based index of the disk that is attached to the source
# instance.
"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
# either SCSI or NVME.
"kind": "compute#savedAttachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
"licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
"mode": "A String", # The mode in which this disk is attached to the source instance, eitherREAD_WRITE or READ_ONLY.
"source": "A String", # Specifies a URL of the disk attached to the source instance.
"storageBytes": "A String", # [Output Only] A size of the storage used by the disk's snapshot by this
# machine image.
"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a
# stable state or it is being adjusted as a result of shared storage
# reallocation. This status can either be UPDATING, meaning
# the size of the snapshot is being updated, or UP_TO_DATE,
# meaning the size of the snapshot is up-to-date.
"type": "A String", # Specifies the type of the attached disk, either SCRATCH orPERSISTENT.
},
],
"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances
# created from this machine image.
{ # 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.
},
],
"keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and
# "NONE". The default value is "NONE" if it is not specified.
"labels": { # Labels to apply to instances that are created from this machine image.
"a_key": "A String",
},
"machineType": "A String", # The machine type to use for instances that are created from this machine
# image.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
# this machine image. These pairs can consist of custom metadata or
# predefined keys. SeeProject 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 error412 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.
{ # Metadata
"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 created from this machine
# image. 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" orminCpuPlatform: "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 noaccessConfigs 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.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"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 as10.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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
"internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
# one IPv6 access config, DIRECT_IPV6, is supported. If there
# is no ipv6AccessConfig specified, then this instance will
# have no external IPv6 Internet access.
{ # An access configuration attached to an instance's network interface.
# Only one access config per instance is supported.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
# accessed from the Internet. This field is always inherited from its
# subnetwork.
#
# Valid only if stackType is IPV4_IPV6.
"ipv6Address": "A String", # An IPv6 internal network address for this network interface. To
# use a static internal IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an internal IPv6 address from the instance's subnetwork.
"kind": "compute#networkInterface", # [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
"name": "A String", # [Output Only] The name of the network interface, which is generated by the
# server. For a VM, the network interface uses the nicN naming
# format. Where N is a value between 0 and7. The default interface value is nic0.
"network": "A String", # URL of the VPC 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
# selected project doesn't have the default network, you must specify a
# network or subnet. 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
"networkAttachment": "A String", # The URL of the network attachment that this interface should connect
# to in the following format:
# projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"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.
"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or
# VirtioNet.
"parentNicName": "A String", # Name of the parent network interface of a dynamic network interface.
"queueCount": 42, # The networking queue count that's specified by users for the network
# interface. Both Rx and Tx queues will be set to this number. It'll be empty
# if not specified by the users.
"stackType": "A String", # The stack type for this network interface. To assign only IPv4 addresses,
# use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
#
# This field can be both set at instance creation and update network
# interface operations.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network
# resource is inlegacy
# 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
"vlan": 42, # VLAN tag of a dynamic network interface, must be an integer in the range
# from 2 to 255 inclusively.
},
],
"scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
# this machine image.
"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.
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value
# must be a number between 1 and the number of availability domains
# specified in the spread placement policy attached to the instance.
"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be
# within the range of [90, 330] with the increment of 30, if unset, the
# default behavior of host error recovery will be used.
"instanceTerminationAction": "A String", # Specifies the termination action for the instance.
"localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
# recovery of the Local Ssd state is attempted. Its value should be in
# between 0 and 168 hours with hour granularity and the default value being 1
# hour.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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.
"maxRunDuration": { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
# the instance termination action will be performed at the end of the run
# duration.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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 toConfiguring 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 areIN 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. Forpreemptible instances,
# the default and only possible behavior is TERMINATE. For more
# information, see
# Set
# VM host maintenance policy.
"onInstanceStopAction": { # Defines the behaviour for instances with the instance_termination_actionSTOP.
"discardLocalSsd": True or False, # If true, the contents of any attached Local SSD disks will be discarded
# else, the Local SSD data will be preserved when the instance is stopped
# at the end of the run duration/termination time.
},
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
# Off for Standard VMs and 30 seconds for Spot VMs.
"terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
# termination action will be performed at the termination time.
},
"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these
# service accounts are available to the instances that are created from this
# machine image. 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",
],
},
],
"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this machine
# image. 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 withRFC1035.
"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",
],
},
},
"status": "A String", # [Output Only] The status of the machine image. One of the following values:INVALID, CREATING, READY,DELETING, and UPLOADING.
"storageLocations": [ # The regional or multi-regional Cloud Storage bucket location where themachine image is
# stored.
"A String",
],
"totalStorageBytes": "A String", # [Output Only] Total size of the storage used by the machine image.
}
getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. May be empty if no such
policy or resource exists.
Args:
project: string, Project ID for this request. (required)
resource: string, Name or id of the resource for this request. (required)
optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members`, or principals, to a single `role`. Principals can be user
# accounts, service accounts, Google groups, and domains (such as G Suite). A
# `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# ```
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
# ```
#
# **YAML example:**
#
# ```
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# etag: BwWWja0YfJA=
# version: 3
# ```
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# },
# {
# "log_type": "ADMIN_READ"
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
# `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with 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 principal.
#
# The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
# of these principals can be Google groups. Each occurrence of a principal
# counts towards these limits. For example, if the `bindings` grant 50
# different roles to `user:alice@example.com`, and not to any other
# principal, then you can add another 1,450 principals to the `bindings` in
# the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
insert(project, body=None, requestId=None, sourceInstance=None, x__xgafv=None)
Creates a machine image in the specified project using the
data that is included in the request. If you are creating a new machine
image to update an existing instance, your new machine image should use the
same network or, if applicable, the same subnetwork as the original
instance.
Args:
project: string, Project ID for this request. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a machine image resource.
#
# A machine image is a Compute Engine resource that stores all the
# configuration, metadata, permissions, and data from one or more disks
# required to create a Virtual machine (VM) instance. For more information, seeMachine images.
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this machine image inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"guestFlush": True or False, # [Input Only] Whether to attempt an application consistent machine image by
# informing the OS to prepare for the snapshot process.
"id": "A String", # [Output Only] A unique identifier for this machine image. The server
# defines this identifier.
"instanceProperties": { # [Output Only] Properties of source instance
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
# Note that for MachineImage, this is not supported yet.
# 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 anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
# disabled).
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.
"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance.
"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.
"turboMode": "A String", # Turbo frequency mode to use for the instance.
# Supported modes include:
# * ALL_CORE_MAX
#
# Using empty string or not setting this field will use the platform-specific
# default turbo mode.
"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by
# the number of threads per core to compute the total number of virtual
# CPUs to expose to the instance. If unset, the number of cores is
# inferred from the instance's nominal CPU count and the underlying
# platform's SMT width.
},
"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 tofalse. See theEnable IP forwarding
# documentation for more information.
"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
# Note that for MachineImage, this is not supported yet.
"confidentialInstanceType": "A String", # Defines the type of technology used by the confidential instance.
"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.
"architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
# or X86_64.
"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 acustomer-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.
#
# Note:
#
# Instance templates do not storecustomer-supplied
# encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
#
# You cannot create VMs that have disks with customer-supplied keys using
# the bulk
# insert method.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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.
"forceAttach": True or False, # [Input Only] 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.
"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. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"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 # [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.
# alongside the new instance. Use initialization parameters to create boot
# disks or local SSDs attached to the new instance.
#
# This field is persisted and returned for instanceTemplate and not returned
# in the context of instance.
#
# This property is mutually exclusive with the source property;
# you can only define one or the other, but not both.
"architecture": "A String", # The architecture of the attached disk. Valid values are
# arm64 or x86_64.
"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
#
#
# For a full list of acceptable values, seePersistent disk
# types. If you specify this field when creating a VM, you can provide
# either the full or partial URL. For example, the following values are
# valid:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
# - projects/project/zones/zone/diskTypes/diskType
# - zones/zone/diskTypes/diskType
#
#
# If you specify this field when creating or updating an instance template
# or all-instances configuration, specify the type of the disk, not the
# URL. For example: pd-standard.
"enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
"labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
# persistent disks.
"a_key": "A String",
},
"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
"A String",
],
"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 to provision for the disk. This sets the number
# of I/O operations per second that the disk can handle. Values must be
# between 10,000 and 120,000. For more details, see theExtreme persistent
# disk documentation.
"provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
# number of throughput mb per second that the disk can handle. Values must
# greater than or equal to 1.
"replicaZones": [ # Required for each regional disk associated with the instance. Specify
# the URLs of the zones where the disk should be replicated to.
# You must provide exactly two replica zones, and one zone must be the same
# as the instance zone.
"A String",
],
"resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT
# & PATCH) when empty.
"a_key": "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 boot
# disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
# is required.
#
# To create a disk with one of the public operating system
# images, specify the image by its family name. For example, specifyfamily/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": { # Thecustomer-supplied
# encryption key of the source image. Required if the source image is
# protected by a customer-supplied encryption key.
#
# InstanceTemplate and InstancePropertiesPatch do not storecustomer-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.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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
# boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
# is required.
#
# 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.
#
# Note: You cannot create VMs in bulk using a snapshot as the source. Use
# an image instead when you create VMs using
# the bulk
# insert method.
"sourceSnapshotEncryptionKey": { # Thecustomer-supplied
# encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"storagePool": "A String", # The storage pool in which the new disk is created. You can provide
# this as a partial or full URL to the resource. For example, the following
# are valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
# - projects/project/zones/zone/storagePools/storagePool
# - zones/zone/storagePools/storagePool
},
"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
# either SCSI or NVME. For most machine types, the
# default is SCSI. Local SSDs can use either NVME or SCSI.
# In certain configurations, persistent disks can use NVMe. For more
# information, seeAbout
# persistent disks.
"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#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 orREAD_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, # [Output Only] shielded vm initial state stored on disk
# these are public keys which are safe to store in public
"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 boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
# is required.
#
# 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 for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
},
],
"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.
},
],
"keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and
# "NONE". The default value is "NONE" if it is not specified.
"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.
# This field only accepts a machine type name, for example `n2-standard-4`.
# If you use the machine type full or partial URL, for example
# `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
# the request will result in an `INTERNAL_ERROR`.
"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. SeeProject 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 error412 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.
{ # Metadata
"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 asminCpuPlatform: "Intel Haswell" orminCpuPlatform: "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 noaccessConfigs 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.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"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 as10.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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
"internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
# one IPv6 access config, DIRECT_IPV6, is supported. If there
# is no ipv6AccessConfig specified, then this instance will
# have no external IPv6 Internet access.
{ # An access configuration attached to an instance's network interface.
# Only one access config per instance is supported.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
# accessed from the Internet. This field is always inherited from its
# subnetwork.
#
# Valid only if stackType is IPV4_IPV6.
"ipv6Address": "A String", # An IPv6 internal network address for this network interface. To
# use a static internal IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an internal IPv6 address from the instance's subnetwork.
"kind": "compute#networkInterface", # [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
"name": "A String", # [Output Only] The name of the network interface, which is generated by the
# server. For a VM, the network interface uses the nicN naming
# format. Where N is a value between 0 and7. The default interface value is nic0.
"network": "A String", # URL of the VPC 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
# selected project doesn't have the default network, you must specify a
# network or subnet. 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
"networkAttachment": "A String", # The URL of the network attachment that this interface should connect
# to in the following format:
# projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"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.
"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or
# VirtioNet.
"parentNicName": "A String", # Name of the parent network interface of a dynamic network interface.
"queueCount": 42, # The networking queue count that's specified by users for the network
# interface. Both Rx and Tx queues will be set to this number. It'll be empty
# if not specified by the users.
"stackType": "A String", # The stack type for this network interface. To assign only IPv4 addresses,
# use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
#
# This field can be both set at instance creation and update network
# interface operations.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network
# resource is inlegacy
# 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
"vlan": 42, # VLAN tag of a dynamic network interface, must be an integer in the range
# from 2 to 255 inclusively.
},
],
"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet.
"totalEgressBandwidthTier": "A String",
},
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs.
# If not specified, use INHERIT_FROM_SUBNETWORK as default.
# Note that for MachineImage, this is not supported yet.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
# Note that for MachineImage, this is not supported yet.
"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 aSPECIFIC_RESERVATION by name, specifygoogleapis.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. This can be
# either a name to a reservation in the same project or
# "projects/different-project/reservations/some-reservation-name" to target a
# shared reservation in the same zone but in a different project.
"A String",
],
},
"resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
# PATCH) when empty.
"a_key": "A String",
},
"resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from
# these properties.
# Note that for MachineImage, this is not supported yet.
"A String",
],
"scheduling": { # Sets the scheduling options for an Instance. # 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.
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value
# must be a number between 1 and the number of availability domains
# specified in the spread placement policy attached to the instance.
"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be
# within the range of [90, 330] with the increment of 30, if unset, the
# default behavior of host error recovery will be used.
"instanceTerminationAction": "A String", # Specifies the termination action for the instance.
"localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
# recovery of the Local Ssd state is attempted. Its value should be in
# between 0 and 168 hours with hour granularity and the default value being 1
# hour.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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.
"maxRunDuration": { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
# the instance termination action will be performed at the end of the run
# duration.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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 toConfiguring 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 areIN 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. Forpreemptible instances,
# the default and only possible behavior is TERMINATE. For more
# information, see
# Set
# VM host maintenance policy.
"onInstanceStopAction": { # Defines the behaviour for instances with the instance_termination_actionSTOP.
"discardLocalSsd": True or False, # If true, the contents of any attached Local SSD disks will be discarded
# else, the Local SSD data will be preserved when the instance is stopped
# at the end of the run duration/termination time.
},
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
# Off for Standard VMs and 30 seconds for Spot VMs.
"terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
# termination action will be performed at the termination time.
},
"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. # Note that for MachineImage, this is not supported yet.
"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.
},
"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",
],
},
},
"kind": "compute#machineImage", # [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
# essentially a hash of the labels set used for optimistic locking. The
# fingerprint is initially generated by Compute Engine and changes after
# every request to modify or update labels. You must always provide an
# up-to-date fingerprint hash in order to update or change labels.
#
# To see the latest fingerprint, make get() request to the
# machine image.
"labels": { # Labels to apply to this machine image. These can be later modified by
# the setLabels method.
"a_key": "A String",
},
"machineImageEncryptionKey": { # Encrypts the machine image using acustomer-supplied
# encryption key.
#
# After you encrypt a machine image using a customer-supplied key, you must
# provide the same key if you use the machine image later. For example, you
# must provide the encryption key when you create an instance from the
# encrypted machine image in a future request.
#
# Customer-supplied encryption keys do not protect access to metadata of the
# machine image.
#
# If you do not provide an encryption key when creating the machine image,
# then the machine image will be encrypted using an automatically generated
# key and you do not need to provide a key to use the machine image later.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"name": "A String", # Name of the resource; provided by the client when the resource is created.
# The name must be 1-63 characters long, and comply withRFC1035.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"savedDisks": [ # An array of Machine Image specific properties for disks attached to the
# source instance
{ # An instance-attached disk resource.
"architecture": "A String", # [Output Only] The architecture of the attached disk.
"kind": "compute#savedDisk", # [Output Only] Type of the resource. Always compute#savedDisk
# for attached disks.
"sourceDisk": "A String", # Specifies a URL of the disk attached to the source instance.
"storageBytes": "A String", # [Output Only] Size of the individual disk snapshot used by this machine
# image.
"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a
# stable state or it is being adjusted as a result of shared storage
# reallocation. This status can either be UPDATING, meaning
# the size of the snapshot is being updated, or UP_TO_DATE,
# meaning the size of the snapshot is up-to-date.
},
],
"selfLink": "A String", # [Output Only] The URL for this machine image. The server defines this URL.
"sourceDiskEncryptionKeys": [ # [Input Only] Thecustomer-supplied
# encryption key of the disks attached to the source instance. Required
# if the source disk is protected by a customer-supplied encryption key.
{
"diskEncryptionKey": { # Thecustomer-supplied
# encryption key of the source disk. Required if the source disk is
# protected by a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"sourceDisk": "A String", # URL of the disk attached to the source instance. This can be a full or
# valid partial URL. For example, the following are valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
},
],
"sourceInstance": "A String", # The source instance used to create the machine image. You can provide this
# as a partial or full URL to the resource. For example, the following are
# valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
# - projects/project/zones/zone/instances/instance
"sourceInstanceProperties": { # DEPRECATED: Please use compute#instanceProperties instead. # [Output Only] DEPRECATED: Please use instance_properties
# instead for source instance related properties. New properties will not be
# added to this field.
# New properties will not be added to this field.
"canIpForward": True or False, # Enables instances created based on this machine image 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 tofalse. See theEnable IP forwarding
# documentation for more information.
"deletionProtection": True or False, # Whether the instance created from this machine image should be protected
# against deletion.
"description": "A String", # An optional text description for the instances that are created from this
# machine image.
"disks": [ # An array of disks that are associated with the instances that are created
# from this machine image.
{ # DEPRECATED: Please use compute#savedDisk instead.
# 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 the name of the disk attached to the source instance.
"diskEncryptionKey": { # The encryption key for the disk.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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 base-2 GB.
"diskType": "A String", # [Output Only] URL of the disk type resource. For example:projects/project/zones/zone/diskTypes/pd-standard or
# pd-ssd
"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. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"index": 42, # Specifies zero-based index of the disk that is attached to the source
# instance.
"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
# either SCSI or NVME.
"kind": "compute#savedAttachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
"licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
"mode": "A String", # The mode in which this disk is attached to the source instance, eitherREAD_WRITE or READ_ONLY.
"source": "A String", # Specifies a URL of the disk attached to the source instance.
"storageBytes": "A String", # [Output Only] A size of the storage used by the disk's snapshot by this
# machine image.
"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a
# stable state or it is being adjusted as a result of shared storage
# reallocation. This status can either be UPDATING, meaning
# the size of the snapshot is being updated, or UP_TO_DATE,
# meaning the size of the snapshot is up-to-date.
"type": "A String", # Specifies the type of the attached disk, either SCRATCH orPERSISTENT.
},
],
"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances
# created from this machine image.
{ # 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.
},
],
"keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and
# "NONE". The default value is "NONE" if it is not specified.
"labels": { # Labels to apply to instances that are created from this machine image.
"a_key": "A String",
},
"machineType": "A String", # The machine type to use for instances that are created from this machine
# image.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
# this machine image. These pairs can consist of custom metadata or
# predefined keys. SeeProject 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 error412 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.
{ # Metadata
"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 created from this machine
# image. 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" orminCpuPlatform: "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 noaccessConfigs 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.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"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 as10.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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
"internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
# one IPv6 access config, DIRECT_IPV6, is supported. If there
# is no ipv6AccessConfig specified, then this instance will
# have no external IPv6 Internet access.
{ # An access configuration attached to an instance's network interface.
# Only one access config per instance is supported.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
# accessed from the Internet. This field is always inherited from its
# subnetwork.
#
# Valid only if stackType is IPV4_IPV6.
"ipv6Address": "A String", # An IPv6 internal network address for this network interface. To
# use a static internal IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an internal IPv6 address from the instance's subnetwork.
"kind": "compute#networkInterface", # [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
"name": "A String", # [Output Only] The name of the network interface, which is generated by the
# server. For a VM, the network interface uses the nicN naming
# format. Where N is a value between 0 and7. The default interface value is nic0.
"network": "A String", # URL of the VPC 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
# selected project doesn't have the default network, you must specify a
# network or subnet. 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
"networkAttachment": "A String", # The URL of the network attachment that this interface should connect
# to in the following format:
# projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"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.
"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or
# VirtioNet.
"parentNicName": "A String", # Name of the parent network interface of a dynamic network interface.
"queueCount": 42, # The networking queue count that's specified by users for the network
# interface. Both Rx and Tx queues will be set to this number. It'll be empty
# if not specified by the users.
"stackType": "A String", # The stack type for this network interface. To assign only IPv4 addresses,
# use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
#
# This field can be both set at instance creation and update network
# interface operations.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network
# resource is inlegacy
# 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
"vlan": 42, # VLAN tag of a dynamic network interface, must be an integer in the range
# from 2 to 255 inclusively.
},
],
"scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
# this machine image.
"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.
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value
# must be a number between 1 and the number of availability domains
# specified in the spread placement policy attached to the instance.
"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be
# within the range of [90, 330] with the increment of 30, if unset, the
# default behavior of host error recovery will be used.
"instanceTerminationAction": "A String", # Specifies the termination action for the instance.
"localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
# recovery of the Local Ssd state is attempted. Its value should be in
# between 0 and 168 hours with hour granularity and the default value being 1
# hour.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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.
"maxRunDuration": { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
# the instance termination action will be performed at the end of the run
# duration.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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 toConfiguring 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 areIN 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. Forpreemptible instances,
# the default and only possible behavior is TERMINATE. For more
# information, see
# Set
# VM host maintenance policy.
"onInstanceStopAction": { # Defines the behaviour for instances with the instance_termination_actionSTOP.
"discardLocalSsd": True or False, # If true, the contents of any attached Local SSD disks will be discarded
# else, the Local SSD data will be preserved when the instance is stopped
# at the end of the run duration/termination time.
},
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
# Off for Standard VMs and 30 seconds for Spot VMs.
"terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
# termination action will be performed at the termination time.
},
"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these
# service accounts are available to the instances that are created from this
# machine image. 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",
],
},
],
"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this machine
# image. 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 withRFC1035.
"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",
],
},
},
"status": "A String", # [Output Only] The status of the machine image. One of the following values:INVALID, CREATING, READY,DELETING, and UPLOADING.
"storageLocations": [ # The regional or multi-regional Cloud Storage bucket location where themachine image is
# stored.
"A String",
],
"totalStorageBytes": "A String", # [Output Only] Total size of the storage used by the machine image.
}
requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.
The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
sourceInstance: string, Required. Source instance that is used to create the machine image from.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Operation resource.
#
# Google Compute Engine has three Operation resources:
#
# * [Global](/compute/docs/reference/rest/v1/globalOperations)
# * [Regional](/compute/docs/reference/rest/v1/regionOperations)
# * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
#
# You can use an operation resource to manage asynchronous API requests.
# For more information, readHandling
# API responses.
#
# Operations can be global, regional or zonal.
#
# - For global operations, use the `globalOperations`
# resource.
# - For regional operations, use the
# `regionOperations` resource.
# - For zonal operations, use
# the `zoneOperations` resource.
#
#
#
# For more information, read
# Global, Regional, and Zonal Resources.
#
# Note that completed Operation resources have a limited
# retention period.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
# Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is
# set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
# text format.
"error": { # [Output Only] If errors are generated during processing of the operation,
# this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this
# operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
"errorDetails": [ # [Output Only] An optional list of messages that contain the error
# details. There is a set of defined message types to use for providing
# details.The syntax depends on the error code. For example,
# QuotaExceededInfo will have details when the error code is
# QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details.
#
# Example of an error when contacting the "pubsub.googleapis.com" API when it
# is not enabled:
#
# { "reason": "API_DISABLED"
# "domain": "googleapis.com"
# "metadata": {
# "resource": "projects/123",
# "service": "pubsub.googleapis.com"
# }
# }
#
# This response indicates that the pubsub.googleapis.com API is not enabled.
#
# Example of an error that is returned when attempting to create a Spanner
# instance in a region that is out of stock:
#
# { "reason": "STOCKOUT"
# "domain": "spanner.googleapis.com",
# "metadata": {
# "availableRegions": "us-central1,us-east2"
# }
# }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
# is typically the registered service name of the tool or product that
# generates the error. Example: "pubsub.googleapis.com". If the error is
# generated by some common infrastructure, the error domain must be a
# globally unique value that identifies the infrastructure. For Google API
# infrastructure, the error domain is "googleapis.com".
"metadatas": { # Additional structured details about this error.
#
# Keys must match a regular expression of `a-z+` but should
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in
# length. When identifying the current value of an exceeded limit, the units
# should be contained in the key, not the value. For example, rather than
# `{"instanceLimit": "100/request"}`, should be returned as,
# `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
# instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the
# proximate cause of the error. Error reasons are unique within a particular
# domain of errors. This should be at most 63 characters and match a
# regular expression of `A-Z+[A-Z0-9]`, which represents
# UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action.
#
# For example, if a quota check failed with an error indicating the calling
# project hasn't enabled the accessed service, this can contain a URL pointing
# directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user
# which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
# Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
# type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
# or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error.
# This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
# operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
}
list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of machine images that are contained within
the specified project.
Args:
project: string, Project ID for this request. (required)
filter: string, A filter expression that filters resources listed in the response. Most
Compute resources support two types of filter expressions:
expressions that support regular expressions and expressions that follow
API improvement proposal AIP-160.
These two types of filter expressions cannot be mixed in one request.
If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.
The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
```
labels.owner:*
```
You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
```
(scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")
```
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
```
(cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)
```
If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
`fieldname eq unquoted literal`
`fieldname eq 'single quoted literal'`
`fieldname eq "double quoted literal"`
`(fieldname1 eq literal) (fieldname2 ne "literal")`
The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.
For example, to filter for instances that do not end with name "instance",
you would use `name ne .*instance`.
You cannot combine constraints on multiple fields using regular
expressions.
maxResults: integer, The maximum number of results per page that should be returned.
If the number of available results is larger than `maxResults`,
Compute Engine returns a `nextPageToken` that can be used to get
the next page of results in subsequent list requests. Acceptable values are
`0` to `500`, inclusive. (Default: `500`)
orderBy: string, Sorts list results by a certain order. By default, results
are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation
timestamp using `orderBy="creationTimestamp desc"`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.
Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the
`nextPageToken` returned by a previous list request to get
the next page of results.
returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
of failure. The default value is false.
For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of machine images.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"items": [ # A list of MachineImage resources.
{ # Represents a machine image resource.
#
# A machine image is a Compute Engine resource that stores all the
# configuration, metadata, permissions, and data from one or more disks
# required to create a Virtual machine (VM) instance. For more information, seeMachine images.
"creationTimestamp": "A String", # [Output Only] The creation timestamp for this machine image inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"guestFlush": True or False, # [Input Only] Whether to attempt an application consistent machine image by
# informing the OS to prepare for the snapshot process.
"id": "A String", # [Output Only] A unique identifier for this machine image. The server
# defines this identifier.
"instanceProperties": { # [Output Only] Properties of source instance
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features.
# Note that for MachineImage, this is not supported yet.
# 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 anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or
# disabled).
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).
"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.
"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance.
"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.
"turboMode": "A String", # Turbo frequency mode to use for the instance.
# Supported modes include:
# * ALL_CORE_MAX
#
# Using empty string or not setting this field will use the platform-specific
# default turbo mode.
"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by
# the number of threads per core to compute the total number of virtual
# CPUs to expose to the instance. If unset, the number of cores is
# inferred from the instance's nominal CPU count and the underlying
# platform's SMT width.
},
"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 tofalse. See theEnable IP forwarding
# documentation for more information.
"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.
# Note that for MachineImage, this is not supported yet.
"confidentialInstanceType": "A String", # Defines the type of technology used by the confidential instance.
"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.
"architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
# or X86_64.
"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 acustomer-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.
#
# Note:
#
# Instance templates do not storecustomer-supplied
# encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
#
# You cannot create VMs that have disks with customer-supplied keys using
# the bulk
# insert method.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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.
"forceAttach": True or False, # [Input Only] 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.
"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. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"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 # [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.
# alongside the new instance. Use initialization parameters to create boot
# disks or local SSDs attached to the new instance.
#
# This field is persisted and returned for instanceTemplate and not returned
# in the context of instance.
#
# This property is mutually exclusive with the source property;
# you can only define one or the other, but not both.
"architecture": "A String", # The architecture of the attached disk. Valid values are
# arm64 or x86_64.
"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
#
#
# For a full list of acceptable values, seePersistent disk
# types. If you specify this field when creating a VM, you can provide
# either the full or partial URL. For example, the following values are
# valid:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
# - projects/project/zones/zone/diskTypes/diskType
# - zones/zone/diskTypes/diskType
#
#
# If you specify this field when creating or updating an instance template
# or all-instances configuration, specify the type of the disk, not the
# URL. For example: pd-standard.
"enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
"labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
# persistent disks.
"a_key": "A String",
},
"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
"A String",
],
"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 to provision for the disk. This sets the number
# of I/O operations per second that the disk can handle. Values must be
# between 10,000 and 120,000. For more details, see theExtreme persistent
# disk documentation.
"provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
# number of throughput mb per second that the disk can handle. Values must
# greater than or equal to 1.
"replicaZones": [ # Required for each regional disk associated with the instance. Specify
# the URLs of the zones where the disk should be replicated to.
# You must provide exactly two replica zones, and one zone must be the same
# as the instance zone.
"A String",
],
"resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT
# & PATCH) when empty.
"a_key": "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 boot
# disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
# is required.
#
# To create a disk with one of the public operating system
# images, specify the image by its family name. For example, specifyfamily/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": { # Thecustomer-supplied
# encryption key of the source image. Required if the source image is
# protected by a customer-supplied encryption key.
#
# InstanceTemplate and InstancePropertiesPatch do not storecustomer-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.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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
# boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
# is required.
#
# 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.
#
# Note: You cannot create VMs in bulk using a snapshot as the source. Use
# an image instead when you create VMs using
# the bulk
# insert method.
"sourceSnapshotEncryptionKey": { # Thecustomer-supplied
# encryption key of the source snapshot.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"storagePool": "A String", # The storage pool in which the new disk is created. You can provide
# this as a partial or full URL to the resource. For example, the following
# are valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
# - projects/project/zones/zone/storagePools/storagePool
# - zones/zone/storagePools/storagePool
},
"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
# either SCSI or NVME. For most machine types, the
# default is SCSI. Local SSDs can use either NVME or SCSI.
# In certain configurations, persistent disks can use NVMe. For more
# information, seeAbout
# persistent disks.
"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#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 orREAD_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, # [Output Only] shielded vm initial state stored on disk
# these are public keys which are safe to store in public
"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 boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
# is required.
#
# 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 for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
},
],
"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.
},
],
"keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and
# "NONE". The default value is "NONE" if it is not specified.
"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.
# This field only accepts a machine type name, for example `n2-standard-4`.
# If you use the machine type full or partial URL, for example
# `projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,
# the request will result in an `INTERNAL_ERROR`.
"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. SeeProject 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 error412 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.
{ # Metadata
"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 asminCpuPlatform: "Intel Haswell" orminCpuPlatform: "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 noaccessConfigs 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.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"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 as10.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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
"internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
# one IPv6 access config, DIRECT_IPV6, is supported. If there
# is no ipv6AccessConfig specified, then this instance will
# have no external IPv6 Internet access.
{ # An access configuration attached to an instance's network interface.
# Only one access config per instance is supported.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
# accessed from the Internet. This field is always inherited from its
# subnetwork.
#
# Valid only if stackType is IPV4_IPV6.
"ipv6Address": "A String", # An IPv6 internal network address for this network interface. To
# use a static internal IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an internal IPv6 address from the instance's subnetwork.
"kind": "compute#networkInterface", # [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
"name": "A String", # [Output Only] The name of the network interface, which is generated by the
# server. For a VM, the network interface uses the nicN naming
# format. Where N is a value between 0 and7. The default interface value is nic0.
"network": "A String", # URL of the VPC 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
# selected project doesn't have the default network, you must specify a
# network or subnet. 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
"networkAttachment": "A String", # The URL of the network attachment that this interface should connect
# to in the following format:
# projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"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.
"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or
# VirtioNet.
"parentNicName": "A String", # Name of the parent network interface of a dynamic network interface.
"queueCount": 42, # The networking queue count that's specified by users for the network
# interface. Both Rx and Tx queues will be set to this number. It'll be empty
# if not specified by the users.
"stackType": "A String", # The stack type for this network interface. To assign only IPv4 addresses,
# use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
#
# This field can be both set at instance creation and update network
# interface operations.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network
# resource is inlegacy
# 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
"vlan": 42, # VLAN tag of a dynamic network interface, must be an integer in the range
# from 2 to 255 inclusively.
},
],
"networkPerformanceConfig": { # Note that for MachineImage, this is not supported yet.
"totalEgressBandwidthTier": "A String",
},
"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs.
# If not specified, use INHERIT_FROM_SUBNETWORK as default.
# Note that for MachineImage, this is not supported yet.
"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.
# Note that for MachineImage, this is not supported yet.
"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 aSPECIFIC_RESERVATION by name, specifygoogleapis.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. This can be
# either a name to a reservation in the same project or
# "projects/different-project/reservations/some-reservation-name" to target a
# shared reservation in the same zone but in a different project.
"A String",
],
},
"resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
# PATCH) when empty.
"a_key": "A String",
},
"resourcePolicies": [ # Resource policies (names, not URLs) applied to instances created from
# these properties.
# Note that for MachineImage, this is not supported yet.
"A String",
],
"scheduling": { # Sets the scheduling options for an Instance. # 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.
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value
# must be a number between 1 and the number of availability domains
# specified in the spread placement policy attached to the instance.
"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be
# within the range of [90, 330] with the increment of 30, if unset, the
# default behavior of host error recovery will be used.
"instanceTerminationAction": "A String", # Specifies the termination action for the instance.
"localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
# recovery of the Local Ssd state is attempted. Its value should be in
# between 0 and 168 hours with hour granularity and the default value being 1
# hour.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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.
"maxRunDuration": { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
# the instance termination action will be performed at the end of the run
# duration.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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 toConfiguring 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 areIN 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. Forpreemptible instances,
# the default and only possible behavior is TERMINATE. For more
# information, see
# Set
# VM host maintenance policy.
"onInstanceStopAction": { # Defines the behaviour for instances with the instance_termination_actionSTOP.
"discardLocalSsd": True or False, # If true, the contents of any attached Local SSD disks will be discarded
# else, the Local SSD data will be preserved when the instance is stopped
# at the end of the run duration/termination time.
},
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
# Off for Standard VMs and 30 seconds for Spot VMs.
"terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
# termination action will be performed at the termination time.
},
"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. # Note that for MachineImage, this is not supported yet.
"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.
},
"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",
],
},
},
"kind": "compute#machineImage", # [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
"labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
# essentially a hash of the labels set used for optimistic locking. The
# fingerprint is initially generated by Compute Engine and changes after
# every request to modify or update labels. You must always provide an
# up-to-date fingerprint hash in order to update or change labels.
#
# To see the latest fingerprint, make get() request to the
# machine image.
"labels": { # Labels to apply to this machine image. These can be later modified by
# the setLabels method.
"a_key": "A String",
},
"machineImageEncryptionKey": { # Encrypts the machine image using acustomer-supplied
# encryption key.
#
# After you encrypt a machine image using a customer-supplied key, you must
# provide the same key if you use the machine image later. For example, you
# must provide the encryption key when you create an instance from the
# encrypted machine image in a future request.
#
# Customer-supplied encryption keys do not protect access to metadata of the
# machine image.
#
# If you do not provide an encryption key when creating the machine image,
# then the machine image will be encrypted using an automatically generated
# key and you do not need to provide a key to use the machine image later.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"name": "A String", # Name of the resource; provided by the client when the resource is created.
# The name must be 1-63 characters long, and comply withRFC1035.
# Specifically, the name must be 1-63 characters long and match the regular
# expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot
# be a dash.
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"savedDisks": [ # An array of Machine Image specific properties for disks attached to the
# source instance
{ # An instance-attached disk resource.
"architecture": "A String", # [Output Only] The architecture of the attached disk.
"kind": "compute#savedDisk", # [Output Only] Type of the resource. Always compute#savedDisk
# for attached disks.
"sourceDisk": "A String", # Specifies a URL of the disk attached to the source instance.
"storageBytes": "A String", # [Output Only] Size of the individual disk snapshot used by this machine
# image.
"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a
# stable state or it is being adjusted as a result of shared storage
# reallocation. This status can either be UPDATING, meaning
# the size of the snapshot is being updated, or UP_TO_DATE,
# meaning the size of the snapshot is up-to-date.
},
],
"selfLink": "A String", # [Output Only] The URL for this machine image. The server defines this URL.
"sourceDiskEncryptionKeys": [ # [Input Only] Thecustomer-supplied
# encryption key of the disks attached to the source instance. Required
# if the source disk is protected by a customer-supplied encryption key.
{
"diskEncryptionKey": { # Thecustomer-supplied
# encryption key of the source disk. Required if the source disk is
# protected by a customer-supplied encryption key.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
"sourceDisk": "A String", # URL of the disk attached to the source instance. This can be a full or
# valid partial URL. For example, the following are valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
},
],
"sourceInstance": "A String", # The source instance used to create the machine image. You can provide this
# as a partial or full URL to the resource. For example, the following are
# valid values:
#
#
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
# - projects/project/zones/zone/instances/instance
"sourceInstanceProperties": { # DEPRECATED: Please use compute#instanceProperties instead. # [Output Only] DEPRECATED: Please use instance_properties
# instead for source instance related properties. New properties will not be
# added to this field.
# New properties will not be added to this field.
"canIpForward": True or False, # Enables instances created based on this machine image 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 tofalse. See theEnable IP forwarding
# documentation for more information.
"deletionProtection": True or False, # Whether the instance created from this machine image should be protected
# against deletion.
"description": "A String", # An optional text description for the instances that are created from this
# machine image.
"disks": [ # An array of disks that are associated with the instances that are created
# from this machine image.
{ # DEPRECATED: Please use compute#savedDisk instead.
# 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 the name of the disk attached to the source instance.
"diskEncryptionKey": { # The encryption key for the disk.
"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
# For example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
#
# The fully-qualifed key name may be returned for resource GET requests. For
# example:
#
# "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
# key_region/cryptoKeys/key
# /cryptoKeyVersions/1
"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.
# For example:
#
# "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
"rawKey": "A String", # Specifies a 256-bit customer-supplied
# encryption key, encoded in RFC
# 4648 base64 to either encrypt or decrypt this resource. You can
# provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rawKey":
# "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
# customer-supplied encryption key to either encrypt or decrypt this
# resource. You can provide either the rawKey or thersaEncryptedKey.
# For example:
#
# "rsaEncryptedKey":
# "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
# z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
# D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
#
# The key must meet the following requirements before you can provide it to
# Compute Engine:
#
# 1. The key is wrapped using a RSA public key certificate provided by
# Google.
# 2. 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] TheRFC
# 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 base-2 GB.
"diskType": "A String", # [Output Only] URL of the disk type resource. For example:projects/project/zones/zone/diskTypes/pd-standard or
# pd-ssd
"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. To add multiple values, use commas to
# separate values. Set to one or more of the following values:
#
# - VIRTIO_SCSI_MULTIQUEUE
# - WINDOWS
# - MULTI_IP_SUBNET
# - UEFI_COMPATIBLE
# - GVNIC
# - SEV_CAPABLE
# - SUSPEND_RESUME_COMPATIBLE
# - SEV_LIVE_MIGRATABLE_V2
# - SEV_SNP_CAPABLE
# - TDX_CAPABLE
# - IDPF
# - SNP_SVSM_CAPABLE
#
#
# For more information, see
# Enabling guest operating system features.
},
],
"index": 42, # Specifies zero-based index of the disk that is attached to the source
# instance.
"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
# either SCSI or NVME.
"kind": "compute#savedAttachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
"licenses": [ # [Output Only] Any valid publicly visible licenses.
"A String",
],
"mode": "A String", # The mode in which this disk is attached to the source instance, eitherREAD_WRITE or READ_ONLY.
"source": "A String", # Specifies a URL of the disk attached to the source instance.
"storageBytes": "A String", # [Output Only] A size of the storage used by the disk's snapshot by this
# machine image.
"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a
# stable state or it is being adjusted as a result of shared storage
# reallocation. This status can either be UPDATING, meaning
# the size of the snapshot is being updated, or UP_TO_DATE,
# meaning the size of the snapshot is up-to-date.
"type": "A String", # Specifies the type of the attached disk, either SCRATCH orPERSISTENT.
},
],
"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances
# created from this machine image.
{ # 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.
},
],
"keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and
# "NONE". The default value is "NONE" if it is not specified.
"labels": { # Labels to apply to instances that are created from this machine image.
"a_key": "A String",
},
"machineType": "A String", # The machine type to use for instances that are created from this machine
# image.
"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from
# this machine image. These pairs can consist of custom metadata or
# predefined keys. SeeProject 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 error412 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.
{ # Metadata
"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 created from this machine
# image. 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" orminCpuPlatform: "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 noaccessConfigs 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.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"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 as10.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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
"internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
# one IPv6 access config, DIRECT_IPV6, is supported. If there
# is no ipv6AccessConfig specified, then this instance will
# have no external IPv6 Internet access.
{ # An access configuration attached to an instance's network interface.
# Only one access config per instance is supported.
"externalIpv6": "A String", # Applies to ipv6AccessConfigs only.
# The first IPv6 address of the external IPv6 range associated
# with this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To
# use a static external IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an external IPv6 address from the instance's subnetwork.
"externalIpv6PrefixLength": 42, # Applies to ipv6AccessConfigs only. The prefix length of the
# external IPv6 range.
"kind": "compute#accessConfig", # [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.
"name": "A String", # The name of this access configuration. In accessConfigs
# (IPv4), the default and recommended name is External NAT, but
# you can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the
# recommend name is External IPv6.
"natIP": "A String", # Applies to accessConfigs (IPv4) only. Anexternal 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.
"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record.
#
# You can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for
# first IP in associated external IPv6 range.
"securityPolicy": "A String", # The resource URL for the security policy associated with this access
# config.
"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.
#
# This field is not used in ipv6AccessConfig. A default PTR
# record will be created if the VM has external IPv6 range associated.
"type": "A String", # The type of configuration. In accessConfigs (IPv4), the
# default and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.
},
],
"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be
# accessed from the Internet. This field is always inherited from its
# subnetwork.
#
# Valid only if stackType is IPV4_IPV6.
"ipv6Address": "A String", # An IPv6 internal network address for this network interface. To
# use a static internal IP address, it must be unused and in the same region
# as the instance's zone. If not specified, Google Cloud will automatically
# assign an internal IPv6 address from the instance's subnetwork.
"kind": "compute#networkInterface", # [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.
"name": "A String", # [Output Only] The name of the network interface, which is generated by the
# server. For a VM, the network interface uses the nicN naming
# format. Where N is a value between 0 and7. The default interface value is nic0.
"network": "A String", # URL of the VPC 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
# selected project doesn't have the default network, you must specify a
# network or subnet. 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
"networkAttachment": "A String", # The URL of the network attachment that this interface should connect
# to in the following format:
# projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"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.
"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or
# VirtioNet.
"parentNicName": "A String", # Name of the parent network interface of a dynamic network interface.
"queueCount": 42, # The networking queue count that's specified by users for the network
# interface. Both Rx and Tx queues will be set to this number. It'll be empty
# if not specified by the users.
"stackType": "A String", # The stack type for this network interface. To assign only IPv4 addresses,
# use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.
#
# This field can be both set at instance creation and update network
# interface operations.
"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network
# resource is inlegacy
# 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
"vlan": 42, # VLAN tag of a dynamic network interface, must be an integer in the range
# from 2 to 255 inclusively.
},
],
"scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from
# this machine image.
"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.
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value
# must be a number between 1 and the number of availability domains
# specified in the spread placement policy attached to the instance.
"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be
# within the range of [90, 330] with the increment of 30, if unset, the
# default behavior of host error recovery will be used.
"instanceTerminationAction": "A String", # Specifies the termination action for the instance.
"localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented # Specifies the maximum amount of time a Local Ssd Vm should wait while
# recovery of the Local Ssd state is attempted. Its value should be in
# between 0 and 168 hours with hour granularity and the default value being 1
# hour.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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.
"maxRunDuration": { # A Duration represents a fixed-length span of time represented # Specifies the max run duration for the given instance. If specified,
# the instance termination action will be performed at the end of the run
# duration.
# as a count of seconds and fractions of seconds at nanosecond
# resolution. It is independent of any calendar and concepts like "day"
# or "month". Range is approximately 10,000 years.
"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution.
# Durations less than one second are represented with a 0
# `seconds` field and a positive `nanos` field. Must be from 0
# to 999,999,999 inclusive.
"seconds": "A String", # Span of time at a resolution of a second. Must be from 0
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"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 toConfiguring 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 areIN 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. Forpreemptible instances,
# the default and only possible behavior is TERMINATE. For more
# information, see
# Set
# VM host maintenance policy.
"onInstanceStopAction": { # Defines the behaviour for instances with the instance_termination_actionSTOP.
"discardLocalSsd": True or False, # If true, the contents of any attached Local SSD disks will be discarded
# else, the Local SSD data will be preserved when the instance is stopped
# at the end of the run duration/termination time.
},
"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance isstopped and
# therefore, in a `TERMINATED` state. SeeInstance Life
# Cycle for more information on the possible instance states.
"provisioningModel": "A String", # Specifies the provisioning model of the instance.
"skipGuestOsShutdown": True or False, # Default is false and there will be 120 seconds between GCE ACPI G2 Soft
# Off and ACPI G3 Mechanical
# Off for Standard VMs and 30 seconds for Spot VMs.
"terminationTime": "A String", # Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance
# termination action will be performed at the termination time.
},
"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these
# service accounts are available to the instances that are created from this
# machine image. 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",
],
},
],
"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this machine
# image. 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 withRFC1035.
"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",
],
},
},
"status": "A String", # [Output Only] The status of the machine image. One of the following values:INVALID, CREATING, READY,DELETING, and UPLOADING.
"storageLocations": [ # The regional or multi-regional Cloud Storage bucket location where themachine image is
# stored.
"A String",
],
"totalStorageBytes": "A String", # [Output Only] Total size of the storage used by the machine image.
},
],
"kind": "compute#machineImageList", # [Output Only] The resource type, which is alwayscompute#machineImagesListResponse for machine image lists.
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
# list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
# the query parameter pageToken in the next list request.
# Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"warning": { # [Output Only] Informational warning message.
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
setIamPolicy(project, resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Args:
project: string, Project ID for this request. (required)
resource: string, Name or id of the resource for this request. (required)
body: object, The request body.
The object takes the form of:
{
"bindings": [ # Flatten Policy to create a backward compatible wire-format.
# Deprecated. Use 'policy' to specify bindings.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # Flatten Policy to create a backward compatible wire-format.
# Deprecated. Use 'policy' to specify the etag.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
# the policy is limited to a few 10s of KB. An empty policy is in general a
# valid policy but certain services (like Projects) might reject them.
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members`, or principals, to a single `role`. Principals can be user
# accounts, service accounts, Google groups, and domains (such as G Suite). A
# `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# ```
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
# ```
#
# **YAML example:**
#
# ```
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# etag: BwWWja0YfJA=
# version: 3
# ```
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# },
# {
# "log_type": "ADMIN_READ"
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
# `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with 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 principal.
#
# The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
# of these principals can be Google groups. Each occurrence of a principal
# counts towards these limits. For example, if the `bindings` grant 50
# different roles to `user:alice@example.com`, and not to any other
# principal, then you can add another 1,450 principals to the `bindings` in
# the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members`, or principals, to a single `role`. Principals can be user
# accounts, service accounts, Google groups, and domains (such as G Suite). A
# `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# ```
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
# ```
#
# **YAML example:**
#
# ```
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# etag: BwWWja0YfJA=
# version: 3
# ```
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# },
# {
# "log_type": "ADMIN_READ"
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
# `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with 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 principal.
#
# The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
# of these principals can be Google groups. Each occurrence of a principal
# counts towards these limits. For example, if the `bindings` grant 50
# different roles to `user:alice@example.com`, and not to any other
# principal, then you can add another 1,450 principals to the `bindings` in
# the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
setLabels(project, resource, body=None, x__xgafv=None)
Sets the labels on a machine image. To learn more about labels, read theLabeling
Resources documentation.
Args:
project: string, Project ID for this request. (required)
resource: string, Name or id of the resource for this request. (required)
body: object, The request body.
The object takes the form of:
{
"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource,
# used to detect conflicts. The fingerprint is initially generated by Compute
# Engine and changes after every request to modify or update labels. You must
# always provide an up-to-date fingerprint hash when updating or changing
# labels, otherwise the request will fail with error412 conditionNotMet. Make a get() request to the
# resource to get the latest fingerprint.
"labels": { # A list of labels to apply for this resource. Each label must comply with
# the
# requirements for labels. For example,"webserver-frontend": "images". A label value can also be
# empty (e.g. "my-label": "").
"a_key": "A String",
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Operation resource.
#
# Google Compute Engine has three Operation resources:
#
# * [Global](/compute/docs/reference/rest/v1/globalOperations)
# * [Regional](/compute/docs/reference/rest/v1/regionOperations)
# * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
#
# You can use an operation resource to manage asynchronous API requests.
# For more information, readHandling
# API responses.
#
# Operations can be global, regional or zonal.
#
# - For global operations, use the `globalOperations`
# resource.
# - For regional operations, use the
# `regionOperations` resource.
# - For zonal operations, use
# the `zoneOperations` resource.
#
#
#
# For more information, read
# Global, Regional, and Zonal Resources.
#
# Note that completed Operation resources have a limited
# retention period.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
# Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is
# set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
# text format.
"error": { # [Output Only] If errors are generated during processing of the operation,
# this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this
# operation.
{
"code": "A String", # [Output Only] The error type identifier for this error.
"errorDetails": [ # [Output Only] An optional list of messages that contain the error
# details. There is a set of defined message types to use for providing
# details.The syntax depends on the error code. For example,
# QuotaExceededInfo will have details when the error code is
# QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details.
#
# Example of an error when contacting the "pubsub.googleapis.com" API when it
# is not enabled:
#
# { "reason": "API_DISABLED"
# "domain": "googleapis.com"
# "metadata": {
# "resource": "projects/123",
# "service": "pubsub.googleapis.com"
# }
# }
#
# This response indicates that the pubsub.googleapis.com API is not enabled.
#
# Example of an error that is returned when attempting to create a Spanner
# instance in a region that is out of stock:
#
# { "reason": "STOCKOUT"
# "domain": "spanner.googleapis.com",
# "metadata": {
# "availableRegions": "us-central1,us-east2"
# }
# }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
# is typically the registered service name of the tool or product that
# generates the error. Example: "pubsub.googleapis.com". If the error is
# generated by some common infrastructure, the error domain must be a
# globally unique value that identifies the infrastructure. For Google API
# infrastructure, the error domain is "googleapis.com".
"metadatas": { # Additional structured details about this error.
#
# Keys must match a regular expression of `a-z+` but should
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in
# length. When identifying the current value of an exceeded limit, the units
# should be contained in the key, not the value. For example, rather than
# `{"instanceLimit": "100/request"}`, should be returned as,
# `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
# instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the
# proximate cause of the error. Error reasons are unique within a particular
# domain of errors. This should be at most 63 characters and match a
# regular expression of `A-Z+[A-Z0-9]`, which represents
# UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action.
#
# For example, if a quota check failed with an error indicating the calling
# project hasn't enabled the accessed service, this can contain a URL pointing
# directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user
# which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
# Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
# type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
# or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error.
# This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
# operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
}
testIamPermissions(project, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
Args:
project: string, Project ID for this request. (required)
resource: string, Name or id of the resource for this request. (required)
body: object, The request body.
The object takes the form of:
{
"permissions": [ # The set of permissions to check for the 'resource'. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
"A String",
],
}