public final class VirtualMachineConfig extends GeneratedMessageV3 implements VirtualMachineConfigOrBuilder
The config settings for virtual machine.
Protobuf type google.cloud.notebooks.v1.VirtualMachineConfig
Static Fields
ACCELERATOR_CONFIG_FIELD_NUMBER
public static final int ACCELERATOR_CONFIG_FIELD_NUMBER
Field Value
BOOT_IMAGE_FIELD_NUMBER
public static final int BOOT_IMAGE_FIELD_NUMBER
Field Value
CONTAINER_IMAGES_FIELD_NUMBER
public static final int CONTAINER_IMAGES_FIELD_NUMBER
Field Value
DATA_DISK_FIELD_NUMBER
public static final int DATA_DISK_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
GUEST_ATTRIBUTES_FIELD_NUMBER
public static final int GUEST_ATTRIBUTES_FIELD_NUMBER
Field Value
INTERNAL_IP_ONLY_FIELD_NUMBER
public static final int INTERNAL_IP_ONLY_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Field Value
NIC_TYPE_FIELD_NUMBER
public static final int NIC_TYPE_FIELD_NUMBER
Field Value
RESERVED_IP_RANGE_FIELD_NUMBER
public static final int RESERVED_IP_RANGE_FIELD_NUMBER
Field Value
SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
SUBNET_FIELD_NUMBER
public static final int SUBNET_FIELD_NUMBER
Field Value
public static final int TAGS_FIELD_NUMBER
Field Value
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static VirtualMachineConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static VirtualMachineConfig.Builder newBuilder()
Returns
newBuilder(VirtualMachineConfig prototype)
public static VirtualMachineConfig.Builder newBuilder(VirtualMachineConfig prototype)
Parameter
Returns
public static VirtualMachineConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static VirtualMachineConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static VirtualMachineConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachineConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static VirtualMachineConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachineConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static VirtualMachineConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static VirtualMachineConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static VirtualMachineConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static VirtualMachineConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static VirtualMachineConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VirtualMachineConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<VirtualMachineConfig> parser()
Returns
Methods
containsGuestAttributes(String key)
public boolean containsGuestAttributes(String key)
Parameter
Returns
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];
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
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];
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];
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];
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];
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];
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];
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];
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];
| 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];
getDataDiskOrBuilder()
public LocalDiskOrBuilder getDataDiskOrBuilder()
Required. Data disk option configuration settings.
.google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];
getDefaultInstanceForType()
public VirtualMachineConfig getDefaultInstanceForType()
Returns
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];
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];
getGuestAttributes()
public Map<String,String> getGuestAttributes()
Returns
getGuestAttributesCount()
public int getGuestAttributesCount()
Returns
getGuestAttributesMap()
public Map<String,String> getGuestAttributesMap()
Returns
getGuestAttributesOrDefault(String key, String defaultValue)
public String getGuestAttributesOrDefault(String key, String defaultValue)
Parameters
Returns
getGuestAttributesOrThrow(String key)
public String getGuestAttributesOrThrow(String key)
Parameter
Returns
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];
| Type | Description |
| boolean | The internalIpOnly.
|
getLabels()
public Map<String,String> getLabels()
Returns
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];
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];
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];
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];
getMachineType()
public String getMachineType()
Required. The Compute Engine machine type used for runtimes.
Short name is valid. Examples:
n1-standard-2e2-standard-8
string machine_type = 2 [(.google.api.field_behavior) = REQUIRED];
| 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-2e2-standard-8
string machine_type = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for machineType.
|
public Map<String,String> getMetadata()
Returns
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];
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];
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];
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];
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]/regions/global/defaultprojects/[project_id]/regions/global/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];
| 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]/regions/global/defaultprojects/[project_id]/regions/global/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];
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for nicType.
|
getParserForType()
public Parser<VirtualMachineConfig> getParserForType()
Returns
Overrides
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];
| 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];
| Type | Description |
| ByteString | The bytes for reservedIpRange.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getShieldedInstanceConfig()
public RuntimeShieldedInstanceConfig getShieldedInstanceConfig()
Optional. Shielded VM Instance configuration settings.
.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
getShieldedInstanceConfigOrBuilder()
public RuntimeShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
Optional. Shielded VM Instance configuration settings.
.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
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/sub0projects/[project_id]/regions/us-east1/subnetworks/sub0
string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];
| 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/sub0projects/[project_id]/regions/us-east1/subnetworks/sub0
string subnet = 9 [(.google.api.field_behavior) = OPTIONAL];
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];
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The tags at the given 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];
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the tags at the given index.
|
public int getTagsCount()
Optional. The Compute Engine tags to add to runtime (see Tagging
instances).
repeated string tags = 13 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The count of tags.
|
public ProtocolStringList getTagsList()
Optional. The Compute Engine tags to add to runtime (see Tagging
instances).
repeated string tags = 13 [(.google.api.field_behavior) = OPTIONAL];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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:
string zone = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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:
string zone = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the shieldedInstanceConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public VirtualMachineConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VirtualMachineConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public VirtualMachineConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
