AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::Instance (v0.7.0)

Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::Instance.

The definition of a notebook instance.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accelerator_config

def accelerator_config() -> ::Google::Cloud::Notebooks::V1::Instance::AcceleratorConfig
Returns

#accelerator_config=

def accelerator_config=(value) -> ::Google::Cloud::Notebooks::V1::Instance::AcceleratorConfig
Parameter
Returns

#boot_disk_size_gb

def boot_disk_size_gb() -> ::Integer
Returns
  • (::Integer) — 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.

#boot_disk_size_gb=

def boot_disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#boot_disk_type

def boot_disk_type() -> ::Google::Cloud::Notebooks::V1::Instance::DiskType
Returns

#boot_disk_type=

def boot_disk_type=(value) -> ::Google::Cloud::Notebooks::V1::Instance::DiskType
Parameter
Returns

#can_ip_forward

def can_ip_forward() -> ::Boolean
Returns
  • (::Boolean) — Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

#can_ip_forward=

def can_ip_forward=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
Returns
  • (::Boolean) — Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward

#container_image

def container_image() -> ::Google::Cloud::Notebooks::V1::ContainerImage
Returns

#container_image=

def container_image=(value) -> ::Google::Cloud::Notebooks::V1::ContainerImage
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#creator

def creator() -> ::String
Returns
  • (::String) — Output only. Email address of entity that sent original CreateInstance request.

#custom_gpu_driver_path

def custom_gpu_driver_path() -> ::String
Returns
  • (::String) — Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

#custom_gpu_driver_path=

def custom_gpu_driver_path=(value) -> ::String
Parameter
  • value (::String) — Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
Returns
  • (::String) — Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

#data_disk_size_gb

def data_disk_size_gb() -> ::Integer
Returns
  • (::Integer) — 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.

#data_disk_size_gb=

def data_disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#data_disk_type

def data_disk_type() -> ::Google::Cloud::Notebooks::V1::Instance::DiskType
Returns

#data_disk_type=

def data_disk_type=(value) -> ::Google::Cloud::Notebooks::V1::Instance::DiskType
Parameter
Returns

#disk_encryption

def disk_encryption() -> ::Google::Cloud::Notebooks::V1::Instance::DiskEncryption
Returns

#disk_encryption=

def disk_encryption=(value) -> ::Google::Cloud::Notebooks::V1::Instance::DiskEncryption
Parameter
Returns

#disks

def disks() -> ::Array<::Google::Cloud::Notebooks::V1::Instance::Disk>
Returns

#install_gpu_driver

def install_gpu_driver() -> ::Boolean
Returns
  • (::Boolean) — 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.

#install_gpu_driver=

def install_gpu_driver=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#instance_owners

def instance_owners() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#instance_owners=

def instance_owners=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

Returns
  • (::Array<::String>) — 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.

#kms_key

def kms_key() -> ::String
Returns
  • (::String) — 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_key=

def kms_key=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this instance. These can be later modified by the setLabels method.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this instance. These can be later modified by the setLabels method.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this instance. These can be later modified by the setLabels method.

#machine_type

def machine_type() -> ::String
Returns

#machine_type=

def machine_type=(value) -> ::String
Parameter
Returns

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Custom metadata to apply to this instance.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Custom metadata to apply to this instance.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Custom metadata to apply to this instance.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

#network

def network() -> ::String
Returns
  • (::String) — The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}
Returns
  • (::String) — The name of the VPC that this instance is in. Format: projects/{project_id}/global/networks/{network_id}

#nic_type

def nic_type() -> ::Google::Cloud::Notebooks::V1::Instance::NicType
Returns

#nic_type=

def nic_type=(value) -> ::Google::Cloud::Notebooks::V1::Instance::NicType
Parameter
Returns

#no_proxy_access

def no_proxy_access() -> ::Boolean
Returns
  • (::Boolean) — If true, the notebook instance will not register with the proxy.

#no_proxy_access=

def no_proxy_access=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, the notebook instance will not register with the proxy.
Returns
  • (::Boolean) — If true, the notebook instance will not register with the proxy.

#no_public_ip

def no_public_ip() -> ::Boolean
Returns
  • (::Boolean) — If true, no public IP will be assigned to this instance.

#no_public_ip=

def no_public_ip=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, no public IP will be assigned to this instance.
Returns
  • (::Boolean) — If true, no public IP will be assigned to this instance.

#no_remove_data_disk

def no_remove_data_disk() -> ::Boolean
Returns
  • (::Boolean) — Input only. If true, the data disk will not be auto deleted when deleting the instance.

#no_remove_data_disk=

def no_remove_data_disk=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Input only. If true, the data disk will not be auto deleted when deleting the instance.
Returns
  • (::Boolean) — Input only. If true, the data disk will not be auto deleted when deleting the instance.

#post_startup_script

def post_startup_script() -> ::String
Returns
  • (::String) — 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).

#post_startup_script=

def post_startup_script=(value) -> ::String
Parameter
  • value (::String) — 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).
Returns
  • (::String) — 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).

#proxy_uri

def proxy_uri() -> ::String
Returns
  • (::String) — Output only. The proxy endpoint that is used to access the Jupyter notebook.

#reservation_affinity

def reservation_affinity() -> ::Google::Cloud::Notebooks::V1::ReservationAffinity
Returns

#reservation_affinity=

def reservation_affinity=(value) -> ::Google::Cloud::Notebooks::V1::ReservationAffinity
Parameter
Returns

#service_account

def service_account() -> ::String
Returns
  • (::String) — 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 is used.

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::String) — 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 is used.

Returns
  • (::String) — 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 is used.

#service_account_scopes

def service_account_scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    Optional. The URIs of service account scopes to be included in Compute Engine instances.

    If not specified, the following scopes 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

#service_account_scopes=

def service_account_scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    Optional. The URIs of service account scopes to be included in Compute Engine instances.

    If not specified, the following scopes 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
Returns
  • (::Array<::String>) —

    Optional. The URIs of service account scopes to be included in Compute Engine instances.

    If not specified, the following scopes 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

#shielded_instance_config

def shielded_instance_config() -> ::Google::Cloud::Notebooks::V1::Instance::ShieldedInstanceConfig
Returns

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Notebooks::V1::Instance::ShieldedInstanceConfig
Parameter
Returns

#state

def state() -> ::Google::Cloud::Notebooks::V1::Instance::State
Returns

#subnet

def subnet() -> ::String
Returns
  • (::String) — The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

#subnet=

def subnet=(value) -> ::String
Parameter
  • value (::String) — The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}
Returns
  • (::String) — The name of the subnet that this instance is in. Format: projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).
Returns
  • (::Array<::String>) — Optional. The Compute Engine tags to add to runtime (see Tagging instances).

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#upgrade_history

def upgrade_history() -> ::Array<::Google::Cloud::Notebooks::V1::Instance::UpgradeHistoryEntry>
Returns

#upgrade_history=

def upgrade_history=(value) -> ::Array<::Google::Cloud::Notebooks::V1::Instance::UpgradeHistoryEntry>
Parameter
Returns

#vm_image

def vm_image() -> ::Google::Cloud::Notebooks::V1::VmImage
Returns

#vm_image=

def vm_image=(value) -> ::Google::Cloud::Notebooks::V1::VmImage
Parameter
Returns