Package com.google.cloud.notebooks.v1

Interface VirtualMachineConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    VirtualMachineConfig, VirtualMachineConfig.Builder
    public interface VirtualMachineConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getZone

        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:
        The zone.

      • getZoneBytes

        com.google.protobuf.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:
        The bytes for zone.

      • getMachineType

        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:
        The machineType.

      • getMachineTypeBytes

        com.google.protobuf.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:
        The bytes for machineType.

      • getContainerImagesList

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

      • getContainerImages

        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

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

      • getContainerImagesOrBuilderList

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

      • getContainerImagesOrBuilder

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

      • hasDataDisk

        boolean hasDataDisk()
         Required. Data disk option configuration settings.
        .google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the dataDisk field is set.

      • getDataDisk

        LocalDisk getDataDisk()
         Required. Data disk option configuration settings.
        .google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The dataDisk.

      • getDataDiskOrBuilder

        LocalDiskOrBuilder getDataDiskOrBuilder()
         Required. Data disk option configuration settings.
        .google.cloud.notebooks.v1.LocalDisk data_disk = 4 [(.google.api.field_behavior) = REQUIRED];

      • hasEncryptionConfig

        boolean hasEncryptionConfig()
         Optional. Encryption settings for virtual machine data disk.
        .google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the encryptionConfig field is set.

      • getEncryptionConfig

        EncryptionConfig getEncryptionConfig()
         Optional. Encryption settings for virtual machine data disk.
        .google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The encryptionConfig.

      • getEncryptionConfigOrBuilder

        EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
         Optional. Encryption settings for virtual machine data disk.
        .google.cloud.notebooks.v1.EncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];

      • hasShieldedInstanceConfig

        boolean hasShieldedInstanceConfig()
         Optional. Shielded VM Instance configuration settings.
        .google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the shieldedInstanceConfig field is set.

      • getShieldedInstanceConfig

        RuntimeShieldedInstanceConfig getShieldedInstanceConfig()
         Optional. Shielded VM Instance configuration settings.
        .google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The shieldedInstanceConfig.

      • getShieldedInstanceConfigOrBuilder

        RuntimeShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
         Optional. Shielded VM Instance configuration settings.
        .google.cloud.notebooks.v1.RuntimeShieldedInstanceConfig shielded_instance_config = 6 [(.google.api.field_behavior) = OPTIONAL];

      • hasAcceleratorConfig

        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:
        Whether the acceleratorConfig field is set.

      • getAcceleratorConfig

        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:
        The acceleratorConfig.

      • getAcceleratorConfigOrBuilder

        RuntimeAcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()
         Optional. The Compute Engine accelerator configuration for this runtime.
        .google.cloud.notebooks.v1.RuntimeAcceleratorConfig accelerator_config = 7 [(.google.api.field_behavior) = OPTIONAL];

      • getNetwork

        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:
        The network.

      • getNetworkBytes

        com.google.protobuf.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:
        The bytes for network.

      • getSubnet

        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:
        The subnet.

      • getSubnetBytes

        com.google.protobuf.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:
        The bytes for subnet.

      • getInternalIpOnly

        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:
        The internalIpOnly.

      • getTagsList

        List<String> 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];
        Returns:
        A list containing the tags.

      • getTagsCount

        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];
        Returns:
        The count of tags.

      • getTags

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The tags at the given index.

      • getTagsBytes

        com.google.protobuf.ByteString getTagsBytes​(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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tags at the given index.

      • getGuestAttributesCount

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

      • containsGuestAttributes

        boolean containsGuestAttributes​(String key)
         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];

      • getGuestAttributesMap

        Map<String,​String> 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];

      • getGuestAttributesOrDefault

        String getGuestAttributesOrDefault​(String key,
                                   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];

      • getGuestAttributesOrThrow

        String getGuestAttributesOrThrow​(String key)
         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];

      • getMetadataCount

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

      • containsMetadata

        boolean containsMetadata​(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];

      • getMetadataMap

        Map<String,​String> 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];

      • getMetadataOrDefault

        String getMetadataOrDefault​(String key,
                            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];

      • getMetadataOrThrow

        String getMetadataOrThrow​(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];

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • getNicTypeValue

        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:
        The enum numeric value on the wire for nicType.

      • getNicType

        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:
        The nicType.

      • getReservedIpRange

        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:
        The reservedIpRange.

      • getReservedIpRangeBytes

        com.google.protobuf.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:
        The bytes for reservedIpRange.

      • hasBootImage

        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:
        Whether the bootImage field is set.

      • getBootImage

        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:
        The bootImage.

      • getBootImageOrBuilder

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