- 1.63.0 (latest)
- 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 final class InstanceProperties extends GeneratedMessageV3 implements InstancePropertiesOrBuilder
Protobuf type google.cloud.compute.v1.InstanceProperties
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstancePropertiesImplements
InstancePropertiesOrBuilderStatic Fields
ADVANCED_MACHINE_FEATURES_FIELD_NUMBER
public static final int ADVANCED_MACHINE_FEATURES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CAN_IP_FORWARD_FIELD_NUMBER
public static final int CAN_IP_FORWARD_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CONFIDENTIAL_INSTANCE_CONFIG_FIELD_NUMBER
public static final int CONFIDENTIAL_INSTANCE_CONFIG_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 |
NETWORK_PERFORMANCE_CONFIG_FIELD_NUMBER
public static final int NETWORK_PERFORMANCE_CONFIG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER
public static final int PRIVATE_IPV6_GOOGLE_ACCESS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESERVATION_AFFINITY_FIELD_NUMBER
public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESOURCE_MANAGER_TAGS_FIELD_NUMBER
public static final int RESOURCE_MANAGER_TAGS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESOURCE_POLICIES_FIELD_NUMBER
public static final int RESOURCE_POLICIES_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 |
SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
public static final int SHIELDED_INSTANCE_CONFIG_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 InstanceProperties getDefaultInstance()
Returns | |
---|---|
Type | Description |
InstanceProperties |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static InstanceProperties.Builder newBuilder()
Returns | |
---|---|
Type | Description |
InstanceProperties.Builder |
newBuilder(InstanceProperties prototype)
public static InstanceProperties.Builder newBuilder(InstanceProperties prototype)
Parameter | |
---|---|
Name | Description |
prototype |
InstanceProperties |
Returns | |
---|---|
Type | Description |
InstanceProperties.Builder |
parseDelimitedFrom(InputStream input)
public static InstanceProperties parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceProperties parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static InstanceProperties parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceProperties parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static InstanceProperties parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceProperties parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static InstanceProperties parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceProperties parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static InstanceProperties parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceProperties parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static InstanceProperties parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceProperties parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
InstanceProperties |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<InstanceProperties> parser()
Returns | |
---|---|
Type | Description |
Parser<InstanceProperties> |
Methods
containsLabels(String key)
public 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 |
containsResourceManagerTags(String key)
public boolean containsResourceManagerTags(String key)
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}
, and values are in the format tagValues/456
. The field is ignored (both PUT & PATCH) when empty.
map<string, string> resource_manager_tags = 377671164;
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 |
getAdvancedMachineFeatures()
public AdvancedMachineFeatures getAdvancedMachineFeatures()
Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
Returns | |
---|---|
Type | Description |
AdvancedMachineFeatures |
The advancedMachineFeatures. |
getAdvancedMachineFeaturesOrBuilder()
public AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()
Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
Returns | |
---|---|
Type | Description |
AdvancedMachineFeaturesOrBuilder |
getCanIpForward()
public 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 ConfidentialInstanceConfig getConfidentialInstanceConfig()
Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
Returns | |
---|---|
Type | Description |
ConfidentialInstanceConfig |
The confidentialInstanceConfig. |
getConfidentialInstanceConfigOrBuilder()
public ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()
Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
Returns | |
---|---|
Type | Description |
ConfidentialInstanceConfigOrBuilder |
getDefaultInstanceForType()
public InstanceProperties getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
InstanceProperties |
getDescription()
public 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 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 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 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 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 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 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 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 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 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 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 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> |
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 these properties.
map<string, string> labels = 500195327;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public 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 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 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 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 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 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 MetadataOrBuilder getMetadataOrBuilder()
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 |
MetadataOrBuilder |
getMinCpuPlatform()
public 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 ByteString getMinCpuPlatformBytes()
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 |
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> |
getNetworkPerformanceConfig()
public NetworkPerformanceConfig getNetworkPerformanceConfig()
Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
Returns | |
---|---|
Type | Description |
NetworkPerformanceConfig |
The networkPerformanceConfig. |
getNetworkPerformanceConfigOrBuilder()
public NetworkPerformanceConfigOrBuilder getNetworkPerformanceConfigOrBuilder()
Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
Returns | |
---|---|
Type | Description |
NetworkPerformanceConfigOrBuilder |
getParserForType()
public Parser<InstanceProperties> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<InstanceProperties> |
getPrivateIpv6GoogleAccess()
public String getPrivateIpv6GoogleAccess()
The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. 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 ByteString getPrivateIpv6GoogleAccessBytes()
The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. 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 ReservationAffinity getReservationAffinity()
Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
Returns | |
---|---|
Type | Description |
ReservationAffinity |
The reservationAffinity. |
getReservationAffinityOrBuilder()
public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()
Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
Returns | |
---|---|
Type | Description |
ReservationAffinityOrBuilder |
getResourceManagerTags() (deprecated)
public Map<String,String> getResourceManagerTags()
Use #getResourceManagerTagsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getResourceManagerTagsCount()
public int getResourceManagerTagsCount()
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}
, and values are in the format tagValues/456
. The field is ignored (both PUT & PATCH) when empty.
map<string, string> resource_manager_tags = 377671164;
Returns | |
---|---|
Type | Description |
int |
getResourceManagerTagsMap()
public Map<String,String> getResourceManagerTagsMap()
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}
, and values are in the format tagValues/456
. The field is ignored (both PUT & PATCH) when empty.
map<string, string> resource_manager_tags = 377671164;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getResourceManagerTagsOrDefault(String key, String defaultValue)
public String getResourceManagerTagsOrDefault(String key, String defaultValue)
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}
, and values are in the format tagValues/456
. The field is ignored (both PUT & PATCH) when empty.
map<string, string> resource_manager_tags = 377671164;
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getResourceManagerTagsOrThrow(String key)
public String getResourceManagerTagsOrThrow(String key)
Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}
, and values are in the format tagValues/456
. The field is ignored (both PUT & PATCH) when empty.
map<string, string> resource_manager_tags = 377671164;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getResourcePolicies(int index)
public String getResourcePolicies(int index)
Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
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 ByteString getResourcePoliciesBytes(int index)
Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
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 int getResourcePoliciesCount()
Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
repeated string resource_policies = 22220385;
Returns | |
---|---|
Type | Description |
int |
The count of resourcePolicies. |
getResourcePoliciesList()
public ProtocolStringList getResourcePoliciesList()
Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
repeated string resource_policies = 22220385;
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the resourcePolicies. |
getScheduling()
public 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 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 |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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 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 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 these properties. 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 these properties. 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 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 |
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 these properties. 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> |
getShieldedInstanceConfig()
public ShieldedInstanceConfig getShieldedInstanceConfig()
Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
Returns | |
---|---|
Type | Description |
ShieldedInstanceConfig |
The shieldedInstanceConfig. |
getShieldedInstanceConfigOrBuilder()
public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
Returns | |
---|---|
Type | Description |
ShieldedInstanceConfigOrBuilder |
getTags()
public 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 TagsOrBuilder getTagsOrBuilder()
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 |
TagsOrBuilder |
hasAdvancedMachineFeatures()
public boolean hasAdvancedMachineFeatures()
Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
Returns | |
---|---|
Type | Description |
boolean |
Whether the advancedMachineFeatures field is set. |
hasCanIpForward()
public boolean hasCanIpForward()
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 |
Whether the canIpForward field is set. |
hasConfidentialInstanceConfig()
public boolean hasConfidentialInstanceConfig()
Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
Returns | |
---|---|
Type | Description |
boolean |
Whether the confidentialInstanceConfig field is set. |
hasDescription()
public 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. |
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 these properties.
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 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 |
boolean |
Whether the metadata field is set. |
hasMinCpuPlatform()
public boolean hasMinCpuPlatform()
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 |
boolean |
Whether the minCpuPlatform field is set. |
hasNetworkPerformanceConfig()
public boolean hasNetworkPerformanceConfig()
Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
Returns | |
---|---|
Type | Description |
boolean |
Whether the networkPerformanceConfig field is set. |
hasPrivateIpv6GoogleAccess()
public boolean hasPrivateIpv6GoogleAccess()
The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. 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 boolean hasReservationAffinity()
Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
Returns | |
---|---|
Type | Description |
boolean |
Whether the reservationAffinity field is set. |
hasScheduling()
public 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 boolean hasShieldedInstanceConfig()
Note that for MachineImage, this is not supported yet.
optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
Returns | |
---|---|
Type | Description |
boolean |
Whether the shieldedInstanceConfig field is set. |
hasTags()
public boolean hasTags()
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 |
boolean |
Whether the tags field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public InstanceProperties.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
InstanceProperties.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
InstanceProperties.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public InstanceProperties.Builder toBuilder()
Returns | |
---|---|
Type | Description |
InstanceProperties.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |