- 1.64.0 (latest)
- 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 final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.
Protobuf type google.cloud.compute.v1.Instance
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceImplements
InstanceOrBuilderStatic 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 |
CPU_PLATFORM_FIELD_NUMBER
public static final int CPU_PLATFORM_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_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 |
DISPLAY_DEVICE_FIELD_NUMBER
public static final int DISPLAY_DEVICE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
GUEST_ACCELERATORS_FIELD_NUMBER
public static final int GUEST_ACCELERATORS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
HOSTNAME_FIELD_NUMBER
public static final int HOSTNAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
INSTANCE_ENCRYPTION_KEY_FIELD_NUMBER
public static final int INSTANCE_ENCRYPTION_KEY_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 |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LABEL_FINGERPRINT_FIELD_NUMBER
public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LAST_START_TIMESTAMP_FIELD_NUMBER
public static final int LAST_START_TIMESTAMP_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LAST_STOP_TIMESTAMP_FIELD_NUMBER
public static final int LAST_STOP_TIMESTAMP_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LAST_SUSPENDED_TIMESTAMP_FIELD_NUMBER
public static final int LAST_SUSPENDED_TIMESTAMP_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 |
NAME_FIELD_NUMBER
public static final int NAME_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 |
PARAMS_FIELD_NUMBER
public static final int PARAMS_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_POLICIES_FIELD_NUMBER
public static final int RESOURCE_POLICIES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RESOURCE_STATUS_FIELD_NUMBER
public static final int RESOURCE_STATUS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SATISFIES_PZI_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SCHEDULING_FIELD_NUMBER
public static final int SCHEDULING_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_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 |
SHIELDED_INSTANCE_INTEGRITY_POLICY_FIELD_NUMBER
public static final int SHIELDED_INSTANCE_INTEGRITY_POLICY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SOURCE_MACHINE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
public static final int SOURCE_MACHINE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SOURCE_MACHINE_IMAGE_FIELD_NUMBER
public static final int SOURCE_MACHINE_IMAGE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
START_RESTRICTED_FIELD_NUMBER
public static final int START_RESTRICTED_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
STATUS_MESSAGE_FIELD_NUMBER
public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
Returns | |
---|---|
Type | Description |
Instance |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Instance.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Instance.Builder |
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
Parameter | |
---|---|
Name | Description |
prototype | Instance |
Returns | |
---|---|
Type | Description |
Instance.Builder |
parseDelimitedFrom(InputStream input)
public static Instance parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Instance parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Instance parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Instance |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Instance> parser()
Returns | |
---|---|
Type | Description |
Parser<Instance> |
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
Parameter | |
---|---|
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.
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.
optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
Returns | |
---|---|
Type | Description |
AdvancedMachineFeaturesOrBuilder |
getCanIpForward()
public boolean getCanIpForward()
Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .
optional bool can_ip_forward = 467731324;
Returns | |
---|---|
Type | Description |
boolean | The canIpForward. |
getConfidentialInstanceConfig()
public ConfidentialInstanceConfig getConfidentialInstanceConfig()
optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
Returns | |
---|---|
Type | Description |
ConfidentialInstanceConfig | The confidentialInstanceConfig. |
getConfidentialInstanceConfigOrBuilder()
public ConfidentialInstanceConfigOrBuilder getConfidentialInstanceConfigOrBuilder()
optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
Returns | |
---|---|
Type | Description |
ConfidentialInstanceConfigOrBuilder |
getCpuPlatform()
public String getCpuPlatform()
[Output Only] The CPU platform used by this instance.
optional string cpu_platform = 410285354;
Returns | |
---|---|
Type | Description |
String | The cpuPlatform. |
getCpuPlatformBytes()
public ByteString getCpuPlatformBytes()
[Output Only] The CPU platform used by this instance.
optional string cpu_platform = 410285354;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for cpuPlatform. |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Instance |
getDeletionProtection()
public boolean getDeletionProtection()
Whether the resource should be protected against deletion.
optional bool deletion_protection = 458014698;
Returns | |
---|---|
Type | Description |
boolean | The deletionProtection. |
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for description. |
getDisks(int index)
public AttachedDisk getDisks(int index)
Array of disks associated with this instance. Persistent disks must be created before you can assign them.
repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
AttachedDisk |
getDisksCount()
public int getDisksCount()
Array of disks associated with this instance. Persistent disks must be created before you can assign them.
repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;
Returns | |
---|---|
Type | Description |
int |
getDisksList()
public List<AttachedDisk> getDisksList()
Array of disks associated with this instance. Persistent disks must be created before you can assign them.
repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;
Returns | |
---|---|
Type | Description |
List<AttachedDisk> |
getDisksOrBuilder(int index)
public AttachedDiskOrBuilder getDisksOrBuilder(int index)
Array of disks associated with this instance. Persistent disks must be created before you can assign them.
repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
AttachedDiskOrBuilder |
getDisksOrBuilderList()
public List<? extends AttachedDiskOrBuilder> getDisksOrBuilderList()
Array of disks associated with this instance. Persistent disks must be created before you can assign them.
repeated .google.cloud.compute.v1.AttachedDisk disks = 95594102;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.compute.v1.AttachedDiskOrBuilder> |
getDisplayDevice()
public DisplayDevice getDisplayDevice()
Enables display device for the instance.
optional .google.cloud.compute.v1.DisplayDevice display_device = 258933875;
Returns | |
---|---|
Type | Description |
DisplayDevice | The displayDevice. |
getDisplayDeviceOrBuilder()
public DisplayDeviceOrBuilder getDisplayDeviceOrBuilder()
Enables display device for the instance.
optional .google.cloud.compute.v1.DisplayDevice display_device = 258933875;
Returns | |
---|---|
Type | Description |
DisplayDeviceOrBuilder |
getFingerprint()
public String getFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.
optional string fingerprint = 234678500;
Returns | |
---|---|
Type | Description |
String | The fingerprint. |
getFingerprintBytes()
public ByteString getFingerprintBytes()
Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.
optional string fingerprint = 234678500;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for fingerprint. |
getGuestAccelerators(int index)
public AcceleratorConfig getGuestAccelerators(int index)
A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
AcceleratorConfig |
getGuestAcceleratorsCount()
public int getGuestAcceleratorsCount()
A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;
Returns | |
---|---|
Type | Description |
int |
getGuestAcceleratorsList()
public List<AcceleratorConfig> getGuestAcceleratorsList()
A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;
Returns | |
---|---|
Type | Description |
List<AcceleratorConfig> |
getGuestAcceleratorsOrBuilder(int index)
public AcceleratorConfigOrBuilder getGuestAcceleratorsOrBuilder(int index)
A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
AcceleratorConfigOrBuilder |
getGuestAcceleratorsOrBuilderList()
public List<? extends AcceleratorConfigOrBuilder> getGuestAcceleratorsOrBuilderList()
A list of the type and count of accelerator cards attached to the instance.
repeated .google.cloud.compute.v1.AcceleratorConfig guest_accelerators = 463595119;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.compute.v1.AcceleratorConfigOrBuilder> |
getHostname()
public String getHostname()
Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
optional string hostname = 237067315;
Returns | |
---|---|
Type | Description |
String | The hostname. |
getHostnameBytes()
public ByteString getHostnameBytes()
Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
optional string hostname = 237067315;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for hostname. |
getId()
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
long | The id. |
getInstanceEncryptionKey()
public CustomerEncryptionKey getInstanceEncryptionKey()
Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.
optional .google.cloud.compute.v1.CustomerEncryptionKey instance_encryption_key = 64741517;
Returns | |
---|---|
Type | Description |
CustomerEncryptionKey | The instanceEncryptionKey. |
getInstanceEncryptionKeyOrBuilder()
public CustomerEncryptionKeyOrBuilder getInstanceEncryptionKeyOrBuilder()
Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.
optional .google.cloud.compute.v1.CustomerEncryptionKey instance_encryption_key = 64741517;
Returns | |
---|---|
Type | Description |
CustomerEncryptionKeyOrBuilder |
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. |
getKind()
public String getKind()
[Output Only] Type of the resource. Always compute#instance for instances.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#instance for instances.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for kind. |
getLabelFingerprint()
public String getLabelFingerprint()
A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.
optional string label_fingerprint = 178124825;
Returns | |
---|---|
Type | Description |
String | The labelFingerprint. |
getLabelFingerprintBytes()
public ByteString getLabelFingerprintBytes()
A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.
optional string label_fingerprint = 178124825;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for labelFingerprint. |
getLabels() (deprecated)
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels to apply to this instance. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getLastStartTimestamp()
public String getLastStartTimestamp()
[Output Only] Last start timestamp in RFC3339 text format.
optional string last_start_timestamp = 443830736;
Returns | |
---|---|
Type | Description |
String | The lastStartTimestamp. |
getLastStartTimestampBytes()
public ByteString getLastStartTimestampBytes()
[Output Only] Last start timestamp in RFC3339 text format.
optional string last_start_timestamp = 443830736;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for lastStartTimestamp. |
getLastStopTimestamp()
public String getLastStopTimestamp()
[Output Only] Last stop timestamp in RFC3339 text format.
optional string last_stop_timestamp = 412823010;
Returns | |
---|---|
Type | Description |
String | The lastStopTimestamp. |
getLastStopTimestampBytes()
public ByteString getLastStopTimestampBytes()
[Output Only] Last stop timestamp in RFC3339 text format.
optional string last_stop_timestamp = 412823010;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for lastStopTimestamp. |
getLastSuspendedTimestamp()
public String getLastSuspendedTimestamp()
[Output Only] Last suspended timestamp in RFC3339 text format.
optional string last_suspended_timestamp = 356275337;
Returns | |
---|---|
Type | Description |
String | The lastSuspendedTimestamp. |
getLastSuspendedTimestampBytes()
public ByteString getLastSuspendedTimestampBytes()
[Output Only] Last suspended timestamp in RFC3339 text format.
optional string last_suspended_timestamp = 356275337;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for lastSuspendedTimestamp. |
getMachineType()
public String getMachineType()
Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.
optional string machine_type = 227711026;
Returns | |
---|---|
Type | Description |
String | The machineType. |
getMachineTypeBytes()
public ByteString getMachineTypeBytes()
Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.
optional string machine_type = 227711026;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for machineType. |
getMetadata()
public Metadata getMetadata()
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
optional .google.cloud.compute.v1.Metadata metadata = 86866735;
Returns | |
---|---|
Type | Description |
Metadata | The metadata. |
getMetadataOrBuilder()
public MetadataOrBuilder getMetadataOrBuilder()
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
optional .google.cloud.compute.v1.Metadata metadata = 86866735;
Returns | |
---|---|
Type | Description |
MetadataOrBuilder |
getMinCpuPlatform()
public String getMinCpuPlatform()
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".
optional string min_cpu_platform = 242912759;
Returns | |
---|---|
Type | Description |
String | The minCpuPlatform. |
getMinCpuPlatformBytes()
public ByteString getMinCpuPlatformBytes()
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".
optional string min_cpu_platform = 242912759;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for minCpuPlatform. |
getName()
public String getName()
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getNetworkInterfaces(int index)
public NetworkInterface getNetworkInterfaces(int index)
An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
NetworkInterface |
getNetworkInterfacesCount()
public int getNetworkInterfacesCount()
An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;
Returns | |
---|---|
Type | Description |
int |
getNetworkInterfacesList()
public List<NetworkInterface> getNetworkInterfacesList()
An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;
Returns | |
---|---|
Type | Description |
List<NetworkInterface> |
getNetworkInterfacesOrBuilder(int index)
public NetworkInterfaceOrBuilder getNetworkInterfacesOrBuilder(int index)
An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
NetworkInterfaceOrBuilder |
getNetworkInterfacesOrBuilderList()
public List<? extends NetworkInterfaceOrBuilder> getNetworkInterfacesOrBuilderList()
An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.
repeated .google.cloud.compute.v1.NetworkInterface network_interfaces = 52735243;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.compute.v1.NetworkInterfaceOrBuilder> |
getNetworkPerformanceConfig()
public NetworkPerformanceConfig getNetworkPerformanceConfig()
optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
Returns | |
---|---|
Type | Description |
NetworkPerformanceConfig | The networkPerformanceConfig. |
getNetworkPerformanceConfigOrBuilder()
public NetworkPerformanceConfigOrBuilder getNetworkPerformanceConfigOrBuilder()
optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
Returns | |
---|---|
Type | Description |
NetworkPerformanceConfigOrBuilder |
getParams()
public InstanceParams getParams()
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.InstanceParams params = 78313862;
Returns | |
---|---|
Type | Description |
InstanceParams | The params. |
getParamsOrBuilder()
public InstanceParamsOrBuilder getParamsOrBuilder()
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.InstanceParams params = 78313862;
Returns | |
---|---|
Type | Description |
InstanceParamsOrBuilder |
getParserForType()
public Parser<Instance> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Instance> |
getPrivateIpv6GoogleAccess()
public String getPrivateIpv6GoogleAccess()
The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.
optional string private_ipv6_google_access = 48277006;
Returns | |
---|---|
Type | Description |
String | The privateIpv6GoogleAccess. |
getPrivateIpv6GoogleAccessBytes()
public ByteString getPrivateIpv6GoogleAccessBytes()
The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.
optional string private_ipv6_google_access = 48277006;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for privateIpv6GoogleAccess. |
getReservationAffinity()
public ReservationAffinity getReservationAffinity()
Specifies the reservations that this instance can consume from.
optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
Returns | |
---|---|
Type | Description |
ReservationAffinity | The reservationAffinity. |
getReservationAffinityOrBuilder()
public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()
Specifies the reservations that this instance can consume from.
optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
Returns | |
---|---|
Type | Description |
ReservationAffinityOrBuilder |
getResourcePolicies(int index)
public String getResourcePolicies(int index)
Resource policies applied to this instance.
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 applied to this instance.
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 applied to this instance.
repeated string resource_policies = 22220385;
Returns | |
---|---|
Type | Description |
int | The count of resourcePolicies. |
getResourcePoliciesList()
public ProtocolStringList getResourcePoliciesList()
Resource policies applied to this instance.
repeated string resource_policies = 22220385;
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the resourcePolicies. |
getResourceStatus()
public ResourceStatus getResourceStatus()
[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.
optional .google.cloud.compute.v1.ResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
ResourceStatus | The resourceStatus. |
getResourceStatusOrBuilder()
public ResourceStatusOrBuilder getResourceStatusOrBuilder()
[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.
optional .google.cloud.compute.v1.ResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
ResourceStatusOrBuilder |
getSatisfiesPzi()
public boolean getSatisfiesPzi()
[Output Only] Reserved for future use.
optional bool satisfies_pzi = 480964257;
Returns | |
---|---|
Type | Description |
boolean | The satisfiesPzi. |
getSatisfiesPzs()
public boolean getSatisfiesPzs()
[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
Returns | |
---|---|
Type | Description |
boolean | The satisfiesPzs. |
getScheduling()
public Scheduling getScheduling()
Sets the scheduling options for this instance.
optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;
Returns | |
---|---|
Type | Description |
Scheduling | The scheduling. |
getSchedulingOrBuilder()
public SchedulingOrBuilder getSchedulingOrBuilder()
Sets the scheduling options for this instance.
optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;
Returns | |
---|---|
Type | Description |
SchedulingOrBuilder |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for this resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for this resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getServiceAccounts(int index)
public ServiceAccount getServiceAccounts(int index)
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
ServiceAccount |
getServiceAccountsCount()
public int getServiceAccountsCount()
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;
Returns | |
---|---|
Type | Description |
int |
getServiceAccountsList()
public List<ServiceAccount> getServiceAccountsList()
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;
Returns | |
---|---|
Type | Description |
List<ServiceAccount> |
getServiceAccountsOrBuilder(int index)
public ServiceAccountOrBuilder getServiceAccountsOrBuilder(int index)
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
ServiceAccountOrBuilder |
getServiceAccountsOrBuilderList()
public List<? extends ServiceAccountOrBuilder> getServiceAccountsOrBuilderList()
A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.
repeated .google.cloud.compute.v1.ServiceAccount service_accounts = 277537328;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.compute.v1.ServiceAccountOrBuilder> |
getShieldedInstanceConfig()
public ShieldedInstanceConfig getShieldedInstanceConfig()
optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
Returns | |
---|---|
Type | Description |
ShieldedInstanceConfig | The shieldedInstanceConfig. |
getShieldedInstanceConfigOrBuilder()
public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
Returns | |
---|---|
Type | Description |
ShieldedInstanceConfigOrBuilder |
getShieldedInstanceIntegrityPolicy()
public ShieldedInstanceIntegrityPolicy getShieldedInstanceIntegrityPolicy()
optional .google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy shielded_instance_integrity_policy = 163696919;
Returns | |
---|---|
Type | Description |
ShieldedInstanceIntegrityPolicy | The shieldedInstanceIntegrityPolicy. |
getShieldedInstanceIntegrityPolicyOrBuilder()
public ShieldedInstanceIntegrityPolicyOrBuilder getShieldedInstanceIntegrityPolicyOrBuilder()
optional .google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy shielded_instance_integrity_policy = 163696919;
Returns | |
---|---|
Type | Description |
ShieldedInstanceIntegrityPolicyOrBuilder |
getSourceMachineImage()
public String getSourceMachineImage()
Source machine image
optional string source_machine_image = 21769791;
Returns | |
---|---|
Type | Description |
String | The sourceMachineImage. |
getSourceMachineImageBytes()
public ByteString getSourceMachineImageBytes()
Source machine image
optional string source_machine_image = 21769791;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for sourceMachineImage. |
getSourceMachineImageEncryptionKey()
public CustomerEncryptionKey getSourceMachineImageEncryptionKey()
Source machine image encryption key when creating an instance from a machine image.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_machine_image_encryption_key = 192839075;
Returns | |
---|---|
Type | Description |
CustomerEncryptionKey | The sourceMachineImageEncryptionKey. |
getSourceMachineImageEncryptionKeyOrBuilder()
public CustomerEncryptionKeyOrBuilder getSourceMachineImageEncryptionKeyOrBuilder()
Source machine image encryption key when creating an instance from a machine image.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_machine_image_encryption_key = 192839075;
Returns | |
---|---|
Type | Description |
CustomerEncryptionKeyOrBuilder |
getStartRestricted()
public boolean getStartRestricted()
[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
optional bool start_restricted = 123693144;
Returns | |
---|---|
Type | Description |
boolean | The startRestricted. |
getStatus()
public String getStatus()
[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
String | The status. |
getStatusBytes()
public ByteString getStatusBytes()
[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for status. |
getStatusMessage()
public String getStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;
Returns | |
---|---|
Type | Description |
String | The statusMessage. |
getStatusMessageBytes()
public ByteString getStatusMessageBytes()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for statusMessage. |
getTags()
public Tags getTags()
Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.
optional .google.cloud.compute.v1.Tags tags = 3552281;
Returns | |
---|---|
Type | Description |
Tags | The tags. |
getTagsOrBuilder()
public TagsOrBuilder getTagsOrBuilder()
Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.
optional .google.cloud.compute.v1.Tags tags = 3552281;
Returns | |
---|---|
Type | Description |
TagsOrBuilder |
getZone()
public String getZone()
[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string zone = 3744684;
Returns | |
---|---|
Type | Description |
String | The zone. |
getZoneBytes()
public ByteString getZoneBytes()
[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string zone = 3744684;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for zone. |
hasAdvancedMachineFeatures()
public boolean hasAdvancedMachineFeatures()
Controls for advanced machine-related behavior features.
optional .google.cloud.compute.v1.AdvancedMachineFeatures advanced_machine_features = 409646002;
Returns | |
---|---|
Type | Description |
boolean | Whether the advancedMachineFeatures field is set. |
hasCanIpForward()
public boolean hasCanIpForward()
Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .
optional bool can_ip_forward = 467731324;
Returns | |
---|---|
Type | Description |
boolean | Whether the canIpForward field is set. |
hasConfidentialInstanceConfig()
public boolean hasConfidentialInstanceConfig()
optional .google.cloud.compute.v1.ConfidentialInstanceConfig confidential_instance_config = 490637685;
Returns | |
---|---|
Type | Description |
boolean | Whether the confidentialInstanceConfig field is set. |
hasCpuPlatform()
public boolean hasCpuPlatform()
[Output Only] The CPU platform used by this instance.
optional string cpu_platform = 410285354;
Returns | |
---|---|
Type | Description |
boolean | Whether the cpuPlatform field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
boolean | Whether the creationTimestamp field is set. |
hasDeletionProtection()
public boolean hasDeletionProtection()
Whether the resource should be protected against deletion.
optional bool deletion_protection = 458014698;
Returns | |
---|---|
Type | Description |
boolean | Whether the deletionProtection field is set. |
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
boolean | Whether the description field is set. |
hasDisplayDevice()
public boolean hasDisplayDevice()
Enables display device for the instance.
optional .google.cloud.compute.v1.DisplayDevice display_device = 258933875;
Returns | |
---|---|
Type | Description |
boolean | Whether the displayDevice field is set. |
hasFingerprint()
public boolean hasFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.
optional string fingerprint = 234678500;
Returns | |
---|---|
Type | Description |
boolean | Whether the fingerprint field is set. |
hasHostname()
public boolean hasHostname()
Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
optional string hostname = 237067315;
Returns | |
---|---|
Type | Description |
boolean | Whether the hostname field is set. |
hasId()
public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
boolean | Whether the id field is set. |
hasInstanceEncryptionKey()
public boolean hasInstanceEncryptionKey()
Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.
optional .google.cloud.compute.v1.CustomerEncryptionKey instance_encryption_key = 64741517;
Returns | |
---|---|
Type | Description |
boolean | Whether the instanceEncryptionKey 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. |
hasKind()
public boolean hasKind()
[Output Only] Type of the resource. Always compute#instance for instances.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
boolean | Whether the kind field is set. |
hasLabelFingerprint()
public boolean hasLabelFingerprint()
A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.
optional string label_fingerprint = 178124825;
Returns | |
---|---|
Type | Description |
boolean | Whether the labelFingerprint field is set. |
hasLastStartTimestamp()
public boolean hasLastStartTimestamp()
[Output Only] Last start timestamp in RFC3339 text format.
optional string last_start_timestamp = 443830736;
Returns | |
---|---|
Type | Description |
boolean | Whether the lastStartTimestamp field is set. |
hasLastStopTimestamp()
public boolean hasLastStopTimestamp()
[Output Only] Last stop timestamp in RFC3339 text format.
optional string last_stop_timestamp = 412823010;
Returns | |
---|---|
Type | Description |
boolean | Whether the lastStopTimestamp field is set. |
hasLastSuspendedTimestamp()
public boolean hasLastSuspendedTimestamp()
[Output Only] Last suspended timestamp in RFC3339 text format.
optional string last_suspended_timestamp = 356275337;
Returns | |
---|---|
Type | Description |
boolean | Whether the lastSuspendedTimestamp field is set. |
hasMachineType()
public boolean hasMachineType()
Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.
optional string machine_type = 227711026;
Returns | |
---|---|
Type | Description |
boolean | Whether the machineType field is set. |
hasMetadata()
public boolean hasMetadata()
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
optional .google.cloud.compute.v1.Metadata metadata = 86866735;
Returns | |
---|---|
Type | Description |
boolean | Whether the metadata field is set. |
hasMinCpuPlatform()
public boolean hasMinCpuPlatform()
Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".
optional string min_cpu_platform = 242912759;
Returns | |
---|---|
Type | Description |
boolean | Whether the minCpuPlatform field is set. |
hasName()
public boolean hasName()
The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
boolean | Whether the name field is set. |
hasNetworkPerformanceConfig()
public boolean hasNetworkPerformanceConfig()
optional .google.cloud.compute.v1.NetworkPerformanceConfig network_performance_config = 398330850;
Returns | |
---|---|
Type | Description |
boolean | Whether the networkPerformanceConfig field is set. |
hasParams()
public boolean hasParams()
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.InstanceParams params = 78313862;
Returns | |
---|---|
Type | Description |
boolean | Whether the params field is set. |
hasPrivateIpv6GoogleAccess()
public boolean hasPrivateIpv6GoogleAccess()
The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.
optional string private_ipv6_google_access = 48277006;
Returns | |
---|---|
Type | Description |
boolean | Whether the privateIpv6GoogleAccess field is set. |
hasReservationAffinity()
public boolean hasReservationAffinity()
Specifies the reservations that this instance can consume from.
optional .google.cloud.compute.v1.ReservationAffinity reservation_affinity = 157850683;
Returns | |
---|---|
Type | Description |
boolean | Whether the reservationAffinity field is set. |
hasResourceStatus()
public boolean hasResourceStatus()
[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.
optional .google.cloud.compute.v1.ResourceStatus resource_status = 249429315;
Returns | |
---|---|
Type | Description |
boolean | Whether the resourceStatus field is set. |
hasSatisfiesPzi()
public boolean hasSatisfiesPzi()
[Output Only] Reserved for future use.
optional bool satisfies_pzi = 480964257;
Returns | |
---|---|
Type | Description |
boolean | Whether the satisfiesPzi field is set. |
hasSatisfiesPzs()
public boolean hasSatisfiesPzs()
[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
Returns | |
---|---|
Type | Description |
boolean | Whether the satisfiesPzs field is set. |
hasScheduling()
public boolean hasScheduling()
Sets the scheduling options for this instance.
optional .google.cloud.compute.v1.Scheduling scheduling = 386688404;
Returns | |
---|---|
Type | Description |
boolean | Whether the scheduling field is set. |
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for this resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
boolean | Whether the selfLink field is set. |
hasShieldedInstanceConfig()
public boolean hasShieldedInstanceConfig()
optional .google.cloud.compute.v1.ShieldedInstanceConfig shielded_instance_config = 12862901;
Returns | |
---|---|
Type | Description |
boolean | Whether the shieldedInstanceConfig field is set. |
hasShieldedInstanceIntegrityPolicy()
public boolean hasShieldedInstanceIntegrityPolicy()
optional .google.cloud.compute.v1.ShieldedInstanceIntegrityPolicy shielded_instance_integrity_policy = 163696919;
Returns | |
---|---|
Type | Description |
boolean | Whether the shieldedInstanceIntegrityPolicy field is set. |
hasSourceMachineImage()
public boolean hasSourceMachineImage()
Source machine image
optional string source_machine_image = 21769791;
Returns | |
---|---|
Type | Description |
boolean | Whether the sourceMachineImage field is set. |
hasSourceMachineImageEncryptionKey()
public boolean hasSourceMachineImageEncryptionKey()
Source machine image encryption key when creating an instance from a machine image.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_machine_image_encryption_key = 192839075;
Returns | |
---|---|
Type | Description |
boolean | Whether the sourceMachineImageEncryptionKey field is set. |
hasStartRestricted()
public boolean hasStartRestricted()
[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
optional bool start_restricted = 123693144;
Returns | |
---|---|
Type | Description |
boolean | Whether the startRestricted field is set. |
hasStatus()
public boolean hasStatus()
[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.
optional string status = 181260274;
Returns | |
---|---|
Type | Description |
boolean | Whether the status field is set. |
hasStatusMessage()
public boolean hasStatusMessage()
[Output Only] An optional, human-readable explanation of the status.
optional string status_message = 297428154;
Returns | |
---|---|
Type | Description |
boolean | Whether the statusMessage field is set. |
hasTags()
public boolean hasTags()
Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.
optional .google.cloud.compute.v1.Tags tags = 3552281;
Returns | |
---|---|
Type | Description |
boolean | Whether the tags field is set. |
hasZone()
public boolean hasZone()
[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string zone = 3744684;
Returns | |
---|---|
Type | Description |
boolean | Whether the zone 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 Instance.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Instance.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
Instance.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Instance.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Instance.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |