Class Instance (1.23.0)

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

Protobuf type google.cloud.compute.v1.Instance

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Controls for advanced machine-related behavior features.

optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;

Controls for advanced machine-related behavior features.

optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;

Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .

optional bool can_ip_forward = 467731324;

optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;

optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;

[Output Only] The CPU platform used by this instance.

optional string cpu_platform = 410285354;

[Output Only] The CPU platform used by this instance.

optional string cpu_platform = 410285354;

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;

Enables display device for the instance.

optional .google.cloud.compute.v1.DisplayDevice display_device = 258933875;

Enables display device for the instance.

optional .google.cloud.compute.v1.DisplayDevice display_device = 258933875;

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.

optional string fingerprint = 234678500;

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.

optional string fingerprint = 234678500;

A list of the type and count of accelerator cards attached to the instance.

repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

A list of the type and count of accelerator cards attached to the instance.

repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

A list of the type and count of accelerator cards attached to the instance.

repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

A list of the type and count of accelerator cards attached to the instance.

repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

A list of the type and count of accelerator cards attached to the instance.

repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

optional string hostname = 237067315;

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

optional string hostname = 237067315;

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

optional string key_revocation_action_type = 235941474;

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

optional string key_revocation_action_type = 235941474;

[Output Only] Type of the resource. Always compute#instance for instances.

optional string kind = 3292052;

[Output Only] Type of the resource. Always compute#instance for instances.

optional string kind = 3292052;

A fingerprint for this request, which is essentially a hash of the label's contents and 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 instance.

optional string label_fingerprint = 178124825;

A fingerprint for this request, which is essentially a hash of the label's contents and 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 instance.

optional string label_fingerprint = 178124825;

Use #getLabelsMap() instead.

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

[Output Only] Last start timestamp in RFC3339 text format.

optional string last_start_timestamp = 443830736;

[Output Only] Last start timestamp in RFC3339 text format.

optional string last_start_timestamp = 443830736;

[Output Only] Last stop timestamp in RFC3339 text format.

optional string last_stop_timestamp = 412823010;

[Output Only] Last stop timestamp in RFC3339 text format.

optional string last_stop_timestamp = 412823010;

[Output Only] Last suspended timestamp in RFC3339 text format.

optional string last_suspended_timestamp = 356275337;

[Output Only] Last suspended timestamp in RFC3339 text format.

optional string last_suspended_timestamp = 356275337;

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

optional string machine_type = 227711026;

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

optional string machine_type = 227711026;

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

optional .google.cloud.compute.v1.Metadata metadata = 86866735;

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

optional .google.cloud.compute.v1.Metadata metadata = 86866735;

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

optional string min_cpu_platform = 242912759;

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

optional string min_cpu_platform = 242912759;

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;

optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;

optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.InstanceParams params = 78313862;

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.InstanceParams params = 78313862;

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Specifies the reservations that this instance can consume from.

optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;

Specifies the reservations that this instance can consume from.

optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

optional .google.cloud.compute.v1.ResourceStatus resource_status = 249429315;

[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

optional .google.cloud.compute.v1.ResourceStatus resource_status = 249429315;

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Sets the scheduling options for this instance.

optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;

Sets the scheduling options for this instance.

optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;

[Output Only] Server-defined URL for this resource.

optional string self_link = 456214797;

[Output Only] Server-defined URL for this resource.

optional string self_link = 456214797;

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;

optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;

optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;

optional .google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy shielded_instance_integrity_policy = 163696919;

optional .google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy shielded_instance_integrity_policy = 163696919;

Source machine image

optional string source_machine_image = 21769791;

Source machine image

optional string source_machine_image = 21769791;

Source machine image encryption key when creating an instance from a machine image.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_machine_image_encryption_key = 192839075;

Source machine image encryption key when creating an instance from a machine image.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_machine_image_encryption_key = 192839075;

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

optional bool start_restricted = 123693144;

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.

optional string status = 181260274;

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.

optional string status = 181260274;

[Output Only] An optional, human-readable explanation of the status.

optional string status_message = 297428154;

[Output Only] An optional, human-readable explanation of the status.

optional string status_message = 297428154;

Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

optional .google.cloud.compute.v1.Tags tags = 3552281;

Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

optional .google.cloud.compute.v1.Tags tags = 3552281;

[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string zone = 3744684;

[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string zone = 3744684;

Controls for advanced machine-related behavior features.

optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;

Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .

optional bool can_ip_forward = 467731324;

optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;

[Output Only] The CPU platform used by this instance.

optional string cpu_platform = 410285354;

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Enables display device for the instance.

optional .google.cloud.compute.v1.DisplayDevice display_device = 258933875;

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.

optional string fingerprint = 234678500;

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

optional string hostname = 237067315;

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

optional string key_revocation_action_type = 235941474;

[Output Only] Type of the resource. Always compute#instance for instances.

optional string kind = 3292052;

A fingerprint for this request, which is essentially a hash of the label's contents and 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 instance.

optional string label_fingerprint = 178124825;

[Output Only] Last start timestamp in RFC3339 text format.

optional string last_start_timestamp = 443830736;

[Output Only] Last stop timestamp in RFC3339 text format.

optional string last_stop_timestamp = 412823010;

[Output Only] Last suspended timestamp in RFC3339 text format.

optional string last_suspended_timestamp = 356275337;

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

optional string machine_type = 227711026;

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

optional .google.cloud.compute.v1.Metadata metadata = 86866735;

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

optional string min_cpu_platform = 242912759;

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? 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.

optional string name = 3373707;

optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.InstanceParams params = 78313862;

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

optional string private_ipv6_google_access = 48277006;

Specifies the reservations that this instance can consume from.

optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;

[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

optional .google.cloud.compute.v1.ResourceStatus resource_status = 249429315;

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Sets the scheduling options for this instance.

optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;

[Output Only] Server-defined URL for this resource.

optional string self_link = 456214797;

optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;

optional .google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy shielded_instance_integrity_policy = 163696919;

Source machine image

optional string source_machine_image = 21769791;

Source machine image encryption key when creating an instance from a machine image.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_machine_image_encryption_key = 192839075;

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

optional bool start_restricted = 123693144;

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.

optional string status = 181260274;

[Output Only] An optional, human-readable explanation of the status.

optional string status_message = 297428154;

Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

optional .google.cloud.compute.v1.Tags tags = 3552281;

[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string zone = 3744684;