Interface InstanceOrBuilder (1.18.0)

Version 1.18.0

• 1.53.0 (latest)
• 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.35.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.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.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAcceleratorConfig()

public abstract Instance.AcceleratorConfig getAcceleratorConfig()

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.

.google.cloud.notebooks.v1.Instance.AcceleratorConfig accelerator_config = 9;

Returns
Type	Description
Instance.AcceleratorConfig	The acceleratorConfig.

getAcceleratorConfigOrBuilder()

public abstract Instance.AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.

.google.cloud.notebooks.v1.Instance.AcceleratorConfig accelerator_config = 9;

Returns
Type	Description
Instance.AcceleratorConfigOrBuilder

getBootDiskSizeGb()

public abstract long getBootDiskSizeGb()

Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

int64 boot_disk_size_gb = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
long	The bootDiskSizeGb.

getBootDiskType()

public abstract Instance.DiskType getBootDiskType()

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

.google.cloud.notebooks.v1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Instance.DiskType	The bootDiskType.

getBootDiskTypeValue()

public abstract int getBootDiskTypeValue()

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

.google.cloud.notebooks.v1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for bootDiskType.

getCanIpForward()

public abstract boolean getCanIpForward()

Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

bool can_ip_forward = 39 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The canIpForward.

getContainerImage()

public abstract ContainerImage getContainerImage()

Use a container image to start the notebook instance.

.google.cloud.notebooks.v1.ContainerImage container_image = 3;

Returns
Type	Description
ContainerImage	The containerImage.

getContainerImageOrBuilder()

public abstract ContainerImageOrBuilder getContainerImageOrBuilder()

Use a container image to start the notebook instance.

.google.cloud.notebooks.v1.ContainerImage container_image = 3;

Returns
Type	Description
ContainerImageOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Instance creation time.

.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Instance creation time.

.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCreator()

public abstract String getCreator()

Output only. Email address of entity that sent original CreateInstance request.

string creator = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The creator.

getCreatorBytes()

public abstract ByteString getCreatorBytes()

Output only. Email address of entity that sent original CreateInstance request.

string creator = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for creator.

getCustomGpuDriverPath()

public abstract String getCustomGpuDriverPath()

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

string custom_gpu_driver_path = 12;

Returns
Type	Description
String	The customGpuDriverPath.

getCustomGpuDriverPathBytes()

public abstract ByteString getCustomGpuDriverPathBytes()

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

string custom_gpu_driver_path = 12;

Returns
Type	Description
ByteString	The bytes for customGpuDriverPath.

getDataDiskSizeGb()

public abstract long getDataDiskSizeGb()

Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

int64 data_disk_size_gb = 26 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
long	The dataDiskSizeGb.

getDataDiskType()

public abstract Instance.DiskType getDataDiskType()

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

.google.cloud.notebooks.v1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Instance.DiskType	The dataDiskType.

getDataDiskTypeValue()

public abstract int getDataDiskTypeValue()

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

.google.cloud.notebooks.v1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for dataDiskType.

getDiskEncryption()

public abstract Instance.DiskEncryption getDiskEncryption()

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

.google.cloud.notebooks.v1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
Instance.DiskEncryption	The diskEncryption.

getDiskEncryptionValue()

public abstract int getDiskEncryptionValue()

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

.google.cloud.notebooks.v1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for diskEncryption.

getDisks(int index)

public abstract Instance.Disk getDisks(int index)

Output only. Attached disks to notebook instance.

repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Instance.Disk

getDisksCount()

public abstract int getDisksCount()

Output only. Attached disks to notebook instance.

repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getDisksList()

public abstract List<Instance.Disk> getDisksList()

Output only. Attached disks to notebook instance.

repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Disk>

getDisksOrBuilder(int index)

public abstract Instance.DiskOrBuilder getDisksOrBuilder(int index)

Output only. Attached disks to notebook instance.

repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Instance.DiskOrBuilder

getDisksOrBuilderList()

public abstract List<? extends Instance.DiskOrBuilder> getDisksOrBuilderList()

Output only. Attached disks to notebook instance.

repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v1.Instance.DiskOrBuilder>

getEnvironmentCase()

public abstract Instance.EnvironmentCase getEnvironmentCase()

Returns
Type	Description
Instance.EnvironmentCase

getInstallGpuDriver()

public abstract boolean getInstallGpuDriver()

Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

bool install_gpu_driver = 11;

Returns
Type	Description
boolean	The installGpuDriver.

getInstanceOwners(int index)

public abstract String getInstanceOwners(int index)

Input only. The owner of this instance after creation. Format: [e-mail]

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

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

Returns
Type	Description
String	The instanceOwners at the given index.

getInstanceOwnersBytes(int index)

public abstract ByteString getInstanceOwnersBytes(int index)

Input only. The owner of this instance after creation. Format: [e-mail]

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

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

Returns
Type	Description
ByteString	The bytes of the instanceOwners at the given index.

getInstanceOwnersCount()

public abstract int getInstanceOwnersCount()

Input only. The owner of this instance after creation. Format: [e-mail]

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
int	The count of instanceOwners.

getInstanceOwnersList()

public abstract List<String> getInstanceOwnersList()

Input only. The owner of this instance after creation. Format: [e-mail]

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
List<String>	A list containing the instanceOwners.

getKmsKey()

public abstract String getKmsKey()

Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Learn more about using your own encryption keys.

string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
String	The kmsKey.

getKmsKeyBytes()

public abstract ByteString getKmsKeyBytes()

Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Learn more about using your own encryption keys.

string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for kmsKey.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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 = 21;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels to apply to this instance. These can be later modified by the setLabels method.

map<string, string> labels = 21;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMachineType()

public abstract String getMachineType()

Required. The Compute Engine machine type of this instance.

string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

Required. The Compute Engine machine type of this instance.

string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for machineType.

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Returns
Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Returns
Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getNetwork()

public abstract String getNetwork()

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

string network = 19;

Returns
Type	Description
String	The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

string network = 19;

Returns
Type	Description
ByteString	The bytes for network.

getNicType()

public abstract Instance.NicType getNicType()

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

.google.cloud.notebooks.v1.Instance.NicType nic_type = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Instance.NicType	The nicType.

getNicTypeValue()

public abstract int getNicTypeValue()

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

.google.cloud.notebooks.v1.Instance.NicType nic_type = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for nicType.

getNoProxyAccess()

public abstract boolean getNoProxyAccess()

If true, the notebook instance will not register with the proxy.

bool no_proxy_access = 18;

Returns
Type	Description
boolean	The noProxyAccess.

getNoPublicIp()

public abstract boolean getNoPublicIp()

If true, no public IP will be assigned to this instance.

bool no_public_ip = 17;

Returns
Type	Description
boolean	The noPublicIp.

getNoRemoveDataDisk()

public abstract boolean getNoRemoveDataDisk()

Input only. If true, the data disk will not be auto deleted when deleting the instance.

bool no_remove_data_disk = 27 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
boolean	The noRemoveDataDisk.

getPostStartupScript()

public abstract String getPostStartupScript()

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

string post_startup_script = 4;

Returns
Type	Description
String	The postStartupScript.

getPostStartupScriptBytes()

public abstract ByteString getPostStartupScriptBytes()

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

string post_startup_script = 4;

Returns
Type	Description
ByteString	The bytes for postStartupScript.

getProxyUri()

public abstract String getProxyUri()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The proxyUri.

getProxyUriBytes()

public abstract ByteString getProxyUriBytes()

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for proxyUri.

getReservationAffinity()

public abstract ReservationAffinity getReservationAffinity()

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

.google.cloud.notebooks.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReservationAffinity	The reservationAffinity.

getReservationAffinityOrBuilder()

public abstract ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

.google.cloud.notebooks.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReservationAffinityOrBuilder

getServiceAccount()

public abstract String getServiceAccount()

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 7;

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public abstract ByteString getServiceAccountBytes()

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 7;

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getServiceAccountScopes(int index)

public abstract String getServiceAccountScopes(int index)

Optional. The URIs of service account scopes to be included in Compute Engine instances.

If not specified, the following scopes are defined:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute

repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
String	The serviceAccountScopes at the given index.

getServiceAccountScopesBytes(int index)

public abstract ByteString getServiceAccountScopesBytes(int index)

Optional. The URIs of service account scopes to be included in Compute Engine instances.

If not specified, the following scopes are defined:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute

repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
ByteString	The bytes of the serviceAccountScopes at the given index.

getServiceAccountScopesCount()

public abstract int getServiceAccountScopesCount()

Optional. The URIs of service account scopes to be included in Compute Engine instances.

If not specified, the following scopes are defined:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute

repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of serviceAccountScopes.

getServiceAccountScopesList()

public abstract List<String> getServiceAccountScopesList()

Optional. The URIs of service account scopes to be included in Compute Engine instances.

If not specified, the following scopes are defined:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute

repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the serviceAccountScopes.

getShieldedInstanceConfig()

public abstract Instance.ShieldedInstanceConfig getShieldedInstanceConfig()

Optional. Shielded VM configuration. Images using supported Shielded VM features.

.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Instance.ShieldedInstanceConfig	The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract Instance.ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Optional. Shielded VM configuration. Images using supported Shielded VM features.

.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Instance.ShieldedInstanceConfigOrBuilder

getState()

public abstract Instance.State getState()

Output only. The state of this instance.

.google.cloud.notebooks.v1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Instance.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of this instance.

.google.cloud.notebooks.v1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getSubnet()

public abstract String getSubnet()

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

string subnet = 20;

Returns
Type	Description
String	The subnet.

getSubnetBytes()

public abstract ByteString getSubnetBytes()

The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

string subnet = 20;

Returns
Type	Description
ByteString	The bytes for subnet.

getTags(int index)

public abstract String getTags(int index)

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
String	The tags at the given index.

getTagsBytes(int index)

public abstract ByteString getTagsBytes(int index)

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
ByteString	The bytes of the tags at the given index.

getTagsCount()

public abstract int getTagsCount()

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of tags.

getTagsList()

public abstract List<String> getTagsList()

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

repeated string tags = 32 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the tags.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Instance update time.

.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Instance update time.

.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getUpgradeHistory(int index)

public abstract Instance.UpgradeHistoryEntry getUpgradeHistory(int index)

The upgrade history of this instance.

repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;

Parameter
Name	Description
index	int

Returns
Type	Description
Instance.UpgradeHistoryEntry

getUpgradeHistoryCount()

public abstract int getUpgradeHistoryCount()

The upgrade history of this instance.

repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;

Returns
Type	Description
int

getUpgradeHistoryList()

public abstract List<Instance.UpgradeHistoryEntry> getUpgradeHistoryList()

The upgrade history of this instance.

repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;

Returns
Type	Description
List<UpgradeHistoryEntry>

getUpgradeHistoryOrBuilder(int index)

public abstract Instance.UpgradeHistoryEntryOrBuilder getUpgradeHistoryOrBuilder(int index)

The upgrade history of this instance.

repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;

Parameter
Name	Description
index	int

Returns
Type	Description
Instance.UpgradeHistoryEntryOrBuilder

getUpgradeHistoryOrBuilderList()

public abstract List<? extends Instance.UpgradeHistoryEntryOrBuilder> getUpgradeHistoryOrBuilderList()

The upgrade history of this instance.

repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;

Returns
Type	Description
List<? extends com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntryOrBuilder>

getVmImage()

public abstract VmImage getVmImage()

Use a Compute Engine VM image to start the notebook instance.

.google.cloud.notebooks.v1.VmImage vm_image = 2;

Returns
Type	Description
VmImage	The vmImage.

getVmImageOrBuilder()

public abstract VmImageOrBuilder getVmImageOrBuilder()

Use a Compute Engine VM image to start the notebook instance.

.google.cloud.notebooks.v1.VmImage vm_image = 2;

Returns
Type	Description
VmImageOrBuilder

hasAcceleratorConfig()

public abstract boolean hasAcceleratorConfig()

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the machine_type you have selected.

.google.cloud.notebooks.v1.Instance.AcceleratorConfig accelerator_config = 9;

Returns
Type	Description
boolean	Whether the acceleratorConfig field is set.

hasContainerImage()

public abstract boolean hasContainerImage()

Use a container image to start the notebook instance.

.google.cloud.notebooks.v1.ContainerImage container_image = 3;

Returns
Type	Description
boolean	Whether the containerImage field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Instance creation time.

.google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasReservationAffinity()

public abstract boolean hasReservationAffinity()

Optional. The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this notebook instance.

.google.cloud.notebooks.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the reservationAffinity field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

Optional. Shielded VM configuration. Images using supported Shielded VM features.

.google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the shieldedInstanceConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Instance update time.

.google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.

hasVmImage()

public abstract boolean hasVmImage()

Use a Compute Engine VM image to start the notebook instance.

.google.cloud.notebooks.v1.VmImage vm_image = 2;

Returns
Type	Description
boolean	Whether the vmImage field is set.