Class Instance.Builder (1.29.0)

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

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

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDisks(Iterable<? extends AttachedDisk> values)

public Instance.Builder addAllDisks(Iterable<? extends AttachedDisk> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.AttachedDisk>
Returns
TypeDescription
Instance.Builder

addAllGuestAccelerators(Iterable<? extends AcceleratorConfig> values)

public Instance.Builder addAllGuestAccelerators(Iterable<? extends AcceleratorConfig> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.AcceleratorConfig>
Returns
TypeDescription
Instance.Builder

addAllNetworkInterfaces(Iterable<? extends NetworkInterface> values)

public Instance.Builder addAllNetworkInterfaces(Iterable<? extends NetworkInterface> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.NetworkInterface>
Returns
TypeDescription
Instance.Builder

addAllResourcePolicies(Iterable<String> values)

public Instance.Builder addAllResourcePolicies(Iterable<String> values)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
NameDescription
valuesIterable<String>

The resourcePolicies to add.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

addAllServiceAccounts(Iterable<? extends ServiceAccount> values)

public Instance.Builder addAllServiceAccounts(Iterable<? extends ServiceAccount> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.ServiceAccount>
Returns
TypeDescription
Instance.Builder

addDisks(AttachedDisk value)

public Instance.Builder addDisks(AttachedDisk value)

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
NameDescription
valueAttachedDisk
Returns
TypeDescription
Instance.Builder

addDisks(AttachedDisk.Builder builderForValue)

public Instance.Builder addDisks(AttachedDisk.Builder builderForValue)

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
NameDescription
builderForValueAttachedDisk.Builder
Returns
TypeDescription
Instance.Builder

addDisks(int index, AttachedDisk value)

public Instance.Builder addDisks(int index, AttachedDisk value)

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;

Parameters
NameDescription
indexint
valueAttachedDisk
Returns
TypeDescription
Instance.Builder

addDisks(int index, AttachedDisk.Builder builderForValue)

public Instance.Builder addDisks(int index, AttachedDisk.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueAttachedDisk.Builder
Returns
TypeDescription
Instance.Builder

addDisksBuilder()

public AttachedDisk.Builder addDisksBuilder()

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
TypeDescription
AttachedDisk.Builder

addDisksBuilder(int index)

public AttachedDisk.Builder addDisksBuilder(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
NameDescription
indexint
Returns
TypeDescription
AttachedDisk.Builder

addGuestAccelerators(AcceleratorConfig value)

public Instance.Builder addGuestAccelerators(AcceleratorConfig value)

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

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

Parameter
NameDescription
valueAcceleratorConfig
Returns
TypeDescription
Instance.Builder

addGuestAccelerators(AcceleratorConfig.Builder builderForValue)

public Instance.Builder addGuestAccelerators(AcceleratorConfig.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueAcceleratorConfig.Builder
Returns
TypeDescription
Instance.Builder

addGuestAccelerators(int index, AcceleratorConfig value)

public Instance.Builder addGuestAccelerators(int index, AcceleratorConfig value)

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

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

Parameters
NameDescription
indexint
valueAcceleratorConfig
Returns
TypeDescription
Instance.Builder

addGuestAccelerators(int index, AcceleratorConfig.Builder builderForValue)

public Instance.Builder addGuestAccelerators(int index, AcceleratorConfig.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueAcceleratorConfig.Builder
Returns
TypeDescription
Instance.Builder

addGuestAcceleratorsBuilder()

public AcceleratorConfig.Builder addGuestAcceleratorsBuilder()

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

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

Returns
TypeDescription
AcceleratorConfig.Builder

addGuestAcceleratorsBuilder(int index)

public AcceleratorConfig.Builder addGuestAcceleratorsBuilder(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
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig.Builder

addNetworkInterfaces(NetworkInterface value)

public Instance.Builder addNetworkInterfaces(NetworkInterface value)

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
NameDescription
valueNetworkInterface
Returns
TypeDescription
Instance.Builder

addNetworkInterfaces(NetworkInterface.Builder builderForValue)

public Instance.Builder addNetworkInterfaces(NetworkInterface.Builder builderForValue)

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
NameDescription
builderForValueNetworkInterface.Builder
Returns
TypeDescription
Instance.Builder

addNetworkInterfaces(int index, NetworkInterface value)

public Instance.Builder addNetworkInterfaces(int index, NetworkInterface value)

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;

Parameters
NameDescription
indexint
valueNetworkInterface
Returns
TypeDescription
Instance.Builder

addNetworkInterfaces(int index, NetworkInterface.Builder builderForValue)

public Instance.Builder addNetworkInterfaces(int index, NetworkInterface.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueNetworkInterface.Builder
Returns
TypeDescription
Instance.Builder

addNetworkInterfacesBuilder()

public NetworkInterface.Builder addNetworkInterfacesBuilder()

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
TypeDescription
NetworkInterface.Builder

addNetworkInterfacesBuilder(int index)

public NetworkInterface.Builder addNetworkInterfacesBuilder(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
NameDescription
indexint
Returns
TypeDescription
NetworkInterface.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

addResourcePolicies(String value)

public Instance.Builder addResourcePolicies(String value)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
NameDescription
valueString

The resourcePolicies to add.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

addResourcePoliciesBytes(ByteString value)

public Instance.Builder addResourcePoliciesBytes(ByteString value)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
NameDescription
valueByteString

The bytes of the resourcePolicies to add.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

addServiceAccounts(ServiceAccount value)

public Instance.Builder addServiceAccounts(ServiceAccount value)

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
NameDescription
valueServiceAccount
Returns
TypeDescription
Instance.Builder

addServiceAccounts(ServiceAccount.Builder builderForValue)

public Instance.Builder addServiceAccounts(ServiceAccount.Builder builderForValue)

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
NameDescription
builderForValueServiceAccount.Builder
Returns
TypeDescription
Instance.Builder

addServiceAccounts(int index, ServiceAccount value)

public Instance.Builder addServiceAccounts(int index, ServiceAccount value)

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;

Parameters
NameDescription
indexint
valueServiceAccount
Returns
TypeDescription
Instance.Builder

addServiceAccounts(int index, ServiceAccount.Builder builderForValue)

public Instance.Builder addServiceAccounts(int index, ServiceAccount.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueServiceAccount.Builder
Returns
TypeDescription
Instance.Builder

addServiceAccountsBuilder()

public ServiceAccount.Builder addServiceAccountsBuilder()

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
TypeDescription
ServiceAccount.Builder

addServiceAccountsBuilder(int index)

public ServiceAccount.Builder addServiceAccountsBuilder(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
NameDescription
indexint
Returns
TypeDescription
ServiceAccount.Builder

build()

public Instance build()
Returns
TypeDescription
Instance

buildPartial()

public Instance buildPartial()
Returns
TypeDescription
Instance

clear()

public Instance.Builder clear()
Returns
TypeDescription
Instance.Builder
Overrides

clearAdvancedMachineFeatures()

public Instance.Builder clearAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns
TypeDescription
Instance.Builder

clearCanIpForward()

public Instance.Builder clearCanIpForward()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearConfidentialInstanceConfig()

public Instance.Builder clearConfidentialInstanceConfig()

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

Returns
TypeDescription
Instance.Builder

clearCpuPlatform()

public Instance.Builder clearCpuPlatform()

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

optional string cpu_platform = 410285354;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearCreationTimestamp()

public Instance.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearDeletionProtection()

public Instance.Builder clearDeletionProtection()

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearDescription()

public Instance.Builder clearDescription()

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

optional string description = 422937596;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearDisks()

public Instance.Builder clearDisks()

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
TypeDescription
Instance.Builder

clearDisplayDevice()

public Instance.Builder clearDisplayDevice()

Enables display device for the instance.

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

Returns
TypeDescription
Instance.Builder

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Instance.Builder
Overrides

clearFingerprint()

public Instance.Builder clearFingerprint()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearGuestAccelerators()

public Instance.Builder clearGuestAccelerators()

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

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

Returns
TypeDescription
Instance.Builder

clearHostname()

public Instance.Builder clearHostname()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearId()

public Instance.Builder clearId()

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

optional uint64 id = 3355;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearKeyRevocationActionType()

public Instance.Builder clearKeyRevocationActionType()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearKind()

public Instance.Builder clearKind()

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

optional string kind = 3292052;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearLabelFingerprint()

public Instance.Builder clearLabelFingerprint()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()
Returns
TypeDescription
Instance.Builder

clearLastStartTimestamp()

public Instance.Builder clearLastStartTimestamp()

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

optional string last_start_timestamp = 443830736;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearLastStopTimestamp()

public Instance.Builder clearLastStopTimestamp()

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

optional string last_stop_timestamp = 412823010;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearLastSuspendedTimestamp()

public Instance.Builder clearLastSuspendedTimestamp()

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

optional string last_suspended_timestamp = 356275337;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearMachineType()

public Instance.Builder clearMachineType()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearMetadata()

public Instance.Builder clearMetadata()

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
TypeDescription
Instance.Builder

clearMinCpuPlatform()

public Instance.Builder clearMinCpuPlatform()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearName()

public Instance.Builder clearName()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearNetworkInterfaces()

public Instance.Builder clearNetworkInterfaces()

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
TypeDescription
Instance.Builder

clearNetworkPerformanceConfig()

public Instance.Builder clearNetworkPerformanceConfig()

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

Returns
TypeDescription
Instance.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Instance.Builder
Overrides

clearParams()

public Instance.Builder clearParams()

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
TypeDescription
Instance.Builder

clearPrivateIpv6GoogleAccess()

public Instance.Builder clearPrivateIpv6GoogleAccess()

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
TypeDescription
Instance.Builder

This builder for chaining.

clearReservationAffinity()

public Instance.Builder clearReservationAffinity()

Specifies the reservations that this instance can consume from.

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

Returns
TypeDescription
Instance.Builder

clearResourcePolicies()

public Instance.Builder clearResourcePolicies()

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearResourceStatus()

public Instance.Builder clearResourceStatus()

[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
TypeDescription
Instance.Builder

clearSatisfiesPzs()

public Instance.Builder clearSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearScheduling()

public Instance.Builder clearScheduling()

Sets the scheduling options for this instance.

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

Returns
TypeDescription
Instance.Builder
public Instance.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearServiceAccounts()

public Instance.Builder clearServiceAccounts()

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
TypeDescription
Instance.Builder

clearShieldedInstanceConfig()

public Instance.Builder clearShieldedInstanceConfig()

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

Returns
TypeDescription
Instance.Builder

clearShieldedInstanceIntegrityPolicy()

public Instance.Builder clearShieldedInstanceIntegrityPolicy()

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

Returns
TypeDescription
Instance.Builder

clearSourceMachineImage()

public Instance.Builder clearSourceMachineImage()

Source machine image

optional string source_machine_image = 21769791;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearSourceMachineImageEncryptionKey()

public Instance.Builder clearSourceMachineImageEncryptionKey()

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
TypeDescription
Instance.Builder

clearStartRestricted()

public Instance.Builder clearStartRestricted()

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

optional bool start_restricted = 123693144;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearStatus()

public Instance.Builder clearStatus()

[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
TypeDescription
Instance.Builder

This builder for chaining.

clearStatusMessage()

public Instance.Builder clearStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearTags()

public Instance.Builder clearTags()

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
TypeDescription
Instance.Builder

clearZone()

public Instance.Builder clearZone()

[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
TypeDescription
Instance.Builder

This builder for chaining.

clone()

public Instance.Builder clone()
Returns
TypeDescription
Instance.Builder
Overrides

containsLabels(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

getAdvancedMachineFeatures()

public AdvancedMachineFeatures getAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns
TypeDescription
AdvancedMachineFeatures

The advancedMachineFeatures.

getAdvancedMachineFeaturesBuilder()

public AdvancedMachineFeatures.Builder getAdvancedMachineFeaturesBuilder()

Controls for advanced machine-related behavior features.

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

Returns
TypeDescription
AdvancedMachineFeatures.Builder

getAdvancedMachineFeaturesOrBuilder()

public AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

Controls for advanced machine-related behavior features.

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

Returns
TypeDescription
AdvancedMachineFeaturesOrBuilder

getCanIpForward()

public 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
TypeDescription
boolean

The canIpForward.

getConfidentialInstanceConfig()

public ConfidentialInstanceConfig getConfidentialInstanceConfig()

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

Returns
TypeDescription
ConfidentialInstanceConfig

The confidentialInstanceConfig.

getConfidentialInstanceConfigBuilder()

public ConfidentialInstanceConfig.Builder getConfidentialInstanceConfigBuilder()

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

Returns
TypeDescription
ConfidentialInstanceConfig.Builder

getConfidentialInstanceConfigOrBuilder()

public ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()

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

Returns
TypeDescription
ConfidentialInstanceConfigOrBuilder

getCpuPlatform()

public String getCpuPlatform()

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

optional string cpu_platform = 410285354;

Returns
TypeDescription
String

The cpuPlatform.

getCpuPlatformBytes()

public ByteString getCpuPlatformBytes()

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

optional string cpu_platform = 410285354;

Returns
TypeDescription
ByteString

The bytes for cpuPlatform.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDeletionProtection()

public boolean getDeletionProtection()

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
TypeDescription
boolean

The deletionProtection.

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisks(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
AttachedDisk

getDisksBuilder(int index)

public AttachedDisk.Builder getDisksBuilder(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
NameDescription
indexint
Returns
TypeDescription
AttachedDisk.Builder

getDisksBuilderList()

public List<AttachedDisk.Builder> getDisksBuilderList()

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
TypeDescription
List<Builder>

getDisksCount()

public 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
TypeDescription
int

getDisksList()

public 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
TypeDescription
List<AttachedDisk>

getDisksOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
AttachedDiskOrBuilder

getDisksOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.compute.v1.AttachedDiskOrBuilder>

getDisplayDevice()

public DisplayDevice getDisplayDevice()

Enables display device for the instance.

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

Returns
TypeDescription
DisplayDevice

The displayDevice.

getDisplayDeviceBuilder()

public DisplayDevice.Builder getDisplayDeviceBuilder()

Enables display device for the instance.

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

Returns
TypeDescription
DisplayDevice.Builder

getDisplayDeviceOrBuilder()

public DisplayDeviceOrBuilder getDisplayDeviceOrBuilder()

Enables display device for the instance.

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

Returns
TypeDescription
DisplayDeviceOrBuilder

getFingerprint()

public 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
TypeDescription
String

The fingerprint.

getFingerprintBytes()

public 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
TypeDescription
ByteString

The bytes for fingerprint.

getGuestAccelerators(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig

getGuestAcceleratorsBuilder(int index)

public AcceleratorConfig.Builder getGuestAcceleratorsBuilder(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
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig.Builder

getGuestAcceleratorsBuilderList()

public List<AcceleratorConfig.Builder> getGuestAcceleratorsBuilderList()

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

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

Returns
TypeDescription
List<Builder>

getGuestAcceleratorsCount()

public 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
TypeDescription
int

getGuestAcceleratorsList()

public 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
TypeDescription
List<AcceleratorConfig>

getGuestAcceleratorsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfigOrBuilder

getGuestAcceleratorsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.compute.v1.AcceleratorConfigOrBuilder>

getHostname()

public 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
TypeDescription
String

The hostname.

getHostnameBytes()

public 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
TypeDescription
ByteString

The bytes for hostname.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getKeyRevocationActionType()

public 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
TypeDescription
String

The keyRevocationActionType.

getKeyRevocationActionTypeBytes()

public 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
TypeDescription
ByteString

The bytes for keyRevocationActionType.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getLabelFingerprint()

public 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
TypeDescription
String

The labelFingerprint.

getLabelFingerprintBytes()

public 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
TypeDescription
ByteString

The bytes for labelFingerprint.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

map<string, string> labels = 500195327;

Returns
TypeDescription
int

getLabelsMap()

public 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
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
String

getLastStartTimestamp()

public String getLastStartTimestamp()

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

optional string last_start_timestamp = 443830736;

Returns
TypeDescription
String

The lastStartTimestamp.

getLastStartTimestampBytes()

public ByteString getLastStartTimestampBytes()

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

optional string last_start_timestamp = 443830736;

Returns
TypeDescription
ByteString

The bytes for lastStartTimestamp.

getLastStopTimestamp()

public String getLastStopTimestamp()

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

optional string last_stop_timestamp = 412823010;

Returns
TypeDescription
String

The lastStopTimestamp.

getLastStopTimestampBytes()

public ByteString getLastStopTimestampBytes()

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

optional string last_stop_timestamp = 412823010;

Returns
TypeDescription
ByteString

The bytes for lastStopTimestamp.

getLastSuspendedTimestamp()

public String getLastSuspendedTimestamp()

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

optional string last_suspended_timestamp = 356275337;

Returns
TypeDescription
String

The lastSuspendedTimestamp.

getLastSuspendedTimestampBytes()

public ByteString getLastSuspendedTimestampBytes()

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

optional string last_suspended_timestamp = 356275337;

Returns
TypeDescription
ByteString

The bytes for lastSuspendedTimestamp.

getMachineType()

public 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
TypeDescription
String

The machineType.

getMachineTypeBytes()

public 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
TypeDescription
ByteString

The bytes for machineType.

getMetadata()

public 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
TypeDescription
Metadata

The metadata.

getMetadataBuilder()

public Metadata.Builder getMetadataBuilder()

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
TypeDescription
Metadata.Builder

getMetadataOrBuilder()

public 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
TypeDescription
MetadataOrBuilder

getMinCpuPlatform()

public 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
TypeDescription
String

The minCpuPlatform.

getMinCpuPlatformBytes()

public 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
TypeDescription
ByteString

The bytes for minCpuPlatform.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getNetworkInterfaces(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
NetworkInterface

getNetworkInterfacesBuilder(int index)

public NetworkInterface.Builder getNetworkInterfacesBuilder(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
NameDescription
indexint
Returns
TypeDescription
NetworkInterface.Builder

getNetworkInterfacesBuilderList()

public List<NetworkInterface.Builder> getNetworkInterfacesBuilderList()

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
TypeDescription
List<Builder>

getNetworkInterfacesCount()

public 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
TypeDescription
int

getNetworkInterfacesList()

public 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
TypeDescription
List<NetworkInterface>

getNetworkInterfacesOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
NetworkInterfaceOrBuilder

getNetworkInterfacesOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.compute.v1.NetworkInterfaceOrBuilder>

getNetworkPerformanceConfig()

public NetworkPerformanceConfig getNetworkPerformanceConfig()

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

Returns
TypeDescription
NetworkPerformanceConfig

The networkPerformanceConfig.

getNetworkPerformanceConfigBuilder()

public NetworkPerformanceConfig.Builder getNetworkPerformanceConfigBuilder()

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

Returns
TypeDescription
NetworkPerformanceConfig.Builder

getNetworkPerformanceConfigOrBuilder()

public NetworkPerformanceConfigOrBuilder getNetworkPerformanceConfigOrBuilder()

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

Returns
TypeDescription
NetworkPerformanceConfigOrBuilder

getParams()

public 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
TypeDescription
InstanceParams

The params.

getParamsBuilder()

public InstanceParams.Builder getParamsBuilder()

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
TypeDescription
InstanceParams.Builder

getParamsOrBuilder()

public 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
TypeDescription
InstanceParamsOrBuilder

getPrivateIpv6GoogleAccess()

public 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
TypeDescription
String

The privateIpv6GoogleAccess.

getPrivateIpv6GoogleAccessBytes()

public 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
TypeDescription
ByteString

The bytes for privateIpv6GoogleAccess.

getReservationAffinity()

public ReservationAffinity getReservationAffinity()

Specifies the reservations that this instance can consume from.

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

Returns
TypeDescription
ReservationAffinity

The reservationAffinity.

getReservationAffinityBuilder()

public ReservationAffinity.Builder getReservationAffinityBuilder()

Specifies the reservations that this instance can consume from.

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

Returns
TypeDescription
ReservationAffinity.Builder

getReservationAffinityOrBuilder()

public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Specifies the reservations that this instance can consume from.

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

Returns
TypeDescription
ReservationAffinityOrBuilder

getResourcePolicies(int index)

public String getResourcePolicies(int index)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The resourcePolicies at the given index.

getResourcePoliciesBytes(int index)

public ByteString getResourcePoliciesBytes(int index)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the resourcePolicies at the given index.

getResourcePoliciesCount()

public int getResourcePoliciesCount()

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Returns
TypeDescription
int

The count of resourcePolicies.

getResourcePoliciesList()

public ProtocolStringList getResourcePoliciesList()

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Returns
TypeDescription
ProtocolStringList

A list containing the resourcePolicies.

getResourceStatus()

public 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
TypeDescription
ResourceStatus

The resourceStatus.

getResourceStatusBuilder()

public ResourceStatus.Builder getResourceStatusBuilder()

[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
TypeDescription
ResourceStatus.Builder

getResourceStatusOrBuilder()

public 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
TypeDescription
ResourceStatusOrBuilder

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
TypeDescription
boolean

The satisfiesPzs.

getScheduling()

public Scheduling getScheduling()

Sets the scheduling options for this instance.

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

Returns
TypeDescription
Scheduling

The scheduling.

getSchedulingBuilder()

public Scheduling.Builder getSchedulingBuilder()

Sets the scheduling options for this instance.

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

Returns
TypeDescription
Scheduling.Builder

getSchedulingOrBuilder()

public SchedulingOrBuilder getSchedulingOrBuilder()

Sets the scheduling options for this instance.

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

Returns
TypeDescription
SchedulingOrBuilder
public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getServiceAccounts(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
ServiceAccount

getServiceAccountsBuilder(int index)

public ServiceAccount.Builder getServiceAccountsBuilder(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
NameDescription
indexint
Returns
TypeDescription
ServiceAccount.Builder

getServiceAccountsBuilderList()

public List<ServiceAccount.Builder> getServiceAccountsBuilderList()

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
TypeDescription
List<Builder>

getServiceAccountsCount()

public 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
TypeDescription
int

getServiceAccountsList()

public 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
TypeDescription
List<ServiceAccount>

getServiceAccountsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
ServiceAccountOrBuilder

getServiceAccountsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.compute.v1.ServiceAccountOrBuilder>

getShieldedInstanceConfig()

public ShieldedInstanceConfig getShieldedInstanceConfig()

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

Returns
TypeDescription
ShieldedInstanceConfig

The shieldedInstanceConfig.

getShieldedInstanceConfigBuilder()

public ShieldedInstanceConfig.Builder getShieldedInstanceConfigBuilder()

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

Returns
TypeDescription
ShieldedInstanceConfig.Builder

getShieldedInstanceConfigOrBuilder()

public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

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

Returns
TypeDescription
ShieldedInstanceConfigOrBuilder

getShieldedInstanceIntegrityPolicy()

public ShieldedInstanceIntegrityPolicy getShieldedInstanceIntegrityPolicy()

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

Returns
TypeDescription
ShieldedInstanceIntegrityPolicy

The shieldedInstanceIntegrityPolicy.

getShieldedInstanceIntegrityPolicyBuilder()

public ShieldedInstanceIntegrityPolicy.Builder getShieldedInstanceIntegrityPolicyBuilder()

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

Returns
TypeDescription
ShieldedInstanceIntegrityPolicy.Builder

getShieldedInstanceIntegrityPolicyOrBuilder()

public ShieldedInstanceIntegrityPolicyOrBuilder getShieldedInstanceIntegrityPolicyOrBuilder()

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

Returns
TypeDescription
ShieldedInstanceIntegrityPolicyOrBuilder

getSourceMachineImage()

public String getSourceMachineImage()

Source machine image

optional string source_machine_image = 21769791;

Returns
TypeDescription
String

The sourceMachineImage.

getSourceMachineImageBytes()

public ByteString getSourceMachineImageBytes()

Source machine image

optional string source_machine_image = 21769791;

Returns
TypeDescription
ByteString

The bytes for sourceMachineImage.

getSourceMachineImageEncryptionKey()

public 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
TypeDescription
CustomerEncryptionKey

The sourceMachineImageEncryptionKey.

getSourceMachineImageEncryptionKeyBuilder()

public CustomerEncryptionKey.Builder getSourceMachineImageEncryptionKeyBuilder()

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
TypeDescription
CustomerEncryptionKey.Builder

getSourceMachineImageEncryptionKeyOrBuilder()

public 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
TypeDescription
CustomerEncryptionKeyOrBuilder

getStartRestricted()

public 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
TypeDescription
boolean

The startRestricted.

getStatus()

public 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
TypeDescription
String

The status.

getStatusBytes()

public 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
TypeDescription
ByteString

The bytes for status.

getStatusMessage()

public String getStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

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

optional string status_message = 297428154;

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getTags()

public 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
TypeDescription
Tags

The tags.

getTagsBuilder()

public Tags.Builder getTagsBuilder()

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
TypeDescription
Tags.Builder

getTagsOrBuilder()

public 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
TypeDescription
TagsOrBuilder

getZone()

public 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
TypeDescription
String

The zone.

getZoneBytes()

public 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
TypeDescription
ByteString

The bytes for zone.

hasAdvancedMachineFeatures()

public boolean hasAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns
TypeDescription
boolean

Whether the advancedMachineFeatures field is set.

hasCanIpForward()

public 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
TypeDescription
boolean

Whether the canIpForward field is set.

hasConfidentialInstanceConfig()

public boolean hasConfidentialInstanceConfig()

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

Returns
TypeDescription
boolean

Whether the confidentialInstanceConfig field is set.

hasCpuPlatform()

public boolean hasCpuPlatform()

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

optional string cpu_platform = 410285354;

Returns
TypeDescription
boolean

Whether the cpuPlatform field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDeletionProtection()

public boolean hasDeletionProtection()

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
TypeDescription
boolean

Whether the deletionProtection field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasDisplayDevice()

public boolean hasDisplayDevice()

Enables display device for the instance.

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

Returns
TypeDescription
boolean

Whether the displayDevice field is set.

hasFingerprint()

public 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
TypeDescription
boolean

Whether the fingerprint field is set.

hasHostname()

public 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
TypeDescription
boolean

Whether the hostname field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKeyRevocationActionType()

public 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
TypeDescription
boolean

Whether the keyRevocationActionType field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasLabelFingerprint()

public 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
TypeDescription
boolean

Whether the labelFingerprint field is set.

hasLastStartTimestamp()

public boolean hasLastStartTimestamp()

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

optional string last_start_timestamp = 443830736;

Returns
TypeDescription
boolean

Whether the lastStartTimestamp field is set.

hasLastStopTimestamp()

public boolean hasLastStopTimestamp()

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

optional string last_stop_timestamp = 412823010;

Returns
TypeDescription
boolean

Whether the lastStopTimestamp field is set.

hasLastSuspendedTimestamp()

public boolean hasLastSuspendedTimestamp()

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

optional string last_suspended_timestamp = 356275337;

Returns
TypeDescription
boolean

Whether the lastSuspendedTimestamp field is set.

hasMachineType()

public 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
TypeDescription
boolean

Whether the machineType field is set.

hasMetadata()

public 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
TypeDescription
boolean

Whether the metadata field is set.

hasMinCpuPlatform()

public 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
TypeDescription
boolean

Whether the minCpuPlatform field is set.

hasName()

public 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
TypeDescription
boolean

Whether the name field is set.

hasNetworkPerformanceConfig()

public boolean hasNetworkPerformanceConfig()

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

Returns
TypeDescription
boolean

Whether the networkPerformanceConfig field is set.

hasParams()

public 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
TypeDescription
boolean

Whether the params field is set.

hasPrivateIpv6GoogleAccess()

public 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
TypeDescription
boolean

Whether the privateIpv6GoogleAccess field is set.

hasReservationAffinity()

public boolean hasReservationAffinity()

Specifies the reservations that this instance can consume from.

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

Returns
TypeDescription
boolean

Whether the reservationAffinity field is set.

hasResourceStatus()

public 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
TypeDescription
boolean

Whether the resourceStatus field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
TypeDescription
boolean

Whether the satisfiesPzs field is set.

hasScheduling()

public boolean hasScheduling()

Sets the scheduling options for this instance.

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

Returns
TypeDescription
boolean

Whether the scheduling field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasShieldedInstanceConfig()

public boolean hasShieldedInstanceConfig()

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

Returns
TypeDescription
boolean

Whether the shieldedInstanceConfig field is set.

hasShieldedInstanceIntegrityPolicy()

public boolean hasShieldedInstanceIntegrityPolicy()

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

Returns
TypeDescription
boolean

Whether the shieldedInstanceIntegrityPolicy field is set.

hasSourceMachineImage()

public boolean hasSourceMachineImage()

Source machine image

optional string source_machine_image = 21769791;

Returns
TypeDescription
boolean

Whether the sourceMachineImage field is set.

hasSourceMachineImageEncryptionKey()

public 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
TypeDescription
boolean

Whether the sourceMachineImageEncryptionKey field is set.

hasStartRestricted()

public 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
TypeDescription
boolean

Whether the startRestricted field is set.

hasStatus()

public 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
TypeDescription
boolean

Whether the status field is set.

hasStatusMessage()

public boolean hasStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
boolean

Whether the statusMessage field is set.

hasTags()

public 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
TypeDescription
boolean

Whether the tags field is set.

hasZone()

public 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
TypeDescription
boolean

Whether the zone field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAdvancedMachineFeatures(AdvancedMachineFeatures value)

public Instance.Builder mergeAdvancedMachineFeatures(AdvancedMachineFeatures value)

Controls for advanced machine-related behavior features.

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

Parameter
NameDescription
valueAdvancedMachineFeatures
Returns
TypeDescription
Instance.Builder

mergeConfidentialInstanceConfig(ConfidentialInstanceConfig value)

public Instance.Builder mergeConfidentialInstanceConfig(ConfidentialInstanceConfig value)

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

Parameter
NameDescription
valueConfidentialInstanceConfig
Returns
TypeDescription
Instance.Builder

mergeDisplayDevice(DisplayDevice value)

public Instance.Builder mergeDisplayDevice(DisplayDevice value)

Enables display device for the instance.

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

Parameter
NameDescription
valueDisplayDevice
Returns
TypeDescription
Instance.Builder

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)
Parameter
NameDescription
otherInstance
Returns
TypeDescription
Instance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Instance.Builder
Overrides

mergeMetadata(Metadata value)

public Instance.Builder mergeMetadata(Metadata value)

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

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

Parameter
NameDescription
valueMetadata
Returns
TypeDescription
Instance.Builder

mergeNetworkPerformanceConfig(NetworkPerformanceConfig value)

public Instance.Builder mergeNetworkPerformanceConfig(NetworkPerformanceConfig value)

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

Parameter
NameDescription
valueNetworkPerformanceConfig
Returns
TypeDescription
Instance.Builder

mergeParams(InstanceParams value)

public Instance.Builder mergeParams(InstanceParams value)

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;

Parameter
NameDescription
valueInstanceParams
Returns
TypeDescription
Instance.Builder

mergeReservationAffinity(ReservationAffinity value)

public Instance.Builder mergeReservationAffinity(ReservationAffinity value)

Specifies the reservations that this instance can consume from.

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

Parameter
NameDescription
valueReservationAffinity
Returns
TypeDescription
Instance.Builder

mergeResourceStatus(ResourceStatus value)

public Instance.Builder mergeResourceStatus(ResourceStatus value)

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

Parameter
NameDescription
valueResourceStatus
Returns
TypeDescription
Instance.Builder

mergeScheduling(Scheduling value)

public Instance.Builder mergeScheduling(Scheduling value)

Sets the scheduling options for this instance.

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

Parameter
NameDescription
valueScheduling
Returns
TypeDescription
Instance.Builder

mergeShieldedInstanceConfig(ShieldedInstanceConfig value)

public Instance.Builder mergeShieldedInstanceConfig(ShieldedInstanceConfig value)

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

Parameter
NameDescription
valueShieldedInstanceConfig
Returns
TypeDescription
Instance.Builder

mergeShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy value)

public Instance.Builder mergeShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy value)

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

Parameter
NameDescription
valueShieldedInstanceIntegrityPolicy
Returns
TypeDescription
Instance.Builder

mergeSourceMachineImageEncryptionKey(CustomerEncryptionKey value)

public Instance.Builder mergeSourceMachineImageEncryptionKey(CustomerEncryptionKey value)

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;

Parameter
NameDescription
valueCustomerEncryptionKey
Returns
TypeDescription
Instance.Builder

mergeTags(Tags value)

public Instance.Builder mergeTags(Tags value)

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;

Parameter
NameDescription
valueTags
Returns
TypeDescription
Instance.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Instance.Builder
Overrides

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

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

map<string, string> labels = 500195327;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Instance.Builder

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

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

map<string, string> labels = 500195327;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Instance.Builder

removeDisks(int index)

public Instance.Builder removeDisks(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
NameDescription
indexint
Returns
TypeDescription
Instance.Builder

removeGuestAccelerators(int index)

public Instance.Builder removeGuestAccelerators(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
NameDescription
indexint
Returns
TypeDescription
Instance.Builder

removeLabels(String key)

public Instance.Builder removeLabels(String key)

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

map<string, string> labels = 500195327;

Parameter
NameDescription
keyString
Returns
TypeDescription
Instance.Builder

removeNetworkInterfaces(int index)

public Instance.Builder removeNetworkInterfaces(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
NameDescription
indexint
Returns
TypeDescription
Instance.Builder

removeServiceAccounts(int index)

public Instance.Builder removeServiceAccounts(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
NameDescription
indexint
Returns
TypeDescription
Instance.Builder

setAdvancedMachineFeatures(AdvancedMachineFeatures value)

public Instance.Builder setAdvancedMachineFeatures(AdvancedMachineFeatures value)

Controls for advanced machine-related behavior features.

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

Parameter
NameDescription
valueAdvancedMachineFeatures
Returns
TypeDescription
Instance.Builder

setAdvancedMachineFeatures(AdvancedMachineFeatures.Builder builderForValue)

public Instance.Builder setAdvancedMachineFeatures(AdvancedMachineFeatures.Builder builderForValue)

Controls for advanced machine-related behavior features.

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

Parameter
NameDescription
builderForValueAdvancedMachineFeatures.Builder
Returns
TypeDescription
Instance.Builder

setCanIpForward(boolean value)

public Instance.Builder setCanIpForward(boolean value)

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;

Parameter
NameDescription
valueboolean

The canIpForward to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setConfidentialInstanceConfig(ConfidentialInstanceConfig value)

public Instance.Builder setConfidentialInstanceConfig(ConfidentialInstanceConfig value)

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

Parameter
NameDescription
valueConfidentialInstanceConfig
Returns
TypeDescription
Instance.Builder

setConfidentialInstanceConfig(ConfidentialInstanceConfig.Builder builderForValue)

public Instance.Builder setConfidentialInstanceConfig(ConfidentialInstanceConfig.Builder builderForValue)

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

Parameter
NameDescription
builderForValueConfidentialInstanceConfig.Builder
Returns
TypeDescription
Instance.Builder

setCpuPlatform(String value)

public Instance.Builder setCpuPlatform(String value)

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

optional string cpu_platform = 410285354;

Parameter
NameDescription
valueString

The cpuPlatform to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setCpuPlatformBytes(ByteString value)

public Instance.Builder setCpuPlatformBytes(ByteString value)

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

optional string cpu_platform = 410285354;

Parameter
NameDescription
valueByteString

The bytes for cpuPlatform to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setCreationTimestamp(String value)

public Instance.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Instance.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setDeletionProtection(boolean value)

public Instance.Builder setDeletionProtection(boolean value)

Whether the resource should be protected against deletion.

optional bool deletion_protection = 458014698;

Parameter
NameDescription
valueboolean

The deletionProtection to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setDescription(String value)

public Instance.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Instance.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setDisks(int index, AttachedDisk value)

public Instance.Builder setDisks(int index, AttachedDisk value)

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;

Parameters
NameDescription
indexint
valueAttachedDisk
Returns
TypeDescription
Instance.Builder

setDisks(int index, AttachedDisk.Builder builderForValue)

public Instance.Builder setDisks(int index, AttachedDisk.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueAttachedDisk.Builder
Returns
TypeDescription
Instance.Builder

setDisplayDevice(DisplayDevice value)

public Instance.Builder setDisplayDevice(DisplayDevice value)

Enables display device for the instance.

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

Parameter
NameDescription
valueDisplayDevice
Returns
TypeDescription
Instance.Builder

setDisplayDevice(DisplayDevice.Builder builderForValue)

public Instance.Builder setDisplayDevice(DisplayDevice.Builder builderForValue)

Enables display device for the instance.

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

Parameter
NameDescription
builderForValueDisplayDevice.Builder
Returns
TypeDescription
Instance.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

setFingerprint(String value)

public Instance.Builder setFingerprint(String value)

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;

Parameter
NameDescription
valueString

The fingerprint to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public Instance.Builder setFingerprintBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for fingerprint to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setGuestAccelerators(int index, AcceleratorConfig value)

public Instance.Builder setGuestAccelerators(int index, AcceleratorConfig value)

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

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

Parameters
NameDescription
indexint
valueAcceleratorConfig
Returns
TypeDescription
Instance.Builder

setGuestAccelerators(int index, AcceleratorConfig.Builder builderForValue)

public Instance.Builder setGuestAccelerators(int index, AcceleratorConfig.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueAcceleratorConfig.Builder
Returns
TypeDescription
Instance.Builder

setHostname(String value)

public Instance.Builder setHostname(String value)

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;

Parameter
NameDescription
valueString

The hostname to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setHostnameBytes(ByteString value)

public Instance.Builder setHostnameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for hostname to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setId(long value)

public Instance.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setKeyRevocationActionType(String value)

public Instance.Builder setKeyRevocationActionType(String value)

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;

Parameter
NameDescription
valueString

The keyRevocationActionType to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setKeyRevocationActionTypeBytes(ByteString value)

public Instance.Builder setKeyRevocationActionTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for keyRevocationActionType to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setKind(String value)

public Instance.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Instance.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLabelFingerprint(String value)

public Instance.Builder setLabelFingerprint(String value)

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;

Parameter
NameDescription
valueString

The labelFingerprint to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public Instance.Builder setLabelFingerprintBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for labelFingerprint to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLastStartTimestamp(String value)

public Instance.Builder setLastStartTimestamp(String value)

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

optional string last_start_timestamp = 443830736;

Parameter
NameDescription
valueString

The lastStartTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLastStartTimestampBytes(ByteString value)

public Instance.Builder setLastStartTimestampBytes(ByteString value)

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

optional string last_start_timestamp = 443830736;

Parameter
NameDescription
valueByteString

The bytes for lastStartTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLastStopTimestamp(String value)

public Instance.Builder setLastStopTimestamp(String value)

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

optional string last_stop_timestamp = 412823010;

Parameter
NameDescription
valueString

The lastStopTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLastStopTimestampBytes(ByteString value)

public Instance.Builder setLastStopTimestampBytes(ByteString value)

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

optional string last_stop_timestamp = 412823010;

Parameter
NameDescription
valueByteString

The bytes for lastStopTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLastSuspendedTimestamp(String value)

public Instance.Builder setLastSuspendedTimestamp(String value)

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

optional string last_suspended_timestamp = 356275337;

Parameter
NameDescription
valueString

The lastSuspendedTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setLastSuspendedTimestampBytes(ByteString value)

public Instance.Builder setLastSuspendedTimestampBytes(ByteString value)

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

optional string last_suspended_timestamp = 356275337;

Parameter
NameDescription
valueByteString

The bytes for lastSuspendedTimestamp to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setMachineType(String value)

public Instance.Builder setMachineType(String value)

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;

Parameter
NameDescription
valueString

The machineType to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setMachineTypeBytes(ByteString value)

public Instance.Builder setMachineTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for machineType to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setMetadata(Metadata value)

public Instance.Builder setMetadata(Metadata value)

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

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

Parameter
NameDescription
valueMetadata
Returns
TypeDescription
Instance.Builder

setMetadata(Metadata.Builder builderForValue)

public Instance.Builder setMetadata(Metadata.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueMetadata.Builder
Returns
TypeDescription
Instance.Builder

setMinCpuPlatform(String value)

public Instance.Builder setMinCpuPlatform(String value)

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;

Parameter
NameDescription
valueString

The minCpuPlatform to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setMinCpuPlatformBytes(ByteString value)

public Instance.Builder setMinCpuPlatformBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for minCpuPlatform to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setName(String value)

public Instance.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setNetworkInterfaces(int index, NetworkInterface value)

public Instance.Builder setNetworkInterfaces(int index, NetworkInterface value)

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;

Parameters
NameDescription
indexint
valueNetworkInterface
Returns
TypeDescription
Instance.Builder

setNetworkInterfaces(int index, NetworkInterface.Builder builderForValue)

public Instance.Builder setNetworkInterfaces(int index, NetworkInterface.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueNetworkInterface.Builder
Returns
TypeDescription
Instance.Builder

setNetworkPerformanceConfig(NetworkPerformanceConfig value)

public Instance.Builder setNetworkPerformanceConfig(NetworkPerformanceConfig value)

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

Parameter
NameDescription
valueNetworkPerformanceConfig
Returns
TypeDescription
Instance.Builder

setNetworkPerformanceConfig(NetworkPerformanceConfig.Builder builderForValue)

public Instance.Builder setNetworkPerformanceConfig(NetworkPerformanceConfig.Builder builderForValue)

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

Parameter
NameDescription
builderForValueNetworkPerformanceConfig.Builder
Returns
TypeDescription
Instance.Builder

setParams(InstanceParams value)

public Instance.Builder setParams(InstanceParams value)

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;

Parameter
NameDescription
valueInstanceParams
Returns
TypeDescription
Instance.Builder

setParams(InstanceParams.Builder builderForValue)

public Instance.Builder setParams(InstanceParams.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueInstanceParams.Builder
Returns
TypeDescription
Instance.Builder

setPrivateIpv6GoogleAccess(String value)

public Instance.Builder setPrivateIpv6GoogleAccess(String value)

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;

Parameter
NameDescription
valueString

The privateIpv6GoogleAccess to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setPrivateIpv6GoogleAccessBytes(ByteString value)

public Instance.Builder setPrivateIpv6GoogleAccessBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for privateIpv6GoogleAccess to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

setReservationAffinity(ReservationAffinity value)

public Instance.Builder setReservationAffinity(ReservationAffinity value)

Specifies the reservations that this instance can consume from.

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

Parameter
NameDescription
valueReservationAffinity
Returns
TypeDescription
Instance.Builder

setReservationAffinity(ReservationAffinity.Builder builderForValue)

public Instance.Builder setReservationAffinity(ReservationAffinity.Builder builderForValue)

Specifies the reservations that this instance can consume from.

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

Parameter
NameDescription
builderForValueReservationAffinity.Builder
Returns
TypeDescription
Instance.Builder

setResourcePolicies(int index, String value)

public Instance.Builder setResourcePolicies(int index, String value)

Resource policies applied to this instance.

repeated string resource_policies = 22220385;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The resourcePolicies to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setResourceStatus(ResourceStatus value)

public Instance.Builder setResourceStatus(ResourceStatus value)

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

Parameter
NameDescription
valueResourceStatus
Returns
TypeDescription
Instance.Builder

setResourceStatus(ResourceStatus.Builder builderForValue)

public Instance.Builder setResourceStatus(ResourceStatus.Builder builderForValue)

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

Parameter
NameDescription
builderForValueResourceStatus.Builder
Returns
TypeDescription
Instance.Builder

setSatisfiesPzs(boolean value)

public Instance.Builder setSatisfiesPzs(boolean value)

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Parameter
NameDescription
valueboolean

The satisfiesPzs to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setScheduling(Scheduling value)

public Instance.Builder setScheduling(Scheduling value)

Sets the scheduling options for this instance.

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

Parameter
NameDescription
valueScheduling
Returns
TypeDescription
Instance.Builder

setScheduling(Scheduling.Builder builderForValue)

public Instance.Builder setScheduling(Scheduling.Builder builderForValue)

Sets the scheduling options for this instance.

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

Parameter
NameDescription
builderForValueScheduling.Builder
Returns
TypeDescription
Instance.Builder
public Instance.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Instance.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setServiceAccounts(int index, ServiceAccount value)

public Instance.Builder setServiceAccounts(int index, ServiceAccount value)

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;

Parameters
NameDescription
indexint
valueServiceAccount
Returns
TypeDescription
Instance.Builder

setServiceAccounts(int index, ServiceAccount.Builder builderForValue)

public Instance.Builder setServiceAccounts(int index, ServiceAccount.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueServiceAccount.Builder
Returns
TypeDescription
Instance.Builder

setShieldedInstanceConfig(ShieldedInstanceConfig value)

public Instance.Builder setShieldedInstanceConfig(ShieldedInstanceConfig value)

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

Parameter
NameDescription
valueShieldedInstanceConfig
Returns
TypeDescription
Instance.Builder

setShieldedInstanceConfig(ShieldedInstanceConfig.Builder builderForValue)

public Instance.Builder setShieldedInstanceConfig(ShieldedInstanceConfig.Builder builderForValue)

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

Parameter
NameDescription
builderForValueShieldedInstanceConfig.Builder
Returns
TypeDescription
Instance.Builder

setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy value)

public Instance.Builder setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy value)

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

Parameter
NameDescription
valueShieldedInstanceIntegrityPolicy
Returns
TypeDescription
Instance.Builder

setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy.Builder builderForValue)

public Instance.Builder setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy.Builder builderForValue)

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

Parameter
NameDescription
builderForValueShieldedInstanceIntegrityPolicy.Builder
Returns
TypeDescription
Instance.Builder

setSourceMachineImage(String value)

public Instance.Builder setSourceMachineImage(String value)

Source machine image

optional string source_machine_image = 21769791;

Parameter
NameDescription
valueString

The sourceMachineImage to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setSourceMachineImageBytes(ByteString value)

public Instance.Builder setSourceMachineImageBytes(ByteString value)

Source machine image

optional string source_machine_image = 21769791;

Parameter
NameDescription
valueByteString

The bytes for sourceMachineImage to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setSourceMachineImageEncryptionKey(CustomerEncryptionKey value)

public Instance.Builder setSourceMachineImageEncryptionKey(CustomerEncryptionKey value)

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;

Parameter
NameDescription
valueCustomerEncryptionKey
Returns
TypeDescription
Instance.Builder

setSourceMachineImageEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

public Instance.Builder setSourceMachineImageEncryptionKey(CustomerEncryptionKey.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueCustomerEncryptionKey.Builder
Returns
TypeDescription
Instance.Builder

setStartRestricted(boolean value)

public Instance.Builder setStartRestricted(boolean value)

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

optional bool start_restricted = 123693144;

Parameter
NameDescription
valueboolean

The startRestricted to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStatus(String value)

public Instance.Builder setStatus(String value)

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

Parameter
NameDescription
valueString

The status to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStatusBytes(ByteString value)

public Instance.Builder setStatusBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for status to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStatusMessage(String value)

public Instance.Builder setStatusMessage(String value)

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

optional string status_message = 297428154;

Parameter
NameDescription
valueString

The statusMessage to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value)

public Instance.Builder setStatusMessageBytes(ByteString value)

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

optional string status_message = 297428154;

Parameter
NameDescription
valueByteString

The bytes for statusMessage to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setTags(Tags value)

public Instance.Builder setTags(Tags value)

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;

Parameter
NameDescription
valueTags
Returns
TypeDescription
Instance.Builder

setTags(Tags.Builder builderForValue)

public Instance.Builder setTags(Tags.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueTags.Builder
Returns
TypeDescription
Instance.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Instance.Builder
Overrides

setZone(String value)

public Instance.Builder setZone(String value)

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

Parameter
NameDescription
valueString

The zone to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public Instance.Builder setZoneBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for zone to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.