Google Cloud Ai Platform V1 Client - Class NotebookRuntimeTemplate (1.8.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class NotebookRuntimeTemplate.

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc.

Multiple runtimes can be created from a runtime template.

Generated from protobuf message google.cloud.aiplatform.v1.NotebookRuntimeTemplate

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The resource name of the NotebookRuntimeTemplate.
↳ display_name string

Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters.
↳ description string

The description of the NotebookRuntimeTemplate.
↳ is_default bool

Output only. The default template to use if not specified.
↳ machine_spec Google\Cloud\AIPlatform\V1\MachineSpec

Optional. Immutable. The specification of a single machine for the template.
↳ data_persistent_disk_spec Google\Cloud\AIPlatform\V1\PersistentDiskSpec

Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.
↳ network_spec Google\Cloud\AIPlatform\V1\NetworkSpec

Optional. Network spec.
↳ service_account string

The service account that the runtime workload runs as. 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.
↳ etag string

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
↳ labels array|Google\Protobuf\Internal\MapField

The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
↳ idle_shutdown_config Google\Cloud\AIPlatform\V1\NotebookIdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.
↳ euc_config Google\Cloud\AIPlatform\V1\NotebookEucConfig

EUC configuration of the NotebookRuntimeTemplate.
↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when this NotebookRuntimeTemplate was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.
↳ notebook_runtime_type int

Optional. Immutable. The type of the notebook runtime template.
↳ shielded_vm_config Google\Cloud\AIPlatform\V1\ShieldedVmConfig

Optional. Immutable. Runtime Shielded VM spec.
↳ network_tags array

Optional. The Compute Engine tags to add to runtime (see Tagging instances).
↳ encryption_spec Google\Cloud\AIPlatform\V1\EncryptionSpec

Customer-managed encryption key spec for the notebook runtime.

getName

The resource name of the NotebookRuntimeTemplate.

Returns
Type Description
string

setName

The resource name of the NotebookRuntimeTemplate.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the NotebookRuntimeTemplate.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns
Type Description
string

setDisplayName

Required. The display name of the NotebookRuntimeTemplate.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

The description of the NotebookRuntimeTemplate.

Returns
Type Description
string

setDescription

The description of the NotebookRuntimeTemplate.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsDefault

Output only. The default template to use if not specified.

Returns
Type Description
bool

setIsDefault

Output only. The default template to use if not specified.

Parameter
Name Description
var bool
Returns
Type Description
$this

getMachineSpec

Optional. Immutable. The specification of a single machine for the template.

Returns
Type Description
Google\Cloud\AIPlatform\V1\MachineSpec|null

hasMachineSpec

clearMachineSpec

setMachineSpec

Optional. Immutable. The specification of a single machine for the template.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\MachineSpec
Returns
Type Description
$this

getDataPersistentDiskSpec

Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PersistentDiskSpec|null

hasDataPersistentDiskSpec

clearDataPersistentDiskSpec

setDataPersistentDiskSpec

Optional. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the runtime as data disk storage.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PersistentDiskSpec
Returns
Type Description
$this

getNetworkSpec

Optional. Network spec.

Returns
Type Description
Google\Cloud\AIPlatform\V1\NetworkSpec|null

hasNetworkSpec

clearNetworkSpec

setNetworkSpec

Optional. Network spec.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\NetworkSpec
Returns
Type Description
$this

getServiceAccount

The service account that the runtime workload runs as.

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
Type Description
string

setServiceAccount

The service account that the runtime workload runs as.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
Type Description
string

setEtag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

The labels with user-defined metadata to organize the NotebookRuntimeTemplates.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

The labels with user-defined metadata to organize the NotebookRuntimeTemplates.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getIdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

Returns
Type Description
Google\Cloud\AIPlatform\V1\NotebookIdleShutdownConfig|null

hasIdleShutdownConfig

clearIdleShutdownConfig

setIdleShutdownConfig

The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\NotebookIdleShutdownConfig
Returns
Type Description
$this

getEucConfig

EUC configuration of the NotebookRuntimeTemplate.

Returns
Type Description
Google\Cloud\AIPlatform\V1\NotebookEucConfig|null

hasEucConfig

clearEucConfig

setEucConfig

EUC configuration of the NotebookRuntimeTemplate.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\NotebookEucConfig
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this NotebookRuntimeTemplate was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this NotebookRuntimeTemplate was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getNotebookRuntimeType

Optional. Immutable. The type of the notebook runtime template.

Returns
Type Description
int

setNotebookRuntimeType

Optional. Immutable. The type of the notebook runtime template.

Parameter
Name Description
var int
Returns
Type Description
$this

getShieldedVmConfig

Optional. Immutable. Runtime Shielded VM spec.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ShieldedVmConfig|null

hasShieldedVmConfig

clearShieldedVmConfig

setShieldedVmConfig

Optional. Immutable. Runtime Shielded VM spec.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ShieldedVmConfig
Returns
Type Description
$this

getNetworkTags

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setNetworkTags

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEncryptionSpec

Customer-managed encryption key spec for the notebook runtime.

Returns
Type Description
Google\Cloud\AIPlatform\V1\EncryptionSpec|null

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

Customer-managed encryption key spec for the notebook runtime.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\EncryptionSpec
Returns
Type Description
$this