Google Cloud Notebooks V2 Client - Class GceSetup (0.6.2)

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

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

Generated from protobuf message google.cloud.notebooks.v2.GceSetup

Namespace

Google \ Cloud \ Notebooks \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ machine_type`	`string` Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource
`↳ accelerator_configs`	`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.
`↳ service_accounts`	`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.
`↳ vm_image`	`Google\Cloud\Notebooks\V2\VmImage` Optional. Use a Compute Engine VM image to start the notebook instance.
`↳ container_image`	`Google\Cloud\Notebooks\V2\ContainerImage` Optional. Use a container image to start the notebook instance.
`↳ boot_disk`	`Google\Cloud\Notebooks\V2\BootDisk` Optional. The boot disk for the VM.
`↳ data_disks`	`array<Google\Cloud\Notebooks\V2\DataDisk>` Optional. Data disks attached to the VM instance. Currently supports only one data disk.
`↳ shielded_instance_config`	`Google\Cloud\Notebooks\V2\ShieldedInstanceConfig` Optional. Shielded VM configuration. Images using supported Shielded VM features.
`↳ network_interfaces`	`array<Google\Cloud\Notebooks\V2\NetworkInterface>` Optional. The network interfaces for the VM. Supports only one interface.
`↳ disable_public_ip`	`bool` Optional. If true, no external IP will be assigned to this VM instance.
`↳ tags`	`array` Optional. The Compute Engine tags to add to runtime (see Tagging instances).
`↳ metadata`	`array\|Google\Protobuf\Internal\MapField` Optional. Custom metadata to apply to this instance.
`↳ enable_ip_forwarding`	`bool` Optional. Flag to enable ip forwarding or not, default false/off. https://cloud.google.com/vpc/docs/using-routes#canipforward
`↳ gpu_driver_config`	`Google\Cloud\Notebooks\V2\GPUDriverConfig` Optional. Configuration for GPU drivers.

getMachineType

Optional. The machine type of the VM instance.

https://cloud.google.com/compute/docs/machine-resource

Returns
Type	Description
`string`

setMachineType

Optional. The machine type of the VM instance.

https://cloud.google.com/compute/docs/machine-resource

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAcceleratorConfigs

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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAcceleratorConfigs

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.

Parameter
Name	Description
`var`	`array<Google\Cloud\Notebooks\V2\AcceleratorConfig>`

Returns
Type	Description
`$this`

getServiceAccounts

Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setServiceAccounts

Optional. The service account that serves as an identity for the VM instance. Currently supports only one service account.

Parameter
Name	Description
`var`	`array<Google\Cloud\Notebooks\V2\ServiceAccount>`

Returns
Type	Description
`$this`

getVmImage

Optional. Use a Compute Engine VM image to start the notebook instance.

Returns
Type	Description
`Google\Cloud\Notebooks\V2\VmImage\|null`

hasVmImage

setVmImage

Optional. Use a Compute Engine VM image to start the notebook instance.

Parameter
Name	Description
`var`	`Google\Cloud\Notebooks\V2\VmImage`

Returns
Type	Description
`$this`

getContainerImage

Optional. Use a container image to start the notebook instance.

Returns
Type	Description
`Google\Cloud\Notebooks\V2\ContainerImage\|null`

hasContainerImage

setContainerImage

Optional. Use a container image to start the notebook instance.

Parameter
Name	Description
`var`	`Google\Cloud\Notebooks\V2\ContainerImage`

Returns
Type	Description
`$this`

getBootDisk

Optional. The boot disk for the VM.

Returns
Type	Description
`Google\Cloud\Notebooks\V2\BootDisk\|null`

hasBootDisk

clearBootDisk

setBootDisk

Optional. The boot disk for the VM.

Parameter
Name	Description
`var`	`Google\Cloud\Notebooks\V2\BootDisk`

Returns
Type	Description
`$this`

getDataDisks

Optional. Data disks attached to the VM instance.

Currently supports only one data disk.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDataDisks

Optional. Data disks attached to the VM instance.

Currently supports only one data disk.

Parameter
Name	Description
`var`	`array<Google\Cloud\Notebooks\V2\DataDisk>`

Returns
Type	Description
`$this`

getShieldedInstanceConfig

Optional. Shielded VM configuration.

Images using supported Shielded VM features.

Returns
Type	Description
`Google\Cloud\Notebooks\V2\ShieldedInstanceConfig\|null`

hasShieldedInstanceConfig

clearShieldedInstanceConfig

setShieldedInstanceConfig

Optional. Shielded VM configuration.

Images using supported Shielded VM features.

Parameter
Name	Description
`var`	`Google\Cloud\Notebooks\V2\ShieldedInstanceConfig`

Returns
Type	Description
`$this`

getNetworkInterfaces

Optional. The network interfaces for the VM.

Supports only one interface.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setNetworkInterfaces

Optional. The network interfaces for the VM.

Supports only one interface.

Parameter
Name	Description
`var`	`array<Google\Cloud\Notebooks\V2\NetworkInterface>`

Returns
Type	Description
`$this`

getDisablePublicIp

Optional. If true, no external IP will be assigned to this VM instance.

Returns
Type	Description
`bool`

setDisablePublicIp

Optional. If true, no external IP will be assigned to this VM instance.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getTags

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTags

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getMetadata

Optional. Custom metadata to apply to this instance.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setMetadata

Optional. Custom metadata to apply to this instance.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEnableIpForwarding

Optional. Flag to enable ip forwarding or not, default false/off.

https://cloud.google.com/vpc/docs/using-routes#canipforward

Returns
Type	Description
`bool`

setEnableIpForwarding

Optional. Flag to enable ip forwarding or not, default false/off.

https://cloud.google.com/vpc/docs/using-routes#canipforward

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getGpuDriverConfig

Optional. Configuration for GPU drivers.

Returns
Type	Description
`Google\Cloud\Notebooks\V2\GPUDriverConfig\|null`

hasGpuDriverConfig

clearGpuDriverConfig

setGpuDriverConfig

Optional. Configuration for GPU drivers.

Parameter
Name	Description
`var`	`Google\Cloud\Notebooks\V2\GPUDriverConfig`

Returns
Type	Description
`$this`

getImage

Returns
Type	Description
`string`