Notebooks V2 API - Class Google::Cloud::Notebooks::V2::GceSetup (v0.5.0)

Reference documentation and code samples for the Notebooks V2 API class Google::Cloud::Notebooks::V2::GceSetup.

The definition of how to configure a VM instance outside of Resources and Identity.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#accelerator_configs

def accelerator_configs() -> ::Array<::Google::Cloud::Notebooks::V2::AcceleratorConfig>

Returns

(::Array<::Google::Cloud::Notebooks::V2::AcceleratorConfig>) — Optional. The hardware accelerators 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. Currently supports only one accelerator configuration.

#accelerator_configs=

def accelerator_configs=(value) -> ::Array<::Google::Cloud::Notebooks::V2::AcceleratorConfig>

Parameter

value (::Array<::Google::Cloud::Notebooks::V2::AcceleratorConfig>) — Optional. The hardware accelerators 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. Currently supports only one accelerator configuration.

Returns

(::Array<::Google::Cloud::Notebooks::V2::AcceleratorConfig>) — Optional. The hardware accelerators 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. Currently supports only one accelerator configuration.

#boot_disk

def boot_disk() -> ::Google::Cloud::Notebooks::V2::BootDisk

Returns

(::Google::Cloud::Notebooks::V2::BootDisk) — Optional. The boot disk for the VM.

#boot_disk=

def boot_disk=(value) -> ::Google::Cloud::Notebooks::V2::BootDisk

Parameter

value (::Google::Cloud::Notebooks::V2::BootDisk) — Optional. The boot disk for the VM.

Returns

(::Google::Cloud::Notebooks::V2::BootDisk) — Optional. The boot disk for the VM.

#container_image

def container_image() -> ::Google::Cloud::Notebooks::V2::ContainerImage

Returns

(::Google::Cloud::Notebooks::V2::ContainerImage) — Optional. Use a container image to start the notebook instance.

#container_image=

def container_image=(value) -> ::Google::Cloud::Notebooks::V2::ContainerImage

Parameter

value (::Google::Cloud::Notebooks::V2::ContainerImage) — Optional. Use a container image to start the notebook instance.

Returns

(::Google::Cloud::Notebooks::V2::ContainerImage) — Optional. Use a container image to start the notebook instance.

#data_disks

def data_disks() -> ::Array<::Google::Cloud::Notebooks::V2::DataDisk>

Returns

(::Array<::Google::Cloud::Notebooks::V2::DataDisk>) — Optional. Data disks attached to the VM instance. Currently supports only one data disk.

#data_disks=

def data_disks=(value) -> ::Array<::Google::Cloud::Notebooks::V2::DataDisk>

Parameter

value (::Array<::Google::Cloud::Notebooks::V2::DataDisk>) — Optional. Data disks attached to the VM instance. Currently supports only one data disk.

Returns

(::Array<::Google::Cloud::Notebooks::V2::DataDisk>) — Optional. Data disks attached to the VM instance. Currently supports only one data disk.

#disable_public_ip

def disable_public_ip() -> ::Boolean

Returns

(::Boolean) — Optional. If true, no external IP will be assigned to this VM instance.

#disable_public_ip=

def disable_public_ip=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. If true, no external IP will be assigned to this VM instance.

Returns

(::Boolean) — Optional. If true, no external IP will be assigned to this VM instance.

#enable_ip_forwarding

def enable_ip_forwarding() -> ::Boolean

Returns

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

#enable_ip_forwarding=

def enable_ip_forwarding=(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

#gpu_driver_config

def gpu_driver_config() -> ::Google::Cloud::Notebooks::V2::GPUDriverConfig

Returns

(::Google::Cloud::Notebooks::V2::GPUDriverConfig) — Optional. Configuration for GPU drivers.

#gpu_driver_config=

def gpu_driver_config=(value) -> ::Google::Cloud::Notebooks::V2::GPUDriverConfig

Parameter

value (::Google::Cloud::Notebooks::V2::GPUDriverConfig) — Optional. Configuration for GPU drivers.

Returns

(::Google::Cloud::Notebooks::V2::GPUDriverConfig) — Optional. Configuration for GPU drivers.

#machine_type

def machine_type() -> ::String

Returns

(::String) — Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource

#machine_type=

def machine_type=(value) -> ::String

Parameter

value (::String) — Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource

Returns

(::String) — Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Custom metadata to apply to this instance.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Custom metadata to apply to this instance.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Custom metadata to apply to this instance.

#network_interfaces

def network_interfaces() -> ::Array<::Google::Cloud::Notebooks::V2::NetworkInterface>

Returns

(::Array<::Google::Cloud::Notebooks::V2::NetworkInterface>) — Optional. The network interfaces for the VM. Supports only one interface.

#network_interfaces=

def network_interfaces=(value) -> ::Array<::Google::Cloud::Notebooks::V2::NetworkInterface>

Parameter

value (::Array<::Google::Cloud::Notebooks::V2::NetworkInterface>) — Optional. The network interfaces for the VM. Supports only one interface.

Returns

(::Array<::Google::Cloud::Notebooks::V2::NetworkInterface>) — Optional. The network interfaces for the VM. Supports only one interface.

#service_accounts

def service_accounts() -> ::Array<::Google::Cloud::Notebooks::V2::ServiceAccount>

Returns

(::Array<::Google::Cloud::Notebooks::V2::ServiceAccount>) — Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.

#service_accounts=

def service_accounts=(value) -> ::Array<::Google::Cloud::Notebooks::V2::ServiceAccount>

Parameter

value (::Array<::Google::Cloud::Notebooks::V2::ServiceAccount>) — Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.

Returns

(::Array<::Google::Cloud::Notebooks::V2::ServiceAccount>) — Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.

#shielded_instance_config

def shielded_instance_config() -> ::Google::Cloud::Notebooks::V2::ShieldedInstanceConfig

Returns

(::Google::Cloud::Notebooks::V2::ShieldedInstanceConfig) — Optional. Shielded VM configuration. Images using supported Shielded VM features.

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Notebooks::V2::ShieldedInstanceConfig

Parameter

value (::Google::Cloud::Notebooks::V2::ShieldedInstanceConfig) — Optional. Shielded VM configuration. Images using supported Shielded VM features.

Returns

(::Google::Cloud::Notebooks::V2::ShieldedInstanceConfig) — Optional. Shielded VM configuration. Images using supported Shielded VM features.

#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).

#vm_image

def vm_image() -> ::Google::Cloud::Notebooks::V2::VmImage

Returns

(::Google::Cloud::Notebooks::V2::VmImage) — Optional. Use a Compute Engine VM image to start the notebook instance.

#vm_image=

def vm_image=(value) -> ::Google::Cloud::Notebooks::V2::VmImage

Parameter

value (::Google::Cloud::Notebooks::V2::VmImage) — Optional. Use a Compute Engine VM image to start the notebook instance.

Returns

(::Google::Cloud::Notebooks::V2::VmImage) — Optional. Use a Compute Engine VM image to start the notebook instance.