Class VirtualMachineConfig.Builder (1.9.0)

Version 1.9.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.3
• 1.0.6
• 0.6.2

public static final class VirtualMachineConfig.Builder extends GeneratedMessageV3.Builder<VirtualMachineConfig.Builder> implements VirtualMachineConfigOrBuilder

The config settings for virtual machine.

Protobuf type google.cloud.notebooks.v1.VirtualMachineConfig

Inheritance

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

Implements

VirtualMachineConfigOrBuilder

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

addAllContainerImages(Iterable<? extends ContainerImage> values)

public VirtualMachineConfig.Builder addAllContainerImages(Iterable<? extends ContainerImage> values)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.notebooks.v1.ContainerImage>

Returns

Type	Description
VirtualMachineConfig.Builder

addAllTags(Iterable<String> values)

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

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

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

Parameter

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

addContainerImages(ContainerImage value)

public VirtualMachineConfig.Builder addContainerImages(ContainerImage value)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ContainerImage

Returns

Type	Description
VirtualMachineConfig.Builder

addContainerImages(ContainerImage.Builder builderForValue)

public VirtualMachineConfig.Builder addContainerImages(ContainerImage.Builder builderForValue)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	ContainerImage.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

addContainerImages(int index, ContainerImage value)

public VirtualMachineConfig.Builder addContainerImages(int index, ContainerImage value)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
index	int
value	ContainerImage

Returns

Type	Description
VirtualMachineConfig.Builder

addContainerImages(int index, ContainerImage.Builder builderForValue)

public VirtualMachineConfig.Builder addContainerImages(int index, ContainerImage.Builder builderForValue)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
index	int
builderForValue	ContainerImage.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

addContainerImagesBuilder()

public ContainerImage.Builder addContainerImagesBuilder()

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ContainerImage.Builder

addContainerImagesBuilder(int index)

public ContainerImage.Builder addContainerImagesBuilder(int index)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int

Returns

Type	Description
ContainerImage.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

addTags(String value)

public VirtualMachineConfig.Builder addTags(String value)

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

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

Parameter

Name	Description
value	String The tags to add.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

addTagsBytes(ByteString value)

public VirtualMachineConfig.Builder addTagsBytes(ByteString value)

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

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

Parameter

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

build()

public VirtualMachineConfig build()

Returns

Type	Description
VirtualMachineConfig

buildPartial()

public VirtualMachineConfig buildPartial()

Returns

Type	Description
VirtualMachineConfig

clear()

public VirtualMachineConfig.Builder clear()

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAcceleratorConfig()

public VirtualMachineConfig.Builder clearAcceleratorConfig()

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder

clearBootImage()

public VirtualMachineConfig.Builder clearBootImage()

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder

clearContainerImages()

public VirtualMachineConfig.Builder clearContainerImages()

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder

clearDataDisk()

public VirtualMachineConfig.Builder clearDataDisk()

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
VirtualMachineConfig.Builder

clearEncryptionConfig()

public VirtualMachineConfig.Builder clearEncryptionConfig()

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public VirtualMachineConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

clearGuestAttributes()

public VirtualMachineConfig.Builder clearGuestAttributes()

Returns

Type	Description
VirtualMachineConfig.Builder

clearInternalIpOnly()

public VirtualMachineConfig.Builder clearInternalIpOnly()

Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

bool internal_ip_only = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearLabels()

public VirtualMachineConfig.Builder clearLabels()

Returns

Type	Description
VirtualMachineConfig.Builder

clearMachineType()

public VirtualMachineConfig.Builder clearMachineType()

Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

• n1-standard-2
• e2-standard-8

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearMetadata()

public VirtualMachineConfig.Builder clearMetadata()

Returns

Type	Description
VirtualMachineConfig.Builder

clearNetwork()

public VirtualMachineConfig.Builder clearNetwork()

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
• Google Managed Network (Network & subnet are empty)
• Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
• Shared VPC (network & subnet are required). Requires configuring Private Service Access.

string network = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearNicType()

public VirtualMachineConfig.Builder clearNicType()

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

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VirtualMachineConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

clearReservedIpRange()

public VirtualMachineConfig.Builder clearReservedIpRange()

Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: managed-notebooks-range-c

string reserved_ip_range = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearShieldedInstanceConfig()

public VirtualMachineConfig.Builder clearShieldedInstanceConfig()

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder

clearSubnet()

public VirtualMachineConfig.Builder clearSubnet()

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
• projects/[project_id]/regions/us-east1/subnetworks/sub0

string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearTags()

public VirtualMachineConfig.Builder clearTags()

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

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clearZone()

public VirtualMachineConfig.Builder clearZone()

Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

• us-central1-b

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

clone()

public VirtualMachineConfig.Builder clone()

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsGuestAttributes(String key)

public boolean containsGuestAttributes(String key)

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

containsMetadata(String key)

public boolean containsMetadata(String key)

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getAcceleratorConfig()

public RuntimeAcceleratorConfig getAcceleratorConfig()

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
RuntimeAcceleratorConfig	The acceleratorConfig.

getAcceleratorConfigBuilder()

public RuntimeAcceleratorConfig.Builder getAcceleratorConfigBuilder()

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
RuntimeAcceleratorConfig.Builder

getAcceleratorConfigOrBuilder()

public RuntimeAcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
RuntimeAcceleratorConfigOrBuilder

getBootImage()

public VirtualMachineConfig.BootImage getBootImage()

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.BootImage	The bootImage.

getBootImageBuilder()

public VirtualMachineConfig.BootImage.Builder getBootImageBuilder()

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.BootImage.Builder

getBootImageOrBuilder()

public VirtualMachineConfig.BootImageOrBuilder getBootImageOrBuilder()

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
VirtualMachineConfig.BootImageOrBuilder

getContainerImages(int index)

public ContainerImage getContainerImages(int index)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int

Returns

Type	Description
ContainerImage

getContainerImagesBuilder(int index)

public ContainerImage.Builder getContainerImagesBuilder(int index)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int

Returns

Type	Description
ContainerImage.Builder

getContainerImagesBuilderList()

public List<ContainerImage.Builder> getContainerImagesBuilderList()

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
List<Builder>

getContainerImagesCount()

public int getContainerImagesCount()

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int

getContainerImagesList()

public List<ContainerImage> getContainerImagesList()

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
List<ContainerImage>

getContainerImagesOrBuilder(int index)

public ContainerImageOrBuilder getContainerImagesOrBuilder(int index)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int

Returns

Type	Description
ContainerImageOrBuilder

getContainerImagesOrBuilderList()

public List<? extends ContainerImageOrBuilder> getContainerImagesOrBuilderList()

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
List<? extends com.google.cloud.notebooks.v1.ContainerImageOrBuilder>

getDataDisk()

public LocalDisk getDataDisk()

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
LocalDisk	The dataDisk.

getDataDiskBuilder()

public LocalDisk.Builder getDataDiskBuilder()

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
LocalDisk.Builder

getDataDiskOrBuilder()

public LocalDiskOrBuilder getDataDiskOrBuilder()

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
LocalDiskOrBuilder

getDefaultInstanceForType()

public VirtualMachineConfig getDefaultInstanceForType()

Returns

Type	Description
VirtualMachineConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEncryptionConfig()

public EncryptionConfig getEncryptionConfig()

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
EncryptionConfig	The encryptionConfig.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
EncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
EncryptionConfigOrBuilder

getGuestAttributes()

public Map<String,String> getGuestAttributes()

Use #getGuestAttributesMap() instead.

Returns

Type	Description
Map<String,String>

getGuestAttributesCount()

public int getGuestAttributesCount()

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int

getGuestAttributesMap()

public Map<String,String> getGuestAttributesMap()

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Map<String,String>

getGuestAttributesOrDefault(String key, String defaultValue)

public String getGuestAttributesOrDefault(String key, String defaultValue)

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getGuestAttributesOrThrow(String key)

public String getGuestAttributesOrThrow(String key)

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
String

getInternalIpOnly()

public boolean getInternalIpOnly()

Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

bool internal_ip_only = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	The internalIpOnly.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
String

getMachineType()

public String getMachineType()

Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

• n1-standard-2
• e2-standard-8

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

Returns

Type	Description
String	The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

• n1-standard-2
• e2-standard-8

string machine_type = 2 [(.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()

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
String

getMutableGuestAttributes()

public Map<String,String> getMutableGuestAttributes()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,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>

getNetwork()

public String getNetwork()

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
• Google Managed Network (Network & subnet are empty)
• Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
• Shared VPC (network & subnet are required). Requires configuring Private Service Access.

string network = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
• Google Managed Network (Network & subnet are empty)
• Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
• Shared VPC (network & subnet are required). Requires configuring Private Service Access.

string network = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for network.

getNicType()

public VirtualMachineConfig.NicType getNicType()

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

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

Returns

Type	Description
VirtualMachineConfig.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.VirtualMachineConfig.NicType nic_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns

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

getReservedIpRange()

public String getReservedIpRange()

Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: managed-notebooks-range-c

string reserved_ip_range = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The reservedIpRange.

getReservedIpRangeBytes()

public ByteString getReservedIpRangeBytes()

Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: managed-notebooks-range-c

string reserved_ip_range = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for reservedIpRange.

getShieldedInstanceConfig()

public RuntimeShieldedInstanceConfig getShieldedInstanceConfig()

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
RuntimeShieldedInstanceConfig	The shieldedInstanceConfig.

getShieldedInstanceConfigBuilder()

public RuntimeShieldedInstanceConfig.Builder getShieldedInstanceConfigBuilder()

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
RuntimeShieldedInstanceConfig.Builder

getShieldedInstanceConfigOrBuilder()

public RuntimeShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
RuntimeShieldedInstanceConfigOrBuilder

getSubnet()

public String getSubnet()

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
• projects/[project_id]/regions/us-east1/subnetworks/sub0

string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The subnet.

getSubnetBytes()

public ByteString getSubnetBytes()

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
• projects/[project_id]/regions/us-east1/subnetworks/sub0

string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];

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 = 13 [(.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 = 13 [(.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 = 13 [(.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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ProtocolStringList	A list containing the tags.

getZone()

public String getZone()

Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

• us-central1-b

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

Returns

Type	Description
String	The zone.

getZoneBytes()

public ByteString getZoneBytes()

Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

• us-central1-b

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

Returns

Type	Description
ByteString	The bytes for zone.

hasAcceleratorConfig()

public boolean hasAcceleratorConfig()

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the acceleratorConfig field is set.

hasBootImage()

public boolean hasBootImage()

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the bootImage field is set.

hasDataDisk()

public boolean hasDataDisk()

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the dataDisk field is set.

hasEncryptionConfig()

public boolean hasEncryptionConfig()

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the encryptionConfig field is set.

hasShieldedInstanceConfig()

public boolean hasShieldedInstanceConfig()

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	Whether the shieldedInstanceConfig 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(RuntimeAcceleratorConfig value)

public VirtualMachineConfig.Builder mergeAcceleratorConfig(RuntimeAcceleratorConfig value)

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	RuntimeAcceleratorConfig

Returns

Type	Description
VirtualMachineConfig.Builder

mergeBootImage(VirtualMachineConfig.BootImage value)

public VirtualMachineConfig.Builder mergeBootImage(VirtualMachineConfig.BootImage value)

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	VirtualMachineConfig.BootImage

Returns

Type	Description
VirtualMachineConfig.Builder

mergeDataDisk(LocalDisk value)

public VirtualMachineConfig.Builder mergeDataDisk(LocalDisk value)

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	LocalDisk

Returns

Type	Description
VirtualMachineConfig.Builder

mergeEncryptionConfig(EncryptionConfig value)

public VirtualMachineConfig.Builder mergeEncryptionConfig(EncryptionConfig value)

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	EncryptionConfig

Returns

Type	Description
VirtualMachineConfig.Builder

mergeFrom(VirtualMachineConfig other)

public VirtualMachineConfig.Builder mergeFrom(VirtualMachineConfig other)

Parameter

Name	Description
other	VirtualMachineConfig

Returns

Type	Description
VirtualMachineConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public VirtualMachineConfig.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

mergeShieldedInstanceConfig(RuntimeShieldedInstanceConfig value)

public VirtualMachineConfig.Builder mergeShieldedInstanceConfig(RuntimeShieldedInstanceConfig value)

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	RuntimeShieldedInstanceConfig

Returns

Type	Description
VirtualMachineConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VirtualMachineConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

putAllGuestAttributes(Map<String,String> values)

public VirtualMachineConfig.Builder putAllGuestAttributes(Map<String,String> values)

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
values	Map<String,String>

Returns

Type	Description
VirtualMachineConfig.Builder

putAllLabels(Map<String,String> values)

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

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	Map<String,String>

Returns

Type	Description
VirtualMachineConfig.Builder

putAllMetadata(Map<String,String> values)

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

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	Map<String,String>

Returns

Type	Description
VirtualMachineConfig.Builder

putGuestAttributes(String key, String value)

public VirtualMachineConfig.Builder putGuestAttributes(String key, String value)

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters

Name	Description
key	String
value	String

Returns

Type	Description
VirtualMachineConfig.Builder

putLabels(String key, String value)

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

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	String
value	String

Returns

Type	Description
VirtualMachineConfig.Builder

putMetadata(String key, String value)

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

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	String
value	String

Returns

Type	Description
VirtualMachineConfig.Builder

removeContainerImages(int index)

public VirtualMachineConfig.Builder removeContainerImages(int index)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int

Returns

Type	Description
VirtualMachineConfig.Builder

removeGuestAttributes(String key)

public VirtualMachineConfig.Builder removeGuestAttributes(String key)

Output only. The Compute Engine guest attributes. (see Project and instance guest attributes).

map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
key	String

Returns

Type	Description
VirtualMachineConfig.Builder

removeLabels(String key)

public VirtualMachineConfig.Builder removeLabels(String key)

Optional. The labels to associate with this runtime. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
VirtualMachineConfig.Builder

removeMetadata(String key)

public VirtualMachineConfig.Builder removeMetadata(String key)

Optional. The Compute Engine metadata entries to add to virtual machine. (see Project and instance metadata).

map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	String

Returns

Type	Description
VirtualMachineConfig.Builder

setAcceleratorConfig(RuntimeAcceleratorConfig value)

public VirtualMachineConfig.Builder setAcceleratorConfig(RuntimeAcceleratorConfig value)

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	RuntimeAcceleratorConfig

Returns

Type	Description
VirtualMachineConfig.Builder

setAcceleratorConfig(RuntimeAcceleratorConfig.Builder builderForValue)

public VirtualMachineConfig.Builder setAcceleratorConfig(RuntimeAcceleratorConfig.Builder builderForValue)

Optional. The Compute Engine accelerator configuration for this runtime.

.google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	RuntimeAcceleratorConfig.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

setBootImage(VirtualMachineConfig.BootImage value)

public VirtualMachineConfig.Builder setBootImage(VirtualMachineConfig.BootImage value)

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	VirtualMachineConfig.BootImage

Returns

Type	Description
VirtualMachineConfig.Builder

setBootImage(VirtualMachineConfig.BootImage.Builder builderForValue)

public VirtualMachineConfig.Builder setBootImage(VirtualMachineConfig.BootImage.Builder builderForValue)

Optional. Boot image metadata used for runtime upgradeability.

.google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	VirtualMachineConfig.BootImage.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

setContainerImages(int index, ContainerImage value)

public VirtualMachineConfig.Builder setContainerImages(int index, ContainerImage value)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
index	int
value	ContainerImage

Returns

Type	Description
VirtualMachineConfig.Builder

setContainerImages(int index, ContainerImage.Builder builderForValue)

public VirtualMachineConfig.Builder setContainerImages(int index, ContainerImage.Builder builderForValue)

Optional. Use a list of container images to use as Kernels in the notebook instance.

repeated .google.cloud.notebooks.v1.ContainerImage container_images = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
index	int
builderForValue	ContainerImage.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

setDataDisk(LocalDisk value)

public VirtualMachineConfig.Builder setDataDisk(LocalDisk value)

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	LocalDisk

Returns

Type	Description
VirtualMachineConfig.Builder

setDataDisk(LocalDisk.Builder builderForValue)

public VirtualMachineConfig.Builder setDataDisk(LocalDisk.Builder builderForValue)

Required. Data disk option configuration settings.

.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	LocalDisk.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

setEncryptionConfig(EncryptionConfig value)

public VirtualMachineConfig.Builder setEncryptionConfig(EncryptionConfig value)

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	EncryptionConfig

Returns

Type	Description
VirtualMachineConfig.Builder

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public VirtualMachineConfig.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

Optional. Encryption settings for virtual machine data disk.

.google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	EncryptionConfig.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

setInternalIpOnly(boolean value)

public VirtualMachineConfig.Builder setInternalIpOnly(boolean value)

Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.

bool internal_ip_only = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	boolean The internalIpOnly to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setMachineType(String value)

public VirtualMachineConfig.Builder setMachineType(String value)

Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

• n1-standard-2
• e2-standard-8

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

Parameter

Name	Description
value	String The machineType to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setMachineTypeBytes(ByteString value)

public VirtualMachineConfig.Builder setMachineTypeBytes(ByteString value)

Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples:

• n1-standard-2
• e2-standard-8

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

Parameter

Name	Description
value	ByteString The bytes for machineType to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setNetwork(String value)

public VirtualMachineConfig.Builder setNetwork(String value)

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
• Google Managed Network (Network & subnet are empty)
• Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
• Shared VPC (network & subnet are required). Requires configuring Private Service Access.

string network = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The network to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setNetworkBytes(ByteString value)

public VirtualMachineConfig.Builder setNetworkBytes(ByteString value)

Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither network nor subnet is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default
• projects/[project_id]/global/networks/default Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations:
• Google Managed Network (Network & subnet are empty)
• Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access.
• Shared VPC (network & subnet are required). Requires configuring Private Service Access.

string network = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for network to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setNicType(VirtualMachineConfig.NicType value)

public VirtualMachineConfig.Builder setNicType(VirtualMachineConfig.NicType value)

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

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

Parameter

Name	Description
value	VirtualMachineConfig.NicType The nicType to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setNicTypeValue(int value)

public VirtualMachineConfig.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.VirtualMachineConfig.NicType nic_type = 17 [(.google.api.field_behavior) = OPTIONAL];

Parameter

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

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

setReservedIpRange(String value)

public VirtualMachineConfig.Builder setReservedIpRange(String value)

Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: managed-notebooks-range-c

string reserved_ip_range = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The reservedIpRange to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setReservedIpRangeBytes(ByteString value)

public VirtualMachineConfig.Builder setReservedIpRangeBytes(ByteString value)

Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range name if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: managed-notebooks-range-c

string reserved_ip_range = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for reservedIpRange to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setShieldedInstanceConfig(RuntimeShieldedInstanceConfig value)

public VirtualMachineConfig.Builder setShieldedInstanceConfig(RuntimeShieldedInstanceConfig value)

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	RuntimeShieldedInstanceConfig

Returns

Type	Description
VirtualMachineConfig.Builder

setShieldedInstanceConfig(RuntimeShieldedInstanceConfig.Builder builderForValue)

public VirtualMachineConfig.Builder setShieldedInstanceConfig(RuntimeShieldedInstanceConfig.Builder builderForValue)

Optional. Shielded VM Instance configuration settings.

.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
builderForValue	RuntimeShieldedInstanceConfig.Builder

Returns

Type	Description
VirtualMachineConfig.Builder

setSubnet(String value)

public VirtualMachineConfig.Builder setSubnet(String value)

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
• projects/[project_id]/regions/us-east1/subnetworks/sub0

string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	String The subnet to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setSubnetBytes(ByteString value)

public VirtualMachineConfig.Builder setSubnetBytes(ByteString value)

Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples:

• https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
• projects/[project_id]/regions/us-east1/subnetworks/sub0

string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	ByteString The bytes for subnet to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setTags(int index, String value)

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

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

repeated string tags = 13 [(.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
VirtualMachineConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VirtualMachineConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
VirtualMachineConfig.Builder

Overrides

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

setZone(String value)

public VirtualMachineConfig.Builder setZone(String value)

Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

• us-central1-b

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

Parameter

Name	Description
value	String The zone to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.

setZoneBytes(ByteString value)

public VirtualMachineConfig.Builder setZoneBytes(ByteString value)

Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example:

• us-central1-b

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

Parameter

Name	Description
value	ByteString The bytes for zone to set.

Returns

Type	Description
VirtualMachineConfig.Builder	This builder for chaining.