Class Instance.Builder (1.25.0)

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

The definition of a notebook instance.

Protobuf type google.cloud.notebooks.v1.Instance

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instance.Builder

Implements

InstanceOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllDisks(Iterable<? extends Instance.Disk> values)

public Instance.Builder addAllDisks(Iterable<? extends Instance.Disk> values)

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
`values`	`Iterable<? extends com.google.cloud.notebooks.v1.Instance.Disk>`

Returns
Type	Description
`Instance.Builder`

addAllInstanceOwners(Iterable<String> values)

public Instance.Builder addAllInstanceOwners(Iterable<String> values)

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

Parameter
Name	Description
`values`	`Iterable<String>` The instanceOwners to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addAllServiceAccountScopes(Iterable<String> values)

public Instance.Builder addAllServiceAccountScopes(Iterable<String> values)

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
`values`	`Iterable<String>` The serviceAccountScopes to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addAllTags(Iterable<String> values)

public Instance.Builder addAllTags(Iterable<String> values)

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

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

Parameter
Name	Description
`values`	`Iterable<String>` The tags to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addAllUpgradeHistory(Iterable<? extends Instance.UpgradeHistoryEntry> values)

public Instance.Builder addAllUpgradeHistory(Iterable<? extends Instance.UpgradeHistoryEntry> values)

The upgrade history of this instance.

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

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry>`

Returns
Type	Description
`Instance.Builder`

addDisks(Instance.Disk value)

public Instance.Builder addDisks(Instance.Disk value)

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
`value`	`Instance.Disk`

Returns
Type	Description
`Instance.Builder`

addDisks(Instance.Disk.Builder builderForValue)

public Instance.Builder addDisks(Instance.Disk.Builder builderForValue)

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
`builderForValue`	`Instance.Disk.Builder`

Returns
Type	Description
`Instance.Builder`

addDisks(int index, Instance.Disk value)

public Instance.Builder addDisks(int index, Instance.Disk value)

Output only. Attached disks to notebook instance.

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

Parameters
Name	Description
`index`	`int`
`value`	`Instance.Disk`

Returns
Type	Description
`Instance.Builder`

addDisks(int index, Instance.Disk.Builder builderForValue)

public Instance.Builder addDisks(int index, Instance.Disk.Builder builderForValue)

Output only. Attached disks to notebook instance.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Instance.Disk.Builder`

Returns
Type	Description
`Instance.Builder`

addDisksBuilder()

public Instance.Disk.Builder addDisksBuilder()

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
`Instance.Disk.Builder`

addDisksBuilder(int index)

public Instance.Disk.Builder addDisksBuilder(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.Builder`

addInstanceOwners(String value)

public Instance.Builder addInstanceOwners(String value)

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

Parameter
Name	Description
`value`	`String` The instanceOwners to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addInstanceOwnersBytes(ByteString value)

public Instance.Builder addInstanceOwnersBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes of the instanceOwners to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addServiceAccountScopes(String value)

public Instance.Builder addServiceAccountScopes(String value)

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
`value`	`String` The serviceAccountScopes to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addServiceAccountScopesBytes(ByteString value)

public Instance.Builder addServiceAccountScopesBytes(ByteString value)

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
`value`	`ByteString` The bytes of the serviceAccountScopes to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addTags(String value)

public Instance.Builder addTags(String value)

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

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

Parameter
Name	Description
`value`	`String` The tags to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addTagsBytes(ByteString value)

public Instance.Builder addTagsBytes(ByteString value)

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

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

Parameter
Name	Description
`value`	`ByteString` The bytes of the tags to add.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

addUpgradeHistory(Instance.UpgradeHistoryEntry value)

public Instance.Builder addUpgradeHistory(Instance.UpgradeHistoryEntry value)

The upgrade history of this instance.

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

Parameter
Name	Description
`value`	`Instance.UpgradeHistoryEntry`

Returns
Type	Description
`Instance.Builder`

addUpgradeHistory(Instance.UpgradeHistoryEntry.Builder builderForValue)

public Instance.Builder addUpgradeHistory(Instance.UpgradeHistoryEntry.Builder builderForValue)

The upgrade history of this instance.

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

Parameter
Name	Description
`builderForValue`	`Instance.UpgradeHistoryEntry.Builder`

Returns
Type	Description
`Instance.Builder`

addUpgradeHistory(int index, Instance.UpgradeHistoryEntry value)

public Instance.Builder addUpgradeHistory(int index, Instance.UpgradeHistoryEntry value)

The upgrade history of this instance.

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

Parameters
Name	Description
`index`	`int`
`value`	`Instance.UpgradeHistoryEntry`

Returns
Type	Description
`Instance.Builder`

addUpgradeHistory(int index, Instance.UpgradeHistoryEntry.Builder builderForValue)

public Instance.Builder addUpgradeHistory(int index, Instance.UpgradeHistoryEntry.Builder builderForValue)

The upgrade history of this instance.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Instance.UpgradeHistoryEntry.Builder`

Returns
Type	Description
`Instance.Builder`

addUpgradeHistoryBuilder()

public Instance.UpgradeHistoryEntry.Builder addUpgradeHistoryBuilder()

The upgrade history of this instance.

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

Returns
Type	Description
`Instance.UpgradeHistoryEntry.Builder`

addUpgradeHistoryBuilder(int index)

public Instance.UpgradeHistoryEntry.Builder addUpgradeHistoryBuilder(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.Builder`

build()

public Instance build()

Returns
Type	Description
`Instance`

buildPartial()

public Instance buildPartial()

Returns
Type	Description
`Instance`

clear()

public Instance.Builder clear()

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAcceleratorConfig()

public Instance.Builder clearAcceleratorConfig()

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.Builder`

clearBootDiskSizeGb()

public Instance.Builder clearBootDiskSizeGb()

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
`Instance.Builder`	This builder for chaining.

clearBootDiskType()

public Instance.Builder clearBootDiskType()

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.Builder`	This builder for chaining.

clearCanIpForward()

public Instance.Builder clearCanIpForward()

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
`Instance.Builder`	This builder for chaining.

clearContainerImage()

public Instance.Builder clearContainerImage()

Use a container image to start the notebook instance.

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

Returns
Type	Description
`Instance.Builder`

clearCreateTime()

public Instance.Builder clearCreateTime()

Output only. Instance creation time.

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

Returns
Type	Description
`Instance.Builder`

clearCreator()

public Instance.Builder clearCreator()

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

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

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

clearCustomGpuDriverPath()

public Instance.Builder clearCustomGpuDriverPath()

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
`Instance.Builder`	This builder for chaining.

clearDataDiskSizeGb()

public Instance.Builder clearDataDiskSizeGb()

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
`Instance.Builder`	This builder for chaining.

clearDataDiskType()

public Instance.Builder clearDataDiskType()

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.Builder`	This builder for chaining.

clearDiskEncryption()

public Instance.Builder clearDiskEncryption()

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.Builder`	This builder for chaining.

clearDisks()

public Instance.Builder clearDisks()

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
`Instance.Builder`

clearEnvironment()

public Instance.Builder clearEnvironment()

Returns
Type	Description
`Instance.Builder`

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInstallGpuDriver()

public Instance.Builder clearInstallGpuDriver()

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
`Instance.Builder`	This builder for chaining.

clearInstanceOwners()

public Instance.Builder clearInstanceOwners()

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
Type	Description
`Instance.Builder`	This builder for chaining.

clearKmsKey()

public Instance.Builder clearKmsKey()

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
`Instance.Builder`	This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()

Returns
Type	Description
`Instance.Builder`

clearMachineType()

public Instance.Builder clearMachineType()

Required. The Compute Engine machine type of this instance.

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

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

clearMetadata()

public Instance.Builder clearMetadata()

Returns
Type	Description
`Instance.Builder`

clearName()

public Instance.Builder clearName()

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
`Instance.Builder`	This builder for chaining.

clearNetwork()

public Instance.Builder clearNetwork()

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

string network = 19;

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

clearNicType()

public Instance.Builder clearNicType()

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.Builder`	This builder for chaining.

clearNoProxyAccess()

public Instance.Builder clearNoProxyAccess()

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

bool no_proxy_access = 18;

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

clearNoPublicIp()

public Instance.Builder clearNoPublicIp()

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

bool no_public_ip = 17;

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

clearNoRemoveDataDisk()

public Instance.Builder clearNoRemoveDataDisk()

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
`Instance.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPostStartupScript()

public Instance.Builder clearPostStartupScript()

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
`Instance.Builder`	This builder for chaining.

clearProxyUri()

public Instance.Builder clearProxyUri()

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
`Instance.Builder`	This builder for chaining.

clearReservationAffinity()

public Instance.Builder clearReservationAffinity()

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
`Instance.Builder`

clearServiceAccount()

public Instance.Builder clearServiceAccount()

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
`Instance.Builder`	This builder for chaining.

clearServiceAccountScopes()

public Instance.Builder clearServiceAccountScopes()

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
`Instance.Builder`	This builder for chaining.

clearShieldedInstanceConfig()

public Instance.Builder clearShieldedInstanceConfig()

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.Builder`

clearState()

public Instance.Builder clearState()

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.Builder`	This builder for chaining.

clearSubnet()

public Instance.Builder clearSubnet()

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
`Instance.Builder`	This builder for chaining.

clearTags()

public Instance.Builder clearTags()

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

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

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

clearUpdateTime()

public Instance.Builder clearUpdateTime()

Output only. Instance update time.

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

Returns
Type	Description
`Instance.Builder`

clearUpgradeHistory()

public Instance.Builder clearUpgradeHistory()

The upgrade history of this instance.

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

Returns
Type	Description
`Instance.Builder`

clearVmImage()

public Instance.Builder clearVmImage()

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

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

Returns
Type	Description
`Instance.Builder`

clone()

public Instance.Builder clone()

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsMetadata(String key)

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

getAcceleratorConfigBuilder()

public Instance.AcceleratorConfig.Builder getAcceleratorConfigBuilder()

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.Builder`

getAcceleratorConfigOrBuilder()

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

getContainerImageBuilder()

public ContainerImage.Builder getContainerImageBuilder()

Use a container image to start the notebook instance.

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

Returns
Type	Description
`ContainerImage.Builder`

getContainerImageOrBuilder()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Instance creation time.

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

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

public 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 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 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 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 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 long getDataDiskSizeGb()

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

Returns
Type	Description
`long`	The dataDiskSizeGb.

getDataDiskType()

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

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()

Returns
Type	Description
`Instance`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDiskEncryption()

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

getDisksBuilder(int index)

public Instance.Disk.Builder getDisksBuilder(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.Builder`

getDisksBuilderList()

public List<Instance.Disk.Builder> getDisksBuilderList()

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<Builder>`

getDisksCount()

public 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 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 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 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 Instance.EnvironmentCase getEnvironmentCase()

Returns
Type	Description
`Instance.EnvironmentCase`

getInstallGpuDriver()

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

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

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 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
Type	Description
`int`	The count of instanceOwners.

getInstanceOwnersList()

public ProtocolStringList 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
Type	Description
`ProtocolStringList`	A list containing the instanceOwners.

getKmsKey()

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

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

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

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getMachineType()

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

Use #getMetadataMap() instead.

Returns
Type	Description
`Map<String,String>`

getMetadataCount()

public int getMetadataCount()

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Returns
Type	Description
`int`

getMetadataMap()

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

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getMutableMetadata()

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getName()

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

getReservationAffinityBuilder()

public ReservationAffinity.Builder getReservationAffinityBuilder()

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.Builder`

getReservationAffinityOrBuilder()

public 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 String getServiceAccount()

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

string service_account = 7;

Returns
Type	Description
`String`	The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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 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 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 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 ProtocolStringList 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
`ProtocolStringList`	A list containing the serviceAccountScopes.

getShieldedInstanceConfig()

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

getShieldedInstanceConfigBuilder()

public Instance.ShieldedInstanceConfig.Builder getShieldedInstanceConfigBuilder()

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.Builder`

getShieldedInstanceConfigOrBuilder()

public 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 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 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 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 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 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 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 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 ProtocolStringList 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
`ProtocolStringList`	A list containing the tags.

getUpdateTime()

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

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Instance update time.

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

Returns
Type	Description
`Builder`

getUpdateTimeOrBuilder()

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

getUpgradeHistoryBuilder(int index)

public Instance.UpgradeHistoryEntry.Builder getUpgradeHistoryBuilder(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.Builder`

getUpgradeHistoryBuilderList()

public List<Instance.UpgradeHistoryEntry.Builder> getUpgradeHistoryBuilderList()

The upgrade history of this instance.

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

Returns
Type	Description
`List<Builder>`

getUpgradeHistoryCount()

public int getUpgradeHistoryCount()

The upgrade history of this instance.

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

Returns
Type	Description
`int`

getUpgradeHistoryList()

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

getVmImageBuilder()

public VmImage.Builder getVmImageBuilder()

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

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

Returns
Type	Description
`VmImage.Builder`

getVmImageOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAcceleratorConfig(Instance.AcceleratorConfig value)

public Instance.Builder mergeAcceleratorConfig(Instance.AcceleratorConfig value)

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;

Parameter
Name	Description
`value`	`Instance.AcceleratorConfig`

Returns
Type	Description
`Instance.Builder`

mergeContainerImage(ContainerImage value)

public Instance.Builder mergeContainerImage(ContainerImage value)

Use a container image to start the notebook instance.

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

Parameter
Name	Description
`value`	`ContainerImage`

Returns
Type	Description
`Instance.Builder`

mergeCreateTime(Timestamp value)

public Instance.Builder mergeCreateTime(Timestamp value)

Output only. Instance creation time.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Instance.Builder`

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)

Parameter
Name	Description
`other`	`Instance`

Returns
Type	Description
`Instance.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Instance.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Instance.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeReservationAffinity(ReservationAffinity value)

public Instance.Builder mergeReservationAffinity(ReservationAffinity value)

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

Parameter
Name	Description
`value`	`ReservationAffinity`

Returns
Type	Description
`Instance.Builder`

mergeShieldedInstanceConfig(Instance.ShieldedInstanceConfig value)

public Instance.Builder mergeShieldedInstanceConfig(Instance.ShieldedInstanceConfig value)

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

Parameter
Name	Description
`value`	`Instance.ShieldedInstanceConfig`

Returns
Type	Description
`Instance.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Instance.Builder mergeUpdateTime(Timestamp value)

Output only. Instance update time.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Instance.Builder`

mergeVmImage(VmImage value)

public Instance.Builder mergeVmImage(VmImage value)

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

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

Parameter
Name	Description
`value`	`VmImage`

Returns
Type	Description
`Instance.Builder`

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

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

map<string, string> labels = 21;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`Instance.Builder`

putAllMetadata(Map<String,String> values)

public Instance.Builder putAllMetadata(Map<String,String> values)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`Instance.Builder`

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

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`
`value`	`String`

Returns
Type	Description
`Instance.Builder`

putMetadata(String key, String value)

public Instance.Builder putMetadata(String key, String value)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`Instance.Builder`

removeDisks(int index)

public Instance.Builder removeDisks(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.Builder`

removeLabels(String key)

public Instance.Builder removeLabels(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
`Instance.Builder`

removeMetadata(String key)

public Instance.Builder removeMetadata(String key)

Custom metadata to apply to this instance.

map<string, string> metadata = 22;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Instance.Builder`

removeUpgradeHistory(int index)

public Instance.Builder removeUpgradeHistory(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.Builder`

setAcceleratorConfig(Instance.AcceleratorConfig value)

public Instance.Builder setAcceleratorConfig(Instance.AcceleratorConfig value)

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;

Parameter
Name	Description
`value`	`Instance.AcceleratorConfig`

Returns
Type	Description
`Instance.Builder`

setAcceleratorConfig(Instance.AcceleratorConfig.Builder builderForValue)

public Instance.Builder setAcceleratorConfig(Instance.AcceleratorConfig.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Instance.AcceleratorConfig.Builder`

Returns
Type	Description
`Instance.Builder`

setBootDiskSizeGb(long value)

public Instance.Builder setBootDiskSizeGb(long value)

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

Parameter
Name	Description
`value`	`long` The bootDiskSizeGb to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setBootDiskType(Instance.DiskType value)

public Instance.Builder setBootDiskType(Instance.DiskType value)

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

Parameter
Name	Description
`value`	`Instance.DiskType` The bootDiskType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setBootDiskTypeValue(int value)

public Instance.Builder setBootDiskTypeValue(int value)

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for bootDiskType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setCanIpForward(boolean value)

public Instance.Builder setCanIpForward(boolean value)

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

Parameter
Name	Description
`value`	`boolean` The canIpForward to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setContainerImage(ContainerImage value)

public Instance.Builder setContainerImage(ContainerImage value)

Use a container image to start the notebook instance.

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

Parameter
Name	Description
`value`	`ContainerImage`

Returns
Type	Description
`Instance.Builder`

setContainerImage(ContainerImage.Builder builderForValue)

public Instance.Builder setContainerImage(ContainerImage.Builder builderForValue)

Use a container image to start the notebook instance.

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

Parameter
Name	Description
`builderForValue`	`ContainerImage.Builder`

Returns
Type	Description
`Instance.Builder`

setCreateTime(Timestamp value)

public Instance.Builder setCreateTime(Timestamp value)

Output only. Instance creation time.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Instance.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Instance creation time.

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Instance.Builder`

setCreator(String value)

public Instance.Builder setCreator(String value)

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

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

Parameter
Name	Description
`value`	`String` The creator to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setCreatorBytes(ByteString value)

public Instance.Builder setCreatorBytes(ByteString value)

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

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

Parameter
Name	Description
`value`	`ByteString` The bytes for creator to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setCustomGpuDriverPath(String value)

public Instance.Builder setCustomGpuDriverPath(String value)

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;

Parameter
Name	Description
`value`	`String` The customGpuDriverPath to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setCustomGpuDriverPathBytes(ByteString value)

public Instance.Builder setCustomGpuDriverPathBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for customGpuDriverPath to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setDataDiskSizeGb(long value)

public Instance.Builder setDataDiskSizeGb(long value)

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

Parameter
Name	Description
`value`	`long` The dataDiskSizeGb to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setDataDiskType(Instance.DiskType value)

public Instance.Builder setDataDiskType(Instance.DiskType value)

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

Parameter
Name	Description
`value`	`Instance.DiskType` The dataDiskType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setDataDiskTypeValue(int value)

public Instance.Builder setDataDiskTypeValue(int value)

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dataDiskType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setDiskEncryption(Instance.DiskEncryption value)

public Instance.Builder setDiskEncryption(Instance.DiskEncryption value)

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

Parameter
Name	Description
`value`	`Instance.DiskEncryption` The diskEncryption to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setDiskEncryptionValue(int value)

public Instance.Builder setDiskEncryptionValue(int value)

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for diskEncryption to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setDisks(int index, Instance.Disk value)

public Instance.Builder setDisks(int index, Instance.Disk value)

Output only. Attached disks to notebook instance.

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

Parameters
Name	Description
`index`	`int`
`value`	`Instance.Disk`

Returns
Type	Description
`Instance.Builder`

setDisks(int index, Instance.Disk.Builder builderForValue)

public Instance.Builder setDisks(int index, Instance.Disk.Builder builderForValue)

Output only. Attached disks to notebook instance.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Instance.Disk.Builder`

Returns
Type	Description
`Instance.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInstallGpuDriver(boolean value)

public Instance.Builder setInstallGpuDriver(boolean value)

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;

Parameter
Name	Description
`value`	`boolean` The installGpuDriver to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setInstanceOwners(int index, String value)

public Instance.Builder setInstanceOwners(int index, String value)

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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The instanceOwners to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setKmsKey(String value)

public Instance.Builder setKmsKey(String value)

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

Parameter
Name	Description
`value`	`String` The kmsKey to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setKmsKeyBytes(ByteString value)

public Instance.Builder setKmsKeyBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for kmsKey to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setMachineType(String value)

public Instance.Builder setMachineType(String value)

Required. The Compute Engine machine type of this instance.

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

Parameter
Name	Description
`value`	`String` The machineType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setMachineTypeBytes(ByteString value)

public Instance.Builder setMachineTypeBytes(ByteString value)

Required. The Compute Engine machine type of this instance.

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

Parameter
Name	Description
`value`	`ByteString` The bytes for machineType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setName(String value)

public Instance.Builder setName(String value)

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNetwork(String value)

public Instance.Builder setNetwork(String value)

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

string network = 19;

Parameter
Name	Description
`value`	`String` The network to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNetworkBytes(ByteString value)

public Instance.Builder setNetworkBytes(ByteString value)

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

string network = 19;

Parameter
Name	Description
`value`	`ByteString` The bytes for network to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNicType(Instance.NicType value)

public Instance.Builder setNicType(Instance.NicType value)

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

Parameter
Name	Description
`value`	`Instance.NicType` The nicType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNicTypeValue(int value)

public Instance.Builder setNicTypeValue(int value)

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for nicType to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNoProxyAccess(boolean value)

public Instance.Builder setNoProxyAccess(boolean value)

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

bool no_proxy_access = 18;

Parameter
Name	Description
`value`	`boolean` The noProxyAccess to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNoPublicIp(boolean value)

public Instance.Builder setNoPublicIp(boolean value)

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

bool no_public_ip = 17;

Parameter
Name	Description
`value`	`boolean` The noPublicIp to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setNoRemoveDataDisk(boolean value)

public Instance.Builder setNoRemoveDataDisk(boolean value)

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

Parameter
Name	Description
`value`	`boolean` The noRemoveDataDisk to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setPostStartupScript(String value)

public Instance.Builder setPostStartupScript(String value)

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;

Parameter
Name	Description
`value`	`String` The postStartupScript to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setPostStartupScriptBytes(ByteString value)

public Instance.Builder setPostStartupScriptBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for postStartupScript to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setProxyUri(String value)

public Instance.Builder setProxyUri(String value)

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

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

Parameter
Name	Description
`value`	`String` The proxyUri to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setProxyUriBytes(ByteString value)

public Instance.Builder setProxyUriBytes(ByteString value)

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

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

Parameter
Name	Description
`value`	`ByteString` The bytes for proxyUri to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReservationAffinity(ReservationAffinity value)

public Instance.Builder setReservationAffinity(ReservationAffinity value)

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

Parameter
Name	Description
`value`	`ReservationAffinity`

Returns
Type	Description
`Instance.Builder`

setReservationAffinity(ReservationAffinity.Builder builderForValue)

public Instance.Builder setReservationAffinity(ReservationAffinity.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`ReservationAffinity.Builder`

Returns
Type	Description
`Instance.Builder`

setServiceAccount(String value)

public Instance.Builder setServiceAccount(String value)

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

string service_account = 7;

Parameter
Name	Description
`value`	`String` The serviceAccount to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setServiceAccountBytes(ByteString value)

public Instance.Builder setServiceAccountBytes(ByteString value)

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

string service_account = 7;

Parameter
Name	Description
`value`	`ByteString` The bytes for serviceAccount to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setServiceAccountScopes(int index, String value)

public Instance.Builder setServiceAccountScopes(int index, String value)

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

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The serviceAccountScopes to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setShieldedInstanceConfig(Instance.ShieldedInstanceConfig value)

public Instance.Builder setShieldedInstanceConfig(Instance.ShieldedInstanceConfig value)

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

Parameter
Name	Description
`value`	`Instance.ShieldedInstanceConfig`

Returns
Type	Description
`Instance.Builder`

setShieldedInstanceConfig(Instance.ShieldedInstanceConfig.Builder builderForValue)

public Instance.Builder setShieldedInstanceConfig(Instance.ShieldedInstanceConfig.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`Instance.ShieldedInstanceConfig.Builder`

Returns
Type	Description
`Instance.Builder`

setState(Instance.State value)

public Instance.Builder setState(Instance.State value)

Output only. The state of this instance.

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

Parameter
Name	Description
`value`	`Instance.State` The state to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

Output only. The state of this instance.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for state to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setSubnet(String value)

public Instance.Builder setSubnet(String value)

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

string subnet = 20;

Parameter
Name	Description
`value`	`String` The subnet to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setSubnetBytes(ByteString value)

public Instance.Builder setSubnetBytes(ByteString value)

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

string subnet = 20;

Parameter
Name	Description
`value`	`ByteString` The bytes for subnet to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setTags(int index, String value)

public Instance.Builder setTags(int index, String value)

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

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

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The tags to set.

Returns
Type	Description
`Instance.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Instance.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Instance.Builder setUpdateTime(Timestamp value)

Output only. Instance update time.

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Instance.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public Instance.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Instance update time.

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Instance.Builder`

setUpgradeHistory(int index, Instance.UpgradeHistoryEntry value)

public Instance.Builder setUpgradeHistory(int index, Instance.UpgradeHistoryEntry value)

The upgrade history of this instance.

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

Parameters
Name	Description
`index`	`int`
`value`	`Instance.UpgradeHistoryEntry`

Returns
Type	Description
`Instance.Builder`

setUpgradeHistory(int index, Instance.UpgradeHistoryEntry.Builder builderForValue)

public Instance.Builder setUpgradeHistory(int index, Instance.UpgradeHistoryEntry.Builder builderForValue)

The upgrade history of this instance.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Instance.UpgradeHistoryEntry.Builder`

Returns
Type	Description
`Instance.Builder`

setVmImage(VmImage value)

public Instance.Builder setVmImage(VmImage value)

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

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

Parameter
Name	Description
`value`	`VmImage`

Returns
Type	Description
`Instance.Builder`

setVmImage(VmImage.Builder builderForValue)

public Instance.Builder setVmImage(VmImage.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`VmImage.Builder`

Returns
Type	Description
`Instance.Builder`