Interface SourceInstancePropertiesOrBuilder (1.46.0)

Version 1.46.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface SourceInstancePropertiesOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels to apply to instances that are created from this machine image.

map<string, string> labels = 500195327;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCanIpForward()

public abstract boolean getCanIpForward()

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

optional bool can_ip_forward = 467731324;

Returns
Type	Description
boolean	The canIpForward.

getDeletionProtection()

public abstract boolean getDeletionProtection()

Whether the instance created from this machine image should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
Type	Description
boolean	The deletionProtection.

getDescription()

public abstract String getDescription()

An optional text description for the instances that are created from this machine image.

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 this machine image.

optional string description = 422937596;

Returns
Type	Description
ByteString	The bytes for description.

getDisks(int index)

public abstract SavedAttachedDisk getDisks(int index)

An array of disks that are associated with the instances that are created from this machine image.

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

Parameter
Name	Description
index	int

Returns
Type	Description
SavedAttachedDisk

getDisksCount()

public abstract int getDisksCount()

An array of disks that are associated with the instances that are created from this machine image.

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

Returns
Type	Description
int

getDisksList()

public abstract List<SavedAttachedDisk> getDisksList()

An array of disks that are associated with the instances that are created from this machine image.

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

Returns
Type	Description
List<SavedAttachedDisk>

getDisksOrBuilder(int index)

public abstract SavedAttachedDiskOrBuilder getDisksOrBuilder(int index)

An array of disks that are associated with the instances that are created from this machine image.

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

Parameter
Name	Description
index	int

Returns
Type	Description
SavedAttachedDiskOrBuilder

getDisksOrBuilderList()

public abstract List<? extends SavedAttachedDiskOrBuilder> getDisksOrBuilderList()

An array of disks that are associated with the instances that are created from this machine image.

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

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

getGuestAccelerators(int index)

public abstract AcceleratorConfig getGuestAccelerators(int index)

A list of guest accelerator cards' type and count to use for instances created from this machine image.

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 this machine image.

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 this machine image.

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 this machine image.

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 this machine image.

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

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

getKeyRevocationActionType()

public abstract String getKeyRevocationActionType()

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

optional string key_revocation_action_type = 235941474;

Returns
Type	Description
String	The keyRevocationActionType.

getKeyRevocationActionTypeBytes()

public abstract ByteString getKeyRevocationActionTypeBytes()

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

optional string key_revocation_action_type = 235941474;

Returns
Type	Description
ByteString	The bytes for keyRevocationActionType.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to instances that are created from this machine image.

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 this machine image.

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 this machine image.

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 this machine image.

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 this machine image.

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 this machine image.

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 this machine image. 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()

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

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 created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" 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()

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

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>

getScheduling()

public abstract Scheduling getScheduling()

Specifies the scheduling options for the instances that are created from this machine image.

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 this machine image.

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 this machine image. 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()

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

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

Returns
Type	Description
int

getServiceAccountsList()

public abstract List<ServiceAccount> getServiceAccountsList()

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

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

Returns
Type	Description
List<ServiceAccount>

getServiceAccountsOrBuilder(int index)

public abstract ServiceAccountOrBuilder getServiceAccountsOrBuilder(int index)

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

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

Parameter
Name	Description
index	int

Returns
Type	Description
ServiceAccountOrBuilder

getServiceAccountsOrBuilderList()

public abstract List<? extends ServiceAccountOrBuilder> getServiceAccountsOrBuilderList()

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

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

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

getTags()

public abstract Tags getTags()

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

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

Returns
Type	Description
Tags	The tags.

getTagsOrBuilder()

public abstract TagsOrBuilder getTagsOrBuilder()

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

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

Returns
Type	Description
TagsOrBuilder

hasCanIpForward()

public abstract boolean hasCanIpForward()

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

optional bool can_ip_forward = 467731324;

Returns
Type	Description
boolean	Whether the canIpForward field is set.

hasDeletionProtection()

public abstract boolean hasDeletionProtection()

Whether the instance created from this machine image should be protected against deletion.

optional bool deletion_protection = 458014698;

Returns
Type	Description
boolean	Whether the deletionProtection field is set.

hasDescription()

public abstract boolean hasDescription()

An optional text description for the instances that are created from this machine image.

optional string description = 422937596;

Returns
Type	Description
boolean	Whether the description field is set.

hasKeyRevocationActionType()

public abstract boolean hasKeyRevocationActionType()

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

optional string key_revocation_action_type = 235941474;

Returns
Type	Description
boolean	Whether the keyRevocationActionType field is set.

hasMachineType()

public abstract boolean hasMachineType()

The machine type to use for instances that are created from this machine image.

optional string machine_type = 227711026;

Returns
Type	Description
boolean	Whether the machineType field is set.

hasMetadata()

public abstract boolean hasMetadata()

The metadata key/value pairs to assign to instances that are created from this machine image. 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
boolean	Whether the metadata field is set.

hasMinCpuPlatform()

public abstract boolean hasMinCpuPlatform()

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

optional string min_cpu_platform = 242912759;

Returns
Type	Description
boolean	Whether the minCpuPlatform field is set.

hasScheduling()

public abstract boolean hasScheduling()

Specifies the scheduling options for the instances that are created from this machine image.

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

Returns
Type	Description
boolean	Whether the scheduling field is set.

hasTags()

public abstract boolean hasTags()

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

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

Returns
Type	Description
boolean	Whether the tags field is set.