Package com.google.cloud.notebooks.v1

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
implements InstanceOrBuilder
     The definition of a notebook instance.
    Protobuf type google.cloud.notebooks.v1.Instance
    See Also:
    Serialized Form

    • Field Detail

      • CONTAINER_IMAGE_FIELD_NUMBER

        public static final int CONTAINER_IMAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_STARTUP_SCRIPT_FIELD_NUMBER

        public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INSTANCE_OWNERS_FIELD_NUMBER

        public static final int INSTANCE_OWNERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_SCOPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MACHINE_TYPE_FIELD_NUMBER

        public static final int MACHINE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACCELERATOR_CONFIG_FIELD_NUMBER

        public static final int ACCELERATOR_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INSTALL_GPU_DRIVER_FIELD_NUMBER

        public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER

        public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BOOT_DISK_TYPE_FIELD_NUMBER

        public static final int BOOT_DISK_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BOOT_DISK_SIZE_GB_FIELD_NUMBER

        public static final int BOOT_DISK_SIZE_GB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATA_DISK_TYPE_FIELD_NUMBER

        public static final int DATA_DISK_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATA_DISK_SIZE_GB_FIELD_NUMBER

        public static final int DATA_DISK_SIZE_GB_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NO_REMOVE_DATA_DISK_FIELD_NUMBER

        public static final int NO_REMOVE_DATA_DISK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISK_ENCRYPTION_FIELD_NUMBER

        public static final int DISK_ENCRYPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER

        public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NO_PUBLIC_IP_FIELD_NUMBER

        public static final int NO_PUBLIC_IP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NO_PROXY_ACCESS_FIELD_NUMBER

        public static final int NO_PROXY_ACCESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPGRADE_HISTORY_FIELD_NUMBER

        public static final int UPGRADE_HISTORY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESERVATION_AFFINITY_FIELD_NUMBER

        public static final int RESERVATION_AFFINITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CAN_IP_FORWARD_FIELD_NUMBER

        public static final int CAN_IP_FORWARD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The name of this notebook instance. Format:
 `projects/{project_id}/locations/{location}/instances/{instance_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The name of this notebook instance. Format:
 `projects/{project_id}/locations/{location}/instances/{instance_id}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • hasVmImage

        public boolean hasVmImage()
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 2;
        Specified by:
        hasVmImage in interface InstanceOrBuilder
        Returns:
        Whether the vmImage field is set.

      • getVmImage

        public VmImage getVmImage()
         Use a Compute Engine VM image to start the notebook instance.
        .google.cloud.notebooks.v1.VmImage vm_image = 2;
        Specified by:
        getVmImage in interface InstanceOrBuilder
        Returns:
        The vmImage.

      • hasContainerImage

        public boolean hasContainerImage()
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 3;
        Specified by:
        hasContainerImage in interface InstanceOrBuilder
        Returns:
        Whether the containerImage field is set.

      • getContainerImage

        public ContainerImage getContainerImage()
         Use a container image to start the notebook instance.
        .google.cloud.notebooks.v1.ContainerImage container_image = 3;
        Specified by:
        getContainerImage in interface InstanceOrBuilder
        Returns:
        The containerImage.

      • getPostStartupScript

        public String getPostStartupScript()
         Path to a Bash script that automatically runs after a notebook instance
 fully boots up. The path must be a URL or
 Cloud Storage path (`gs://path-to-file/file-name`).
        string post_startup_script = 4;
        Specified by:
        getPostStartupScript in interface InstanceOrBuilder
        Returns:
        The postStartupScript.

      • getPostStartupScriptBytes

        public com.google.protobuf.ByteString getPostStartupScriptBytes()
         Path to a Bash script that automatically runs after a notebook instance
 fully boots up. The path must be a URL or
 Cloud Storage path (`gs://path-to-file/file-name`).
        string post_startup_script = 4;
        Specified by:
        getPostStartupScriptBytes in interface InstanceOrBuilder
        Returns:
        The bytes for postStartupScript.

      • getProxyUri

        public String getProxyUri()
         Output only. The proxy endpoint that is used to access the Jupyter notebook.
        string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProxyUri in interface InstanceOrBuilder
        Returns:
        The proxyUri.

      • getProxyUriBytes

        public com.google.protobuf.ByteString getProxyUriBytes()
         Output only. The proxy endpoint that is used to access the Jupyter notebook.
        string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getProxyUriBytes in interface InstanceOrBuilder
        Returns:
        The bytes for proxyUri.

      • getInstanceOwnersList

        public com.google.protobuf.ProtocolStringList getInstanceOwnersList()
         Input only. The owner of this instance after creation. Format: `alias@example.com`

 Currently supports one owner only. If not specified, all of the service
 account users of your VM instance's service account can use
 the instance.
        repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getInstanceOwnersList in interface InstanceOrBuilder
        Returns:
        A list containing the instanceOwners.

      • getInstanceOwnersCount

        public int getInstanceOwnersCount()
         Input only. The owner of this instance after creation. Format: `alias@example.com`

 Currently supports one owner only. If not specified, all of the service
 account users of your VM instance's service account can use
 the instance.
        repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getInstanceOwnersCount in interface InstanceOrBuilder
        Returns:
        The count of instanceOwners.

      • getInstanceOwners

        public String getInstanceOwners​(int index)
         Input only. The owner of this instance after creation. Format: `alias@example.com`

 Currently supports one owner only. If not specified, all of the service
 account users of your VM instance's service account can use
 the instance.
        repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getInstanceOwners in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The instanceOwners at the given index.

      • getInstanceOwnersBytes

        public com.google.protobuf.ByteString getInstanceOwnersBytes​(int index)
         Input only. The owner of this instance after creation. Format: `alias@example.com`

 Currently supports one owner only. If not specified, all of the service
 account users of your VM instance's service account can use
 the instance.
        repeated string instance_owners = 6 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getInstanceOwnersBytes in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the instanceOwners at the given index.

      • getServiceAccount

        public String getServiceAccount()
         The service account on this instance, giving access to other Google
 Cloud services.
 You can use any service account within the same project, but you
 must have the service account user permission to use the instance.

 If not specified, the [Compute Engine default service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.
        string service_account = 7;
        Specified by:
        getServiceAccount in interface InstanceOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public com.google.protobuf.ByteString getServiceAccountBytes()
         The service account on this instance, giving access to other Google
 Cloud services.
 You can use any service account within the same project, but you
 must have the service account user permission to use the instance.

 If not specified, the [Compute Engine default service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.
        string service_account = 7;
        Specified by:
        getServiceAccountBytes in interface InstanceOrBuilder
        Returns:
        The bytes for serviceAccount.

      • getServiceAccountScopesList

        public com.google.protobuf.ProtocolStringList getServiceAccountScopesList()
         Optional. The URIs of service account scopes to be included in
 Compute Engine instances.

 If not specified, the following
 [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
 are defined:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/userinfo.email
 If not using default scopes, you need at least:
    https://www.googleapis.com/auth/compute
        repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getServiceAccountScopesList in interface InstanceOrBuilder
        Returns:
        A list containing the serviceAccountScopes.

      • getServiceAccountScopesCount

        public int getServiceAccountScopesCount()
         Optional. The URIs of service account scopes to be included in
 Compute Engine instances.

 If not specified, the following
 [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
 are defined:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/userinfo.email
 If not using default scopes, you need at least:
    https://www.googleapis.com/auth/compute
        repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getServiceAccountScopesCount in interface InstanceOrBuilder
        Returns:
        The count of serviceAccountScopes.

      • getServiceAccountScopes

        public String getServiceAccountScopes​(int index)
         Optional. The URIs of service account scopes to be included in
 Compute Engine instances.

 If not specified, the following
 [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
 are defined:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/userinfo.email
 If not using default scopes, you need at least:
    https://www.googleapis.com/auth/compute
        repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getServiceAccountScopes in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The serviceAccountScopes at the given index.

      • getServiceAccountScopesBytes

        public com.google.protobuf.ByteString getServiceAccountScopesBytes​(int index)
         Optional. The URIs of service account scopes to be included in
 Compute Engine instances.

 If not specified, the following
 [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam)
 are defined:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/userinfo.email
 If not using default scopes, you need at least:
    https://www.googleapis.com/auth/compute
        repeated string service_account_scopes = 31 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getServiceAccountScopesBytes in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the serviceAccountScopes at the given index.

      • getMachineType

        public String getMachineType()
         Required. The [Compute Engine machine
 type](https://cloud.google.com/compute/docs/machine-types) of this
 instance.
        string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMachineType in interface InstanceOrBuilder
        Returns:
        The machineType.

      • getMachineTypeBytes

        public com.google.protobuf.ByteString getMachineTypeBytes()
         Required. The [Compute Engine machine
 type](https://cloud.google.com/compute/docs/machine-types) of this
 instance.
        string machine_type = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMachineTypeBytes in interface InstanceOrBuilder
        Returns:
        The bytes for machineType.

      • hasAcceleratorConfig

        public boolean hasAcceleratorConfig()
         The hardware accelerator used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
        .google.cloud.notebooks.v1.Instance.AcceleratorConfig accelerator_config = 9;
        Specified by:
        hasAcceleratorConfig in interface InstanceOrBuilder
        Returns:
        Whether the acceleratorConfig field is set.

      • getAcceleratorConfig

        public Instance.AcceleratorConfig getAcceleratorConfig()
         The hardware accelerator used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
        .google.cloud.notebooks.v1.Instance.AcceleratorConfig accelerator_config = 9;
        Specified by:
        getAcceleratorConfig in interface InstanceOrBuilder
        Returns:
        The acceleratorConfig.

      • getAcceleratorConfigOrBuilder

        public Instance.AcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()
         The hardware accelerator used on this instance. If you use
 accelerators, make sure that your configuration has
 [enough vCPUs and memory to support the `machine_type` you have
 selected](https://cloud.google.com/compute/docs/gpus/#gpus-list).
        .google.cloud.notebooks.v1.Instance.AcceleratorConfig accelerator_config = 9;
        Specified by:
        getAcceleratorConfigOrBuilder in interface InstanceOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The state of this instance.
        .google.cloud.notebooks.v1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Instance.State getState()
         Output only. The state of this instance.
        .google.cloud.notebooks.v1.Instance.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface InstanceOrBuilder
        Returns:
        The state.

      • getInstallGpuDriver

        public boolean getInstallGpuDriver()
         Whether the end user authorizes Google Cloud to install GPU driver
 on this instance.
 If this field is empty or set to false, the GPU driver won't be installed.
 Only applicable to instances with GPUs.
        bool install_gpu_driver = 11;
        Specified by:
        getInstallGpuDriver in interface InstanceOrBuilder
        Returns:
        The installGpuDriver.

      • getCustomGpuDriverPath

        public String getCustomGpuDriverPath()
         Specify a custom Cloud Storage path where the GPU driver is stored.
 If not specified, we'll automatically choose from official GPU drivers.
        string custom_gpu_driver_path = 12;
        Specified by:
        getCustomGpuDriverPath in interface InstanceOrBuilder
        Returns:
        The customGpuDriverPath.

      • getCustomGpuDriverPathBytes

        public com.google.protobuf.ByteString getCustomGpuDriverPathBytes()
         Specify a custom Cloud Storage path where the GPU driver is stored.
 If not specified, we'll automatically choose from official GPU drivers.
        string custom_gpu_driver_path = 12;
        Specified by:
        getCustomGpuDriverPathBytes in interface InstanceOrBuilder
        Returns:
        The bytes for customGpuDriverPath.

      • getBootDiskTypeValue

        public int getBootDiskTypeValue()
         Input only. The type of the boot disk attached to this instance, defaults to
 standard persistent disk (`PD_STANDARD`).
        .google.cloud.notebooks.v1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getBootDiskTypeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for bootDiskType.

      • getBootDiskType

        public Instance.DiskType getBootDiskType()
         Input only. The type of the boot disk attached to this instance, defaults to
 standard persistent disk (`PD_STANDARD`).
        .google.cloud.notebooks.v1.Instance.DiskType boot_disk_type = 13 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getBootDiskType in interface InstanceOrBuilder
        Returns:
        The bootDiskType.

      • getBootDiskSizeGb

        public long getBootDiskSizeGb()
         Input only. The size of the boot disk in GB attached to this instance, up to a maximum
 of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not
 specified, this defaults to 100.
        int64 boot_disk_size_gb = 14 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getBootDiskSizeGb in interface InstanceOrBuilder
        Returns:
        The bootDiskSizeGb.

      • getDataDiskTypeValue

        public int getDataDiskTypeValue()
         Input only. The type of the data disk attached to this instance, defaults to
 standard persistent disk (`PD_STANDARD`).
        .google.cloud.notebooks.v1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getDataDiskTypeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for dataDiskType.

      • getDataDiskType

        public Instance.DiskType getDataDiskType()
         Input only. The type of the data disk attached to this instance, defaults to
 standard persistent disk (`PD_STANDARD`).
        .google.cloud.notebooks.v1.Instance.DiskType data_disk_type = 25 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getDataDiskType in interface InstanceOrBuilder
        Returns:
        The dataDiskType.

      • getDataDiskSizeGb

        public long getDataDiskSizeGb()
         Input only. The size of the data disk in GB attached to this instance, up to a maximum
 of 64000 GB (64 TB). You can choose the size of the data disk based on how
 big your notebooks and data are. If not specified, this defaults to 100.
        int64 data_disk_size_gb = 26 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getDataDiskSizeGb in interface InstanceOrBuilder
        Returns:
        The dataDiskSizeGb.

      • getNoRemoveDataDisk

        public boolean getNoRemoveDataDisk()
         Input only. If true, the data disk will not be auto deleted when deleting the instance.
        bool no_remove_data_disk = 27 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getNoRemoveDataDisk in interface InstanceOrBuilder
        Returns:
        The noRemoveDataDisk.

      • getDiskEncryptionValue

        public int getDiskEncryptionValue()
         Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
        .google.cloud.notebooks.v1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getDiskEncryptionValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for diskEncryption.

      • getDiskEncryption

        public Instance.DiskEncryption getDiskEncryption()
         Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
        .google.cloud.notebooks.v1.Instance.DiskEncryption disk_encryption = 15 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getDiskEncryption in interface InstanceOrBuilder
        Returns:
        The diskEncryption.

      • getKmsKey

        public String getKmsKey()
         Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption
 is CMEK.
 Format:
 `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`

 Learn more about [using your own encryption keys](/kms/docs/quickstart).
        string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getKmsKey in interface InstanceOrBuilder
        Returns:
        The kmsKey.

      • getKmsKeyBytes

        public com.google.protobuf.ByteString getKmsKeyBytes()
         Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption
 is CMEK.
 Format:
 `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`

 Learn more about [using your own encryption keys](/kms/docs/quickstart).
        string kms_key = 16 [(.google.api.field_behavior) = INPUT_ONLY];
        Specified by:
        getKmsKeyBytes in interface InstanceOrBuilder
        Returns:
        The bytes for kmsKey.

      • getDisksList

        public List<Instance.Disk> getDisksList()
         Output only. Attached disks to notebook instance.
        repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisksList in interface InstanceOrBuilder

      • getDisksOrBuilderList

        public List<? extends Instance.DiskOrBuilder> getDisksOrBuilderList()
         Output only. Attached disks to notebook instance.
        repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisksOrBuilderList in interface InstanceOrBuilder

      • getDisksCount

        public int getDisksCount()
         Output only. Attached disks to notebook instance.
        repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisksCount in interface InstanceOrBuilder

      • getDisks

        public Instance.Disk getDisks​(int index)
         Output only. Attached disks to notebook instance.
        repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisks in interface InstanceOrBuilder

      • getDisksOrBuilder

        public Instance.DiskOrBuilder getDisksOrBuilder​(int index)
         Output only. Attached disks to notebook instance.
        repeated .google.cloud.notebooks.v1.Instance.Disk disks = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDisksOrBuilder in interface InstanceOrBuilder

      • hasShieldedInstanceConfig

        public boolean hasShieldedInstanceConfig()
         Optional. Shielded VM configuration.
 [Images using supported Shielded VM
 features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
        .google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasShieldedInstanceConfig in interface InstanceOrBuilder
        Returns:
        Whether the shieldedInstanceConfig field is set.

      • getShieldedInstanceConfig

        public Instance.ShieldedInstanceConfig getShieldedInstanceConfig()
         Optional. Shielded VM configuration.
 [Images using supported Shielded VM
 features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
        .google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getShieldedInstanceConfig in interface InstanceOrBuilder
        Returns:
        The shieldedInstanceConfig.

      • getShieldedInstanceConfigOrBuilder

        public Instance.ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
         Optional. Shielded VM configuration.
 [Images using supported Shielded VM
 features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).
        .google.cloud.notebooks.v1.Instance.ShieldedInstanceConfig shielded_instance_config = 30 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getShieldedInstanceConfigOrBuilder in interface InstanceOrBuilder

      • getNoPublicIp

        public boolean getNoPublicIp()
         If true, no public IP will be assigned to this instance.
        bool no_public_ip = 17;
        Specified by:
        getNoPublicIp in interface InstanceOrBuilder
        Returns:
        The noPublicIp.

      • getNoProxyAccess

        public boolean getNoProxyAccess()
         If true, the notebook instance will not register with the proxy.
        bool no_proxy_access = 18;
        Specified by:
        getNoProxyAccess in interface InstanceOrBuilder
        Returns:
        The noProxyAccess.

      • getNetwork

        public String getNetwork()
         The name of the VPC that this instance is in.
 Format:
 `projects/{project_id}/global/networks/{network_id}`
        string network = 19;
        Specified by:
        getNetwork in interface InstanceOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         The name of the VPC that this instance is in.
 Format:
 `projects/{project_id}/global/networks/{network_id}`
        string network = 19;
        Specified by:
        getNetworkBytes in interface InstanceOrBuilder
        Returns:
        The bytes for network.

      • getSubnet

        public String getSubnet()
         The name of the subnet that this instance is in.
 Format:
 `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
        string subnet = 20;
        Specified by:
        getSubnet in interface InstanceOrBuilder
        Returns:
        The subnet.

      • getSubnetBytes

        public com.google.protobuf.ByteString getSubnetBytes()
         The name of the subnet that this instance is in.
 Format:
 `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`
        string subnet = 20;
        Specified by:
        getSubnetBytes in interface InstanceOrBuilder
        Returns:
        The bytes for subnet.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: InstanceOrBuilder
         Labels to apply to this instance.
 These can be later modified by the setLabels method.
        map<string, string> labels = 21;
        Specified by:
        getLabelsCount in interface InstanceOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Labels to apply to this instance.
 These can be later modified by the setLabels method.
        map<string, string> labels = 21;
        Specified by:
        containsLabels in interface InstanceOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Labels to apply to this instance.
 These can be later modified by the setLabels method.
        map<string, string> labels = 21;
        Specified by:
        getLabelsMap in interface InstanceOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Labels to apply to this instance.
 These can be later modified by the setLabels method.
        map<string, string> labels = 21;
        Specified by:
        getLabelsOrDefault in interface InstanceOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Labels to apply to this instance.
 These can be later modified by the setLabels method.
        map<string, string> labels = 21;
        Specified by:
        getLabelsOrThrow in interface InstanceOrBuilder

      • containsMetadata

        public boolean containsMetadata​(String key)
         Custom metadata to apply to this instance.
        map<string, string> metadata = 22;
        Specified by:
        containsMetadata in interface InstanceOrBuilder

      • getTagsList

        public com.google.protobuf.ProtocolStringList 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 = 32 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTagsList in interface InstanceOrBuilder
        Returns:
        A list containing the tags.

      • getTagsCount

        public 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 = 32 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTagsCount in interface InstanceOrBuilder
        Returns:
        The count of tags.

      • getTags

        public 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 = 32 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTags in interface InstanceOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The tags at the given index.

      • getTagsBytes

        public 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 = 32 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTagsBytes in interface InstanceOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tags at the given index.

      • getUpgradeHistoryCount

        public int getUpgradeHistoryCount()
         The upgrade history of this instance.
        repeated .google.cloud.notebooks.v1.Instance.UpgradeHistoryEntry upgrade_history = 29;
        Specified by:
        getUpgradeHistoryCount in interface InstanceOrBuilder

      • 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.Instance.NicType nic_type = 33 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNicTypeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for nicType.

      • getNicType

        public Instance.NicType getNicType()
         Optional. The type of vNIC to be used on this interface. This may be gVNIC or
 VirtioNet.
        .google.cloud.notebooks.v1.Instance.NicType nic_type = 33 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNicType in interface InstanceOrBuilder
        Returns:
        The nicType.

      • hasReservationAffinity

        public boolean hasReservationAffinity()
         Optional. The optional reservation affinity. Setting this field will apply
 the specified [Zonal Compute
 Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
 to this notebook instance.
        .google.cloud.notebooks.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasReservationAffinity in interface InstanceOrBuilder
        Returns:
        Whether the reservationAffinity field is set.

      • getReservationAffinity

        public ReservationAffinity getReservationAffinity()
         Optional. The optional reservation affinity. Setting this field will apply
 the specified [Zonal Compute
 Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
 to this notebook instance.
        .google.cloud.notebooks.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservationAffinity in interface InstanceOrBuilder
        Returns:
        The reservationAffinity.

      • getReservationAffinityOrBuilder

        public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()
         Optional. The optional reservation affinity. Setting this field will apply
 the specified [Zonal Compute
 Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources)
 to this notebook instance.
        .google.cloud.notebooks.v1.ReservationAffinity reservation_affinity = 34 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReservationAffinityOrBuilder in interface InstanceOrBuilder

      • getCreator

        public String getCreator()
         Output only. Email address of entity that sent original CreateInstance request.
        string creator = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreator in interface InstanceOrBuilder
        Returns:
        The creator.

      • getCreatorBytes

        public com.google.protobuf.ByteString getCreatorBytes()
         Output only. Email address of entity that sent original CreateInstance request.
        string creator = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreatorBytes in interface InstanceOrBuilder
        Returns:
        The bytes for creator.

      • getCanIpForward

        public boolean getCanIpForward()
         Optional. Flag to enable ip forwarding or not, default false/off.
 https://cloud.google.com/vpc/docs/using-routes#canipforward
        bool can_ip_forward = 39 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCanIpForward in interface InstanceOrBuilder
        Returns:
        The canIpForward.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface InstanceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface InstanceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Instance creation time.
        .google.protobuf.Timestamp create_time = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface InstanceOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface InstanceOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface InstanceOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Instance update time.
        .google.protobuf.Timestamp update_time = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface InstanceOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Instance.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Instance.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Instance.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Instance> parser()

      • getParserForType

        public com.google.protobuf.Parser<Instance> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder