com.google.cloud.notebooks.v1.VirtualMachineConfigOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Proto library for google-cloud-notebooks
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/notebooks/v1/runtime.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.notebooks.v1;
public interface VirtualMachineConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v1.VirtualMachineConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The zone.
*/
java.lang.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];
*
* @return The bytes for zone.
*/
com.google.protobuf.ByteString getZoneBytes();
/**
*
*
*
* 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];
*
* @return The machineType.
*/
java.lang.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];
*
* @return The bytes for machineType.
*/
com.google.protobuf.ByteString getMachineTypeBytes();
/**
*
*
*
* 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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.notebooks.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.notebooks.v1.ContainerImageOrBuilder getContainerImagesOrBuilder(int index);
/**
*
*
*
* Required. Data disk option configuration settings.
*
*
*
* .google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the dataDisk field is set.
*/
boolean hasDataDisk();
/**
*
*
*
* Required. Data disk option configuration settings.
*
*
*
* .google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The dataDisk.
*/
com.google.cloud.notebooks.v1.LocalDisk getDataDisk();
/**
*
*
*
* Required. Data disk option configuration settings.
*
*
*
* .google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.notebooks.v1.LocalDiskOrBuilder getDataDiskOrBuilder();
/**
*
*
*
* Optional. Encryption settings for virtual machine data disk.
*
*
*
* .google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the encryptionConfig field is set.
*/
boolean hasEncryptionConfig();
/**
*
*
*
* Optional. Encryption settings for virtual machine data disk.
*
*
*
* .google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The encryptionConfig.
*/
com.google.cloud.notebooks.v1.EncryptionConfig getEncryptionConfig();
/**
*
*
*
* Optional. Encryption settings for virtual machine data disk.
*
*
*
* .google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.notebooks.v1.EncryptionConfigOrBuilder getEncryptionConfigOrBuilder();
/**
*
*
*
* Optional. Shielded VM Instance configuration settings.
*
*
*
* .google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the shieldedInstanceConfig field is set.
*/
boolean hasShieldedInstanceConfig();
/**
*
*
*
* Optional. Shielded VM Instance configuration settings.
*
*
*
* .google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The shieldedInstanceConfig.
*/
com.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig getShieldedInstanceConfig();
/**
*
*
*
* Optional. Shielded VM Instance configuration settings.
*
*
*
* .google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.notebooks.v1.RuntimeShieldedInstanceConfigOrBuilder
getShieldedInstanceConfigOrBuilder();
/**
*
*
*
* Optional. The Compute Engine accelerator configuration for this runtime.
*
*
*
* .google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the acceleratorConfig field is set.
*/
boolean hasAcceleratorConfig();
/**
*
*
*
* Optional. The Compute Engine accelerator configuration for this runtime.
*
*
*
* .google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The acceleratorConfig.
*/
com.google.cloud.notebooks.v1.RuntimeAcceleratorConfig getAcceleratorConfig();
/**
*
*
*
* Optional. The Compute Engine accelerator configuration for this runtime.
*
*
*
* .google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.notebooks.v1.RuntimeAcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder();
/**
*
*
*
* 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];
*
* @return The network.
*/
java.lang.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];
*
* @return The bytes for network.
*/
com.google.protobuf.ByteString getNetworkBytes();
/**
*
*
*
* 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];
*
* @return The subnet.
*/
java.lang.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];
*
* @return The bytes for subnet.
*/
com.google.protobuf.ByteString getSubnetBytes();
/**
*
*
*
* 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];
*
* @return The internalIpOnly.
*/
boolean getInternalIpOnly();
/**
*
*
*
* Optional. The Compute Engine tags to add to runtime (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @return A list containing the tags.
*/
java.util.List getTagsList();
/**
*
*
*
* Optional. The Compute Engine tags to add to runtime (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The count of tags.
*/
int getTagsCount();
/**
*
*
*
* Optional. The Compute Engine tags to add to runtime (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the element to return.
* @return The tags at the given index.
*/
java.lang.String getTags(int index);
/**
*
*
*
* Optional. The Compute Engine tags to add to runtime (see [Tagging
* instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
*
*
* repeated string tags = 13 [(.google.api.field_behavior) = OPTIONAL];
*
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
com.google.protobuf.ByteString getTagsBytes(int index);
/**
*
*
*
* Output only. The Compute Engine guest attributes. (see
* [Project and instance
* guest
* attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
*
*
*
* map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getGuestAttributesCount();
/**
*
*
*
* Output only. The Compute Engine guest attributes. (see
* [Project and instance
* guest
* attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
*
*
*
* map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
boolean containsGuestAttributes(java.lang.String key);
/** Use {@link #getGuestAttributesMap()} instead. */
@java.lang.Deprecated
java.util.Map getGuestAttributes();
/**
*
*
*
* Output only. The Compute Engine guest attributes. (see
* [Project and instance
* guest
* attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
*
*
*
* map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.Map getGuestAttributesMap();
/**
*
*
*
* Output only. The Compute Engine guest attributes. (see
* [Project and instance
* guest
* attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
*
*
*
* map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
/* nullable */
java.lang.String getGuestAttributesOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Output only. The Compute Engine guest attributes. (see
* [Project and instance
* guest
* attributes](https://cloud.google.com/compute/docs/storing-retrieving-metadata#guest_attributes)).
*
*
*
* map<string, string> guest_attributes = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.lang.String getGuestAttributesOrThrow(java.lang.String key);
/**
*
*
*
* Optional. The Compute Engine metadata entries to add to virtual machine. (see
* [Project and instance
* metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
*
*
* map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];
*/
int getMetadataCount();
/**
*
*
*
* Optional. The Compute Engine metadata entries to add to virtual machine. (see
* [Project and instance
* metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
*
*
* map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsMetadata(java.lang.String key);
/** Use {@link #getMetadataMap()} instead. */
@java.lang.Deprecated
java.util.Map getMetadata();
/**
*
*
*
* Optional. The Compute Engine metadata entries to add to virtual machine. (see
* [Project and instance
* metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
*
*
* map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getMetadataMap();
/**
*
*
*
* Optional. The Compute Engine metadata entries to add to virtual machine. (see
* [Project and instance
* metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
*
*
* map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getMetadataOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. The Compute Engine metadata entries to add to virtual machine. (see
* [Project and instance
* metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
*
*
* map<string, string> metadata = 15 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getMetadataOrThrow(java.lang.String key);
/**
*
*
*
* Optional. The labels to associate with this runtime.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a cluster.
*
*
* map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. The labels to associate with this runtime.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a cluster.
*
*
* map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. The labels to associate with this runtime.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a cluster.
*
*
* map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. The labels to associate with this runtime.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a cluster.
*
*
* map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. The labels to associate with this runtime.
* Label **keys** must contain 1 to 63 characters, and must conform to
* [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
* Label **values** may be empty, but, if present, must contain 1 to 63
* characters, and must conform to [RFC
* 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
* associated with a cluster.
*
*
* map<string, string> labels = 16 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for nicType.
*/
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];
*
*
* @return The nicType.
*/
com.google.cloud.notebooks.v1.VirtualMachineConfig.NicType getNicType();
/**
*
*
*
* 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];
*
* @return The reservedIpRange.
*/
java.lang.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];
*
* @return The bytes for reservedIpRange.
*/
com.google.protobuf.ByteString getReservedIpRangeBytes();
/**
*
*
*
* Optional. Boot image metadata used for runtime upgradeability.
*
*
*
* .google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the bootImage field is set.
*/
boolean hasBootImage();
/**
*
*
*
* Optional. Boot image metadata used for runtime upgradeability.
*
*
*
* .google.cloud.notebooks.v1.VirtualMachineConfig.BootImage boot_image = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The bootImage.
*/
com.google.cloud.notebooks.v1.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];
*
*/
com.google.cloud.notebooks.v1.VirtualMachineConfig.BootImageOrBuilder getBootImageOrBuilder();
}