Interface InstancePropertiesOrBuilder (1.6.0-beta)

public interface InstancePropertiesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels to apply to instances that are created from these properties.

map<string, string> labels = 500195327;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAdvancedMachineFeatures()

public abstract AdvancedMachineFeatures getAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns

Type	Description
AdvancedMachineFeatures	The advancedMachineFeatures.

getAdvancedMachineFeaturesOrBuilder()

public abstract AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

Controls for advanced machine-related behavior features.

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

Returns

Type	Description
AdvancedMachineFeaturesOrBuilder

getCanIpForward()

public abstract boolean getCanIpForward()

Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

optional bool can_ip_forward = 467731324;

Returns

Type	Description
boolean	The canIpForward.

getConfidentialInstanceConfig()

public abstract ConfidentialInstanceConfig getConfidentialInstanceConfig()

Specifies the Confidential Instance options.

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

Returns

Type	Description
ConfidentialInstanceConfig	The confidentialInstanceConfig.

getConfidentialInstanceConfigOrBuilder()

public abstract ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()

Specifies the Confidential Instance options.

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

Returns

Type	Description
ConfidentialInstanceConfigOrBuilder

getDescription()

public abstract String getDescription()

An optional text description for the instances that are created from these properties.

optional string description = 422937596;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional text description for the instances that are created from these properties.

optional string description = 422937596;

Returns

Type	Description
ByteString	The bytes for description.

getDisks(int index)

public abstract AttachedDisk getDisks(int index)

An array of disks that are associated with the instances that are created from these properties.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
AttachedDisk

getDisksCount()

public abstract int getDisksCount()

An array of disks that are associated with the instances that are created from these properties.

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

Returns

Type	Description
int

getDisksList()

public abstract List<AttachedDisk> getDisksList()

An array of disks that are associated with the instances that are created from these properties.

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

Returns

Type	Description
List<AttachedDisk>

getDisksOrBuilder(int index)

public abstract AttachedDiskOrBuilder getDisksOrBuilder(int index)

An array of disks that are associated with the instances that are created from these properties.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
AttachedDiskOrBuilder

getDisksOrBuilderList()

public abstract List<? extends AttachedDiskOrBuilder> getDisksOrBuilderList()

An array of disks that are associated with the instances that are created from these properties.

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

Returns

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

getGuestAccelerators(int index)

public abstract AcceleratorConfig getGuestAccelerators(int index)

A list of guest accelerator cards' type and count to use for instances created from these properties.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
AcceleratorConfig

getGuestAcceleratorsCount()

public abstract int getGuestAcceleratorsCount()

A list of guest accelerator cards' type and count to use for instances created from these properties.

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

Returns

Type	Description
int

getGuestAcceleratorsList()

public abstract List<AcceleratorConfig> getGuestAcceleratorsList()

A list of guest accelerator cards' type and count to use for instances created from these properties.

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

Returns

Type	Description
List<AcceleratorConfig>

getGuestAcceleratorsOrBuilder(int index)

public abstract AcceleratorConfigOrBuilder getGuestAcceleratorsOrBuilder(int index)

A list of guest accelerator cards' type and count to use for instances created from these properties.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
AcceleratorConfigOrBuilder

getGuestAcceleratorsOrBuilderList()

public abstract List<? extends AcceleratorConfigOrBuilder> getGuestAcceleratorsOrBuilderList()

A list of guest accelerator cards' type and count to use for instances created from these properties.

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

Returns

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

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to instances that are created from these properties.

map<string, string> labels = 500195327;

Returns

Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels to apply to instances that are created from these properties.

map<string, string> labels = 500195327;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to instances that are created from these properties.

map<string, string> labels = 500195327;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels to apply to instances that are created from these properties.

map<string, string> labels = 500195327;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getMachineType()

public abstract String getMachineType()

The machine type to use for instances that are created from these properties.

optional string machine_type = 227711026;

Returns

Type	Description
String	The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

The machine type to use for instances that are created from these properties.

optional string machine_type = 227711026;

Returns

Type	Description
ByteString	The bytes for machineType.

getMetadata()

public abstract Metadata getMetadata()

The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

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

Returns

Type	Description
Metadata	The metadata.

getMetadataOrBuilder()

public abstract MetadataOrBuilder getMetadataOrBuilder()

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

Returns

Type	Description
MetadataOrBuilder

getMinCpuPlatform()

public abstract String getMinCpuPlatform()

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

optional string min_cpu_platform = 242912759;

Returns

Type	Description
String	The minCpuPlatform.

getMinCpuPlatformBytes()

public abstract ByteString getMinCpuPlatformBytes()

optional string min_cpu_platform = 242912759;

Returns

Type	Description
ByteString	The bytes for minCpuPlatform.

getNetworkInterfaces(int index)

public abstract NetworkInterface getNetworkInterfaces(int index)

An array of network access configurations for this interface.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
NetworkInterface

getNetworkInterfacesCount()

public abstract int getNetworkInterfacesCount()

An array of network access configurations for this interface.

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

Returns

Type	Description
int

getNetworkInterfacesList()

public abstract List<NetworkInterface> getNetworkInterfacesList()

An array of network access configurations for this interface.

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

Returns

Type	Description
List<NetworkInterface>

getNetworkInterfacesOrBuilder(int index)

public abstract NetworkInterfaceOrBuilder getNetworkInterfacesOrBuilder(int index)

An array of network access configurations for this interface.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
NetworkInterfaceOrBuilder

getNetworkInterfacesOrBuilderList()

public abstract List<? extends NetworkInterfaceOrBuilder> getNetworkInterfacesOrBuilderList()

An array of network access configurations for this interface.

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

Returns

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

getPrivateIpv6GoogleAccess()

public abstract String getPrivateIpv6GoogleAccess()

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

optional string private_ipv6_google_access = 48277006;

Returns

Type	Description
String	The privateIpv6GoogleAccess.

getPrivateIpv6GoogleAccessBytes()

public abstract ByteString getPrivateIpv6GoogleAccessBytes()

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

optional string private_ipv6_google_access = 48277006;

Returns

Type	Description
ByteString	The bytes for privateIpv6GoogleAccess.

getReservationAffinity()

public abstract ReservationAffinity getReservationAffinity()

Specifies the reservations that instances can consume from.

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

Returns

Type	Description
ReservationAffinity	The reservationAffinity.

getReservationAffinityOrBuilder()

public abstract ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Specifies the reservations that instances can consume from.

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

Returns

Type	Description
ReservationAffinityOrBuilder

getResourcePolicies(int index)

public abstract String getResourcePolicies(int index)

Resource policies (names, not ULRs) applied to instances created from these properties.

repeated string resource_policies = 22220385;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The resourcePolicies at the given index.

getResourcePoliciesBytes(int index)

public abstract ByteString getResourcePoliciesBytes(int index)

Resource policies (names, not ULRs) applied to instances created from these properties.

repeated string resource_policies = 22220385;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the resourcePolicies at the given index.

getResourcePoliciesCount()

public abstract int getResourcePoliciesCount()

Resource policies (names, not ULRs) applied to instances created from these properties.

repeated string resource_policies = 22220385;

Returns

Type	Description
int	The count of resourcePolicies.

getResourcePoliciesList()

public abstract List<String> getResourcePoliciesList()

Resource policies (names, not ULRs) applied to instances created from these properties.

repeated string resource_policies = 22220385;

Returns

Type	Description
List<String>	A list containing the resourcePolicies.

getScheduling()

public abstract Scheduling getScheduling()

Specifies the scheduling options for the instances that are created from these properties.

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

Returns

Type	Description
Scheduling	The scheduling.

getSchedulingOrBuilder()

public abstract SchedulingOrBuilder getSchedulingOrBuilder()

Specifies the scheduling options for the instances that are created from these properties.

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

Returns

Type	Description
SchedulingOrBuilder

getServiceAccounts(int index)

public abstract ServiceAccount getServiceAccounts(int index)

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
ServiceAccount

getServiceAccountsCount()

public abstract int getServiceAccountsCount()

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

Returns

Type	Description
int

getServiceAccountsList()

public abstract List<ServiceAccount> getServiceAccountsList()

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

Returns

Type	Description
List<ServiceAccount>

getServiceAccountsOrBuilder(int index)

public abstract ServiceAccountOrBuilder getServiceAccountsOrBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
ServiceAccountOrBuilder

getServiceAccountsOrBuilderList()

public abstract List<? extends ServiceAccountOrBuilder> getServiceAccountsOrBuilderList()

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

Returns

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

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

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

Returns

Type	Description
ShieldedInstanceConfig	The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

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

Returns

Type	Description
ShieldedInstanceConfigOrBuilder

getTags()

public abstract Tags getTags()

A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

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

Returns

Type	Description
Tags	The tags.

getTagsOrBuilder()

public abstract TagsOrBuilder getTagsOrBuilder()

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

Returns

Type	Description
TagsOrBuilder

hasAdvancedMachineFeatures()

public abstract boolean hasAdvancedMachineFeatures()

Controls for advanced machine-related behavior features.

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

Returns

Type	Description
boolean	Whether the advancedMachineFeatures field is set.

hasCanIpForward()

public abstract boolean hasCanIpForward()

optional bool can_ip_forward = 467731324;

Returns

Type	Description
boolean	Whether the canIpForward field is set.

hasConfidentialInstanceConfig()

public abstract boolean hasConfidentialInstanceConfig()

Specifies the Confidential Instance options.

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

Returns

Type	Description
boolean	Whether the confidentialInstanceConfig field is set.

hasDescription()

public abstract boolean hasDescription()

An optional text description for the instances that are created from these properties.

optional string description = 422937596;

Returns

Type	Description
boolean	Whether the description field is set.

hasMachineType()

public abstract boolean hasMachineType()

The machine type to use for instances that are created from these properties.

optional string machine_type = 227711026;

Returns

Type	Description
boolean	Whether the machineType field is set.

hasMetadata()

public abstract boolean hasMetadata()

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

Returns

Type	Description
boolean	Whether the metadata field is set.

hasMinCpuPlatform()

public abstract boolean hasMinCpuPlatform()

optional string min_cpu_platform = 242912759;

Returns

Type	Description
boolean	Whether the minCpuPlatform field is set.

hasPrivateIpv6GoogleAccess()

public abstract boolean hasPrivateIpv6GoogleAccess()

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

optional string private_ipv6_google_access = 48277006;

Returns

Type	Description
boolean	Whether the privateIpv6GoogleAccess field is set.

hasReservationAffinity()

public abstract boolean hasReservationAffinity()

Specifies the reservations that instances can consume from.

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

Returns

Type	Description
boolean	Whether the reservationAffinity field is set.

hasScheduling()

public abstract boolean hasScheduling()

Specifies the scheduling options for the instances that are created from these properties.

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

Returns

Type	Description
boolean	Whether the scheduling field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

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

Returns

Type	Description
boolean	Whether the shieldedInstanceConfig field is set.

hasTags()

public abstract boolean hasTags()

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

Returns

Type	Description
boolean	Whether the tags field is set.