InstanceOrBuilder (proto-google-cloud-notebooks-v1beta1 0.38.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Instance, Instance.Builder
```
public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Labels to apply to this instance.
`boolean`	`containsMetadata(String key)` Custom metadata to apply to this instance.
`Instance.AcceleratorConfig`	`getAcceleratorConfig()` The hardware accelerator used on this instance.
`Instance.AcceleratorConfigOrBuilder`	`getAcceleratorConfigOrBuilder()` The hardware accelerator used on this instance.
`long`	`getBootDiskSizeGb()` Input only.
`Instance.DiskType`	`getBootDiskType()` Input only.
`int`	`getBootDiskTypeValue()` Input only.
`boolean`	`getCanIpForward()` Optional.
`ContainerImage`	`getContainerImage()` Use a container image to start the notebook instance.
`ContainerImageOrBuilder`	`getContainerImageOrBuilder()` Use a container image to start the notebook instance.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`String`	`getCustomGpuDriverPath()` Specify a custom Cloud Storage path where the GPU driver is stored.
`com.google.protobuf.ByteString`	`getCustomGpuDriverPathBytes()` Specify a custom Cloud Storage path where the GPU driver is stored.
`long`	`getDataDiskSizeGb()` Input only.
`Instance.DiskType`	`getDataDiskType()` Input only.
`int`	`getDataDiskTypeValue()` Input only.
`Instance.DiskEncryption`	`getDiskEncryption()` Input only.
`int`	`getDiskEncryptionValue()` Input only.
`Instance.EnvironmentCase`	`getEnvironmentCase()`
`boolean`	`getInstallGpuDriver()` Whether the end user authorizes Google Cloud to install GPU driver on this instance.
`String`	`getInstanceOwners(int index)` Input only.
`com.google.protobuf.ByteString`	`getInstanceOwnersBytes(int index)` Input only.
`int`	`getInstanceOwnersCount()` Input only.
`List<String>`	`getInstanceOwnersList()` Input only.
`String`	`getKmsKey()` Input only.
`com.google.protobuf.ByteString`	`getKmsKeyBytes()` Input only.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels to apply to this instance.
`Map<String,String>`	`getLabelsMap()` Labels to apply to this instance.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels to apply to this instance.
`String`	`getLabelsOrThrow(String key)` Labels to apply to this instance.
`String`	`getMachineType()` Required.
`com.google.protobuf.ByteString`	`getMachineTypeBytes()` Required.
`Map<String,String>`	`getMetadata()` Deprecated.
`int`	`getMetadataCount()` Custom metadata to apply to this instance.
`Map<String,String>`	`getMetadataMap()` Custom metadata to apply to this instance.
`String`	`getMetadataOrDefault(String key, String defaultValue)` Custom metadata to apply to this instance.
`String`	`getMetadataOrThrow(String key)` Custom metadata to apply to this instance.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`String`	`getNetwork()` The name of the VPC that this instance is in.
`com.google.protobuf.ByteString`	`getNetworkBytes()` The name of the VPC that this instance is in.
`Instance.NicType`	`getNicType()` Optional.
`int`	`getNicTypeValue()` Optional.
`boolean`	`getNoProxyAccess()` If true, the notebook instance will not register with the proxy.
`boolean`	`getNoPublicIp()` If true, no public IP will be assigned to this instance.
`boolean`	`getNoRemoveDataDisk()` Input only.
`String`	`getPostStartupScript()` Path to a Bash script that automatically runs after a notebook instance fully boots up.
`com.google.protobuf.ByteString`	`getPostStartupScriptBytes()` Path to a Bash script that automatically runs after a notebook instance fully boots up.
`String`	`getProxyUri()` Output only.
`com.google.protobuf.ByteString`	`getProxyUriBytes()` Output only.
`ReservationAffinity`	`getReservationAffinity()` Optional.
`ReservationAffinityOrBuilder`	`getReservationAffinityOrBuilder()` Optional.
`String`	`getServiceAccount()` The service account on this instance, giving access to other Google Cloud services.
`com.google.protobuf.ByteString`	`getServiceAccountBytes()` The service account on this instance, giving access to other Google Cloud services.
`Instance.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`String`	`getSubnet()` The name of the subnet that this instance is in.
`com.google.protobuf.ByteString`	`getSubnetBytes()` The name of the subnet that this instance is in.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`VmImage`	`getVmImage()` Use a Compute Engine VM image to start the notebook instance.
`VmImageOrBuilder`	`getVmImageOrBuilder()` Use a Compute Engine VM image to start the notebook instance.
`boolean`	`hasAcceleratorConfig()` The hardware accelerator used on this instance.
`boolean`	`hasContainerImage()` Use a container image to start the notebook instance.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasReservationAffinity()` Optional.
`boolean`	`hasUpdateTime()` Output only.
`boolean`	`hasVmImage()` Use a Compute Engine VM image to start the notebook instance.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getName

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:: The name.

getNameBytes

com.google.protobuf.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:: The bytes for name.

hasVmImage
```
boolean hasVmImage()
```
```
 Use a Compute Engine VM image to start the notebook instance.
 
```
.google.cloud.notebooks.v1beta1.VmImage vm_image = 2;
Returns:

Whether the vmImage field is set.

getVmImage

VmImage getVmImage()

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

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

Returns:: The vmImage.

getVmImageOrBuilder

VmImageOrBuilder getVmImageOrBuilder()

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

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

hasContainerImage
```
boolean hasContainerImage()
```
```
 Use a container image to start the notebook instance.
 
```
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
Returns:

Whether the containerImage field is set.

getContainerImage
```
ContainerImage getContainerImage()
```
```
 Use a container image to start the notebook instance.
 
```
.google.cloud.notebooks.v1beta1.ContainerImage container_image = 3;
Returns:

The containerImage.

getContainerImageOrBuilder

ContainerImageOrBuilder getContainerImageOrBuilder()

 Use a container image to start the notebook instance.

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

getPostStartupScript

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:: The postStartupScript.

getPostStartupScriptBytes

com.google.protobuf.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:: The bytes for postStartupScript.

getProxyUri

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:: The proxyUri.

getProxyUriBytes

com.google.protobuf.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:: The bytes for proxyUri.

getInstanceOwnersList

List<String> getInstanceOwnersList()

 Input only. The owner of this instance after creation. Format: `alias@example.com`

 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:: A list containing the instanceOwners.

getInstanceOwnersCount

int getInstanceOwnersCount()

 Input only. The owner of this instance after creation. Format: `alias@example.com`

 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:: The count of instanceOwners.

getInstanceOwners

String getInstanceOwners(int index)

 Input only. The owner of this instance after creation. Format: `alias@example.com`

 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];

Parameters:: index - The index of the element to return.
Returns:: The instanceOwners at the given index.

getInstanceOwnersBytes

com.google.protobuf.ByteString getInstanceOwnersBytes(int index)

 Input only. The owner of this instance after creation. Format: `alias@example.com`

 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];

Parameters:: index - The index of the value to return.
Returns:: The bytes of the instanceOwners at the given index.

getServiceAccount

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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.

string service_account = 7;

Returns:: The serviceAccount.

getServiceAccountBytes

com.google.protobuf.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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.

string service_account = 7;

Returns:: The bytes for serviceAccount.

getMachineType

String getMachineType()

 Required. The [Compute Engine machine
 type](https://cloud.google.com/compute/docs/machine-types) of this
 instance.

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

Returns:: The machineType.

getMachineTypeBytes

com.google.protobuf.ByteString getMachineTypeBytes()

 Required. The [Compute Engine machine
 type](https://cloud.google.com/compute/docs/machine-types) of this
 instance.

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

Returns:: The bytes for machineType.

hasAcceleratorConfig

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](https://cloud.google.com/compute/docs/gpus/#gpus-list).

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

Returns:: Whether the acceleratorConfig field is set.

getAcceleratorConfig

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](https://cloud.google.com/compute/docs/gpus/#gpus-list).

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

Returns:: The acceleratorConfig.

getAcceleratorConfigOrBuilder

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](https://cloud.google.com/compute/docs/gpus/#gpus-list).

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

getStateValue
```
int getStateValue()
```
```
 Output only. The state of this instance.
 
```
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns:

The enum numeric value on the wire for state.

getState
```
Instance.State getState()
```
```
 Output only. The state of this instance.
 
```
.google.cloud.notebooks.v1beta1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns:

The state.

getInstallGpuDriver

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:: The installGpuDriver.

getCustomGpuDriverPath

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:: The customGpuDriverPath.

getCustomGpuDriverPathBytes

com.google.protobuf.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:: The bytes for customGpuDriverPath.

getBootDiskTypeValue
```
int getBootDiskTypeValue()
```
```
 Input only. The type of the boot disk attached to this instance, defaults to
 standard persistent disk (`PD_STANDARD`).
 
```
.google.cloud.notebooks.v1beta1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];
Returns:

The enum numeric value on the wire for bootDiskType.

getBootDiskType

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.v1beta1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];

Returns:: The bootDiskType.

getBootDiskSizeGb

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:: The bootDiskSizeGb.

getDataDiskTypeValue
```
int getDataDiskTypeValue()
```
```
 Input only. The type of the data disk attached to this instance, defaults to
 standard persistent disk (`PD_STANDARD`).
 
```
.google.cloud.notebooks.v1beta1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];
Returns:

The enum numeric value on the wire for dataDiskType.

getDataDiskType

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.v1beta1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];

Returns:: The dataDiskType.

getDataDiskSizeGb

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:: The dataDiskSizeGb.

getNoRemoveDataDisk

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:: The noRemoveDataDisk.

getDiskEncryptionValue
```
int getDiskEncryptionValue()
```
```
 Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
 
```
.google.cloud.notebooks.v1beta1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
Returns:

The enum numeric value on the wire for diskEncryption.

getDiskEncryption
```
Instance.DiskEncryption getDiskEncryption()
```
```
 Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
 
```
.google.cloud.notebooks.v1beta1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
Returns:

The diskEncryption.

getKmsKey

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](https://cloud.google.com/kms/docs/quickstart).

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

Returns:: The kmsKey.

getKmsKeyBytes

com.google.protobuf.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](https://cloud.google.com/kms/docs/quickstart).

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

Returns:: The bytes for kmsKey.

getNoPublicIp

boolean getNoPublicIp()

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

bool no_public_ip = 17;

Returns:: The noPublicIp.

getNoProxyAccess

boolean getNoProxyAccess()

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

bool no_proxy_access = 18;

Returns:: The noProxyAccess.

getNetwork

String getNetwork()

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

string network = 19;

Returns:: The network.

getNetworkBytes

com.google.protobuf.ByteString getNetworkBytes()

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

string network = 19;

Returns:: The bytes for network.

getSubnet

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:: The subnet.

getSubnetBytes

com.google.protobuf.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:: The bytes for subnet.

getLabelsCount

int getLabelsCount()

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

map<string, string> labels = 21;

containsLabels

boolean containsLabels(String key)

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

map<string, string> labels = 21;

getLabels
```
@Deprecated
Map<String,String> getLabels()
```
Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

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

map<string, string> labels = 21;

getLabelsOrDefault

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;

getLabelsOrThrow

String getLabelsOrThrow(String key)

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

map<string, string> labels = 21;