Interface InstanceOrBuilder (1.65.0) 

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAdvancedMachineFeatures()

public abstract AdvancedMachineFeatures getAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns
Type Description
AdvancedMachineFeatures

The advancedMachineFeatures.

getAdvancedMachineFeaturesOrBuilder()

public abstract AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

Controls for advanced machine-related behavior features.

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

Returns
Type Description
AdvancedMachineFeaturesOrBuilder

getCanIpForward()

public abstract boolean getCanIpForward()

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;

Returns
Type Description
boolean

The canIpForward.

getConfidentialInstanceConfig()

public abstract ConfidentialInstanceConfig getConfidentialInstanceConfig()

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

Returns
Type Description
ConfidentialInstanceConfig

The confidentialInstanceConfig.

getConfidentialInstanceConfigOrBuilder()

public abstract ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()

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

Returns
Type Description
ConfidentialInstanceConfigOrBuilder

getCpuPlatform()

public abstract String getCpuPlatform()

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

optional string cpu_platform = 410285354;

Returns
Type Description
String

The cpuPlatform.

getCpuPlatformBytes()

public abstract ByteString getCpuPlatformBytes()

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

optional string cpu_platform = 410285354;

Returns
Type Description
ByteString

The bytes for cpuPlatform.

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDeletionProtection()

public abstract boolean getDeletionProtection()

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
Type Description
boolean

The deletionProtection.

getDescription()

public abstract String getDescription()

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

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDisks(int index)

public abstract AttachedDisk getDisks(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
AttachedDisk

getDisksCount()

public abstract int getDisksCount()

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;

Returns
Type Description
int

getDisksList()

public abstract List<AttachedDisk> getDisksList()

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;

Returns
Type Description
List<AttachedDisk>

getDisksOrBuilder(int index)

public abstract AttachedDiskOrBuilder getDisksOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
AttachedDiskOrBuilder

getDisksOrBuilderList()

public abstract List<? extends AttachedDiskOrBuilder> getDisksOrBuilderList()

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;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.AttachedDiskOrBuilder>

getDisplayDevice()

public abstract DisplayDevice getDisplayDevice()

Enables display device for the instance.

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

Returns
Type Description
DisplayDevice

The displayDevice.

getDisplayDeviceOrBuilder()

public abstract DisplayDeviceOrBuilder getDisplayDeviceOrBuilder()

Enables display device for the instance.

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

Returns
Type Description
DisplayDeviceOrBuilder

getFingerprint()

public abstract String getFingerprint()

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;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public abstract ByteString getFingerprintBytes()

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;

Returns
Type Description
ByteString

The bytes for fingerprint.

getGuestAccelerators(int index)

public abstract AcceleratorConfig getGuestAccelerators(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AcceleratorConfig

getGuestAcceleratorsCount()

public abstract int getGuestAcceleratorsCount()

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

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

Returns
Type Description
int

getGuestAcceleratorsList()

public abstract List<AcceleratorConfig> getGuestAcceleratorsList()

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

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

Returns
Type Description
List<AcceleratorConfig>

getGuestAcceleratorsOrBuilder(int index)

public abstract AcceleratorConfigOrBuilder getGuestAcceleratorsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
AcceleratorConfigOrBuilder

getGuestAcceleratorsOrBuilderList()

public abstract List<? extends AcceleratorConfigOrBuilder> getGuestAcceleratorsOrBuilderList()

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

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

Returns
Type Description
List<? extends com.google.cloud.compute.v1.AcceleratorConfigOrBuilder>

getHostname()

public abstract String getHostname()

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;

Returns
Type Description
String

The hostname.

getHostnameBytes()

public abstract ByteString getHostnameBytes()

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;

Returns
Type Description
ByteString

The bytes for hostname.

getId()

public abstract long getId()

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

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getInstanceEncryptionKey()

public abstract CustomerEncryptionKey getInstanceEncryptionKey()

Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

optional .google.cloud.compute.v1.CustomerEncryptionKey instance_encryption_key = 64741517;

Returns
Type Description
CustomerEncryptionKey

The instanceEncryptionKey.

getInstanceEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getInstanceEncryptionKeyOrBuilder()

Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

optional .google.cloud.compute.v1.CustomerEncryptionKey instance_encryption_key = 64741517;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getKeyRevocationActionType()

public abstract String getKeyRevocationActionType()

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;

Returns
Type Description
String

The keyRevocationActionType.

getKeyRevocationActionTypeBytes()

public abstract ByteString getKeyRevocationActionTypeBytes()

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;

Returns
Type Description
ByteString

The bytes for keyRevocationActionType.

getKind()

public abstract String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLabelFingerprint()

public abstract String getLabelFingerprint()

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;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public abstract ByteString getLabelFingerprintBytes()

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;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getLastStartTimestamp()

public abstract String getLastStartTimestamp()

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

optional string last_start_timestamp = 443830736;

Returns
Type Description
String

The lastStartTimestamp.

getLastStartTimestampBytes()

public abstract ByteString getLastStartTimestampBytes()

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

optional string last_start_timestamp = 443830736;

Returns
Type Description
ByteString

The bytes for lastStartTimestamp.

getLastStopTimestamp()

public abstract String getLastStopTimestamp()

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

optional string last_stop_timestamp = 412823010;

Returns
Type Description
String

The lastStopTimestamp.

getLastStopTimestampBytes()

public abstract ByteString getLastStopTimestampBytes()

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

optional string last_stop_timestamp = 412823010;

Returns
Type Description
ByteString

The bytes for lastStopTimestamp.

getLastSuspendedTimestamp()

public abstract String getLastSuspendedTimestamp()

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

optional string last_suspended_timestamp = 356275337;

Returns
Type Description
String

The lastSuspendedTimestamp.

getLastSuspendedTimestampBytes()

public abstract ByteString getLastSuspendedTimestampBytes()

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

optional string last_suspended_timestamp = 356275337;

Returns
Type Description
ByteString

The bytes for lastSuspendedTimestamp.

getMachineType()

public abstract String getMachineType()

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;

Returns
Type Description
String

The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

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;

Returns
Type Description
ByteString

The bytes for machineType.

getMetadata()

public abstract Metadata getMetadata()

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

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

Returns
Type Description
Metadata

The metadata.

getMetadataOrBuilder()

public abstract MetadataOrBuilder getMetadataOrBuilder()

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

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

Returns
Type Description
MetadataOrBuilder

getMinCpuPlatform()

public abstract String getMinCpuPlatform()

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;

Returns
Type Description
String

The minCpuPlatform.

getMinCpuPlatformBytes()

public abstract ByteString getMinCpuPlatformBytes()

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;

Returns
Type Description
ByteString

The bytes for minCpuPlatform.

getName()

public abstract String getName()

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;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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;

Returns
Type Description
ByteString

The bytes for name.

getNetworkInterfaces(int index)

public abstract NetworkInterface getNetworkInterfaces(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
NetworkInterface

getNetworkInterfacesCount()

public abstract int getNetworkInterfacesCount()

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;

Returns
Type Description
int

getNetworkInterfacesList()

public abstract List<NetworkInterface> getNetworkInterfacesList()

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;

Returns
Type Description
List<NetworkInterface>

getNetworkInterfacesOrBuilder(int index)

public abstract NetworkInterfaceOrBuilder getNetworkInterfacesOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
NetworkInterfaceOrBuilder

getNetworkInterfacesOrBuilderList()

public abstract List<? extends NetworkInterfaceOrBuilder> getNetworkInterfacesOrBuilderList()

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;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.NetworkInterfaceOrBuilder>

getNetworkPerformanceConfig()

public abstract NetworkPerformanceConfig getNetworkPerformanceConfig()

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

Returns
Type Description
NetworkPerformanceConfig

The networkPerformanceConfig.

getNetworkPerformanceConfigOrBuilder()

public abstract NetworkPerformanceConfigOrBuilder getNetworkPerformanceConfigOrBuilder()

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

Returns
Type Description
NetworkPerformanceConfigOrBuilder

getParams()

public abstract InstanceParams getParams()

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;

Returns
Type Description
InstanceParams

The params.

getParamsOrBuilder()

public abstract InstanceParamsOrBuilder getParamsOrBuilder()

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;

Returns
Type Description
InstanceParamsOrBuilder

getPrivateIpv6GoogleAccess()

public abstract String getPrivateIpv6GoogleAccess()

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;

Returns
Type Description
String

The privateIpv6GoogleAccess.

getPrivateIpv6GoogleAccessBytes()

public abstract ByteString getPrivateIpv6GoogleAccessBytes()

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;

Returns
Type Description
ByteString

The bytes for privateIpv6GoogleAccess.

getReservationAffinity()

public abstract ReservationAffinity getReservationAffinity()

Specifies the reservations that this instance can consume from.

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

Returns
Type Description
ReservationAffinity

The reservationAffinity.

getReservationAffinityOrBuilder()

public abstract ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Specifies the reservations that this instance can consume from.

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

Returns
Type Description
ReservationAffinityOrBuilder

getResourcePolicies(int index)

public abstract String getResourcePolicies(int index)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The resourcePolicies at the given index.

getResourcePoliciesBytes(int index)

public abstract ByteString getResourcePoliciesBytes(int index)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the resourcePolicies at the given index.

getResourcePoliciesCount()

public abstract int getResourcePoliciesCount()

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Returns
Type Description
int

The count of resourcePolicies.

getResourcePoliciesList()

public abstract List<String> getResourcePoliciesList()

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Returns
Type Description
List<String>

A list containing the resourcePolicies.

getResourceStatus()

public abstract ResourceStatus getResourceStatus()

[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;

Returns
Type Description
ResourceStatus

The resourceStatus.

getResourceStatusOrBuilder()

public abstract ResourceStatusOrBuilder getResourceStatusOrBuilder()

[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;

Returns
Type Description
ResourceStatusOrBuilder

getSatisfiesPzi()

public abstract boolean getSatisfiesPzi()

[Output Only] Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

getScheduling()

public abstract Scheduling getScheduling()

Sets the scheduling options for this instance.

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

Returns
Type Description
Scheduling

The scheduling.

getSchedulingOrBuilder()

public abstract SchedulingOrBuilder getSchedulingOrBuilder()

Sets the scheduling options for this instance.

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

Returns
Type Description
SchedulingOrBuilder

getSelfLink()

public abstract String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getServiceAccounts(int index)

public abstract ServiceAccount getServiceAccounts(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
ServiceAccount

getServiceAccountsCount()

public abstract int getServiceAccountsCount()

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;

Returns
Type Description
int

getServiceAccountsList()

public abstract List<ServiceAccount> getServiceAccountsList()

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;

Returns
Type Description
List<ServiceAccount>

getServiceAccountsOrBuilder(int index)

public abstract ServiceAccountOrBuilder getServiceAccountsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
ServiceAccountOrBuilder

getServiceAccountsOrBuilderList()

public abstract List<? extends ServiceAccountOrBuilder> getServiceAccountsOrBuilderList()

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;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.ServiceAccountOrBuilder>

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

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

Returns
Type Description
ShieldedInstanceConfig

The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

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

Returns
Type Description
ShieldedInstanceConfigOrBuilder

getShieldedInstanceIntegrityPolicy()

public abstract ShieldedInstanceIntegrityPolicy getShieldedInstanceIntegrityPolicy()

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

Returns
Type Description
ShieldedInstanceIntegrityPolicy

The shieldedInstanceIntegrityPolicy.

getShieldedInstanceIntegrityPolicyOrBuilder()

public abstract ShieldedInstanceIntegrityPolicyOrBuilder getShieldedInstanceIntegrityPolicyOrBuilder()

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

Returns
Type Description
ShieldedInstanceIntegrityPolicyOrBuilder

getSourceMachineImage()

public abstract String getSourceMachineImage()

Source machine image

optional string source_machine_image = 21769791;

Returns
Type Description
String

The sourceMachineImage.

getSourceMachineImageBytes()

public abstract ByteString getSourceMachineImageBytes()

Source machine image

optional string source_machine_image = 21769791;

Returns
Type Description
ByteString

The bytes for sourceMachineImage.

getSourceMachineImageEncryptionKey()

public abstract CustomerEncryptionKey getSourceMachineImageEncryptionKey()

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;

Returns
Type Description
CustomerEncryptionKey

The sourceMachineImageEncryptionKey.

getSourceMachineImageEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getSourceMachineImageEncryptionKeyOrBuilder()

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;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getStartRestricted()

public abstract boolean getStartRestricted()

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

optional bool start_restricted = 123693144;

Returns
Type Description
boolean

The startRestricted.

getStatus()

public abstract String getStatus()

[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;

Returns
Type Description
String

The status.

getStatusBytes()

public abstract ByteString getStatusBytes()

[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;

Returns
Type Description
ByteString

The bytes for status.

getStatusMessage()

public abstract String getStatusMessage()

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

optional string status_message = 297428154;

Returns
Type Description
String

The statusMessage.

getStatusMessageBytes()

public abstract ByteString getStatusMessageBytes()

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

optional string status_message = 297428154;

Returns
Type Description
ByteString

The bytes for statusMessage.

getTags()

public abstract Tags getTags()

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;

Returns
Type Description
Tags

The tags.

getTagsOrBuilder()

public abstract TagsOrBuilder getTagsOrBuilder()

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;

Returns
Type Description
TagsOrBuilder

getZone()

public abstract String getZone()

[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;

Returns
Type Description
String

The zone.

getZoneBytes()

public abstract ByteString getZoneBytes()

[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;

Returns
Type Description
ByteString

The bytes for zone.

hasAdvancedMachineFeatures()

public abstract boolean hasAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns
Type Description
boolean

Whether the advancedMachineFeatures field is set.

hasCanIpForward()

public abstract boolean hasCanIpForward()

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;

Returns
Type Description
boolean

Whether the canIpForward field is set.

hasConfidentialInstanceConfig()

public abstract boolean hasConfidentialInstanceConfig()

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

Returns
Type Description
boolean

Whether the confidentialInstanceConfig field is set.

hasCpuPlatform()

public abstract boolean hasCpuPlatform()

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

optional string cpu_platform = 410285354;

Returns
Type Description
boolean

Whether the cpuPlatform field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDeletionProtection()

public abstract boolean hasDeletionProtection()

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
Type Description
boolean

Whether the deletionProtection field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDisplayDevice()

public abstract boolean hasDisplayDevice()

Enables display device for the instance.

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

Returns
Type Description
boolean

Whether the displayDevice field is set.

hasFingerprint()

public abstract boolean hasFingerprint()

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;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasHostname()

public abstract boolean hasHostname()

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;

Returns
Type Description
boolean

Whether the hostname field is set.

hasId()

public abstract boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasInstanceEncryptionKey()

public abstract boolean hasInstanceEncryptionKey()

Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

optional .google.cloud.compute.v1.CustomerEncryptionKey instance_encryption_key = 64741517;

Returns
Type Description
boolean

Whether the instanceEncryptionKey field is set.

hasKeyRevocationActionType()

public abstract boolean hasKeyRevocationActionType()

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;

Returns
Type Description
boolean

Whether the keyRevocationActionType field is set.

hasKind()

public abstract boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public abstract boolean hasLabelFingerprint()

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;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasLastStartTimestamp()

public abstract boolean hasLastStartTimestamp()

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

optional string last_start_timestamp = 443830736;

Returns
Type Description
boolean

Whether the lastStartTimestamp field is set.

hasLastStopTimestamp()

public abstract boolean hasLastStopTimestamp()

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

optional string last_stop_timestamp = 412823010;

Returns
Type Description
boolean

Whether the lastStopTimestamp field is set.

hasLastSuspendedTimestamp()

public abstract boolean hasLastSuspendedTimestamp()

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

optional string last_suspended_timestamp = 356275337;

Returns
Type Description
boolean

Whether the lastSuspendedTimestamp field is set.

hasMachineType()

public abstract boolean hasMachineType()

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;

Returns
Type Description
boolean

Whether the machineType field is set.

hasMetadata()

public abstract boolean hasMetadata()

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

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

Returns
Type Description
boolean

Whether the metadata field is set.

hasMinCpuPlatform()

public abstract boolean hasMinCpuPlatform()

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;

Returns
Type Description
boolean

Whether the minCpuPlatform field is set.

hasName()

public abstract boolean hasName()

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;

Returns
Type Description
boolean

Whether the name field is set.

hasNetworkPerformanceConfig()

public abstract boolean hasNetworkPerformanceConfig()

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

Returns
Type Description
boolean

Whether the networkPerformanceConfig field is set.

hasParams()

public abstract boolean hasParams()

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;

Returns
Type Description
boolean

Whether the params field is set.

hasPrivateIpv6GoogleAccess()

public abstract boolean hasPrivateIpv6GoogleAccess()

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;

Returns
Type Description
boolean

Whether the privateIpv6GoogleAccess field is set.

hasReservationAffinity()

public abstract boolean hasReservationAffinity()

Specifies the reservations that this instance can consume from.

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

Returns
Type Description
boolean

Whether the reservationAffinity field is set.

hasResourceStatus()

public abstract boolean hasResourceStatus()

[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;

Returns
Type Description
boolean

Whether the resourceStatus field is set.

hasSatisfiesPzi()

public abstract boolean hasSatisfiesPzi()

[Output Only] Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public abstract boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasScheduling()

public abstract boolean hasScheduling()

Sets the scheduling options for this instance.

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

Returns
Type Description
boolean

Whether the scheduling field is set.

hasSelfLink()

public abstract boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

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

Returns
Type Description
boolean

Whether the shieldedInstanceConfig field is set.

hasShieldedInstanceIntegrityPolicy()

public abstract boolean hasShieldedInstanceIntegrityPolicy()

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

Returns
Type Description
boolean

Whether the shieldedInstanceIntegrityPolicy field is set.

hasSourceMachineImage()

public abstract boolean hasSourceMachineImage()

Source machine image

optional string source_machine_image = 21769791;

Returns
Type Description
boolean

Whether the sourceMachineImage field is set.

hasSourceMachineImageEncryptionKey()

public abstract boolean hasSourceMachineImageEncryptionKey()

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;

Returns
Type Description
boolean

Whether the sourceMachineImageEncryptionKey field is set.

hasStartRestricted()

public abstract boolean hasStartRestricted()

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

optional bool start_restricted = 123693144;

Returns
Type Description
boolean

Whether the startRestricted field is set.

hasStatus()

public abstract boolean hasStatus()

[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;

Returns
Type Description
boolean

Whether the status field is set.

hasStatusMessage()

public abstract boolean hasStatusMessage()

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

optional string status_message = 297428154;

Returns
Type Description
boolean

Whether the statusMessage field is set.

hasTags()

public abstract boolean hasTags()

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;

Returns
Type Description
boolean

Whether the tags field is set.

hasZone()

public abstract boolean hasZone()

[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;

Returns
Type Description
boolean

Whether the zone field is set.