Class SourceInstanceProperties (1.56.0)

public final class SourceInstanceProperties extends GeneratedMessageV3 implements SourceInstancePropertiesOrBuilder

DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.

Protobuf type google.cloud.compute.v1.SourceInstanceProperties

Static Fields

CAN_IP_FORWARD_FIELD_NUMBER

public static final int CAN_IP_FORWARD_FIELD_NUMBER
Field Value
Type Description
int

DELETION_PROTECTION_FIELD_NUMBER

public static final int DELETION_PROTECTION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISKS_FIELD_NUMBER

public static final int DISKS_FIELD_NUMBER
Field Value
Type Description
int

GUEST_ACCELERATORS_FIELD_NUMBER

public static final int GUEST_ACCELERATORS_FIELD_NUMBER
Field Value
Type Description
int

KEY_REVOCATION_ACTION_TYPE_FIELD_NUMBER

public static final int KEY_REVOCATION_ACTION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

MIN_CPU_PLATFORM_FIELD_NUMBER

public static final int MIN_CPU_PLATFORM_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_INTERFACES_FIELD_NUMBER

public static final int NETWORK_INTERFACES_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULING_FIELD_NUMBER

public static final int SCHEDULING_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNTS_FIELD_NUMBER

public static final int SERVICE_ACCOUNTS_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SourceInstanceProperties getDefaultInstance()
Returns
Type Description
SourceInstanceProperties

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SourceInstanceProperties.Builder newBuilder()
Returns
Type Description
SourceInstanceProperties.Builder

newBuilder(SourceInstanceProperties prototype)

public static SourceInstanceProperties.Builder newBuilder(SourceInstanceProperties prototype)
Parameter
Name Description
prototype SourceInstanceProperties
Returns
Type Description
SourceInstanceProperties.Builder

parseDelimitedFrom(InputStream input)

public static SourceInstanceProperties parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SourceInstanceProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SourceInstanceProperties parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SourceInstanceProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SourceInstanceProperties parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SourceInstanceProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SourceInstanceProperties parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SourceInstanceProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SourceInstanceProperties parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SourceInstanceProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SourceInstanceProperties parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SourceInstanceProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SourceInstanceProperties
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SourceInstanceProperties> parser()
Returns
Type Description
Parser<SourceInstanceProperties>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCanIpForward()

public 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.

getDefaultInstanceForType()

public SourceInstanceProperties getDefaultInstanceForType()
Returns
Type Description
SourceInstanceProperties

getDeletionProtection()

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getParserForType()

public Parser<SourceInstanceProperties> getParserForType()
Returns
Type Description
Parser<SourceInstanceProperties>
Overrides

getScheduling()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccounts(int index)

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SourceInstanceProperties.Builder newBuilderForType()
Returns
Type Description
SourceInstanceProperties.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SourceInstanceProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SourceInstanceProperties.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SourceInstanceProperties.Builder toBuilder()
Returns
Type Description
SourceInstanceProperties.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException