- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.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 \ V1Methods
__construct
Constructor.
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. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.
↳ machine_spec
↳ data_persistent_disk_spec
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
↳ service_account
string
Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. 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
NotebookIdleShutdownConfig
The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.
↳ euc_config
↳ create_time
↳ 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
↳ network_tags
↳ encryption_spec
↳ software_config
getName
The resource name of the NotebookRuntimeTemplate.
string
setName
The resource name of the NotebookRuntimeTemplate.
var
string
$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.
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.
var
string
$this
getDescription
The description of the NotebookRuntimeTemplate.
string
setDescription
The description of the NotebookRuntimeTemplate.
var
string
$this
getIsDefault
Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead.
The default template to use if not specified.
bool
setIsDefault
Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead.
The default template to use if not specified.
var
bool
$this
getMachineSpec
Optional. Immutable. The specification of a single machine for the template.
hasMachineSpec
clearMachineSpec
setMachineSpec
Optional. Immutable. The specification of a single machine for the template.
$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.
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.
$this
getNetworkSpec
Optional. Network spec.
hasNetworkSpec
clearNetworkSpec
setNetworkSpec
Optional. Network spec.
$this
getServiceAccount
Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity.
See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. 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.
string
setServiceAccount
Deprecated: This field is ignored and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity.
See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. 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.
var
string
$this
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
var
string
$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.
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.
$this
getIdleShutdownConfig
The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.
hasIdleShutdownConfig
clearIdleShutdownConfig
setIdleShutdownConfig
The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled.
$this
getEucConfig
EUC configuration of the NotebookRuntimeTemplate.
hasEucConfig
clearEucConfig
setEucConfig
EUC configuration of the NotebookRuntimeTemplate.
$this
getCreateTime
Output only. Timestamp when this NotebookRuntimeTemplate was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this NotebookRuntimeTemplate was created.
$this
getUpdateTime
Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.
$this
getNotebookRuntimeType
Optional. Immutable. The type of the notebook runtime template.
int
setNotebookRuntimeType
Optional. Immutable. The type of the notebook runtime template.
var
int
$this
getShieldedVmConfig
Optional. Immutable. Runtime Shielded VM spec.
hasShieldedVmConfig
clearShieldedVmConfig
setShieldedVmConfig
Optional. Immutable. Runtime Shielded VM spec.
$this
getNetworkTags
Optional. The Compute Engine tags to add to runtime (see Tagging instances ).
setNetworkTags
Optional. The Compute Engine tags to add to runtime (see Tagging instances ).
var
string[]
$this
getEncryptionSpec
Customer-managed encryption key spec for the notebook runtime.
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
Customer-managed encryption key spec for the notebook runtime.
$this
getSoftwareConfig
Optional. The notebook software configuration of the notebook runtime.
hasSoftwareConfig
clearSoftwareConfig
setSoftwareConfig
Optional. The notebook software configuration of the notebook runtime.
$this
