Interface VirtualMachineConfigOrBuilder (1.41.0) 

public interface VirtualMachineConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsGuestAttributes(String key)

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

getAcceleratorConfigOrBuilder()

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

getBootImageOrBuilder()

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

getContainerImagesCount()

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

getDataDiskOrBuilder()

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

getEncryptionConfig()

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

getEncryptionConfigOrBuilder()

public abstract 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() (deprecated)

public abstract Map<String,String> getGuestAttributes()

Use #getGuestAttributesMap() instead.

Returns
Type Description
Map<String,String>

getGuestAttributesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

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

getNetwork()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 &#92;
   --global &#92;
   --prefix-length=24 &#92;
   --description="Google Cloud Managed Notebooks Range 24 c" &#92;
   --network=$NETWORK &#92;
   --addresses=192.168.0.0 &#92;
   --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 abstract 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 &#92;
   --global &#92;
   --prefix-length=24 &#92;
   --description="Google Cloud Managed Notebooks Range 24 c" &#92;
   --network=$NETWORK &#92;
   --addresses=192.168.0.0 &#92;
   --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 abstract 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.

getShieldedInstanceConfigOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the tags.

getZone()

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