Google Cloud Ai Platform V1 Client - Class NotebookRuntime (0.38.0)

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

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Output only. The resource name of the NotebookRuntime.
↳ runtime_user string

Required. The user email of the NotebookRuntime.
↳ notebook_runtime_template_ref Google\Cloud\AIPlatform\V1\NotebookRuntimeTemplateRef

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
↳ proxy_uri string

Output only. The proxy endpoint used to access the NotebookRuntime.
↳ create_time Google\Protobuf\Timestamp

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

Output only. Timestamp when this NotebookRuntime was most recently updated.
↳ health_state int

Output only. The health state of the NotebookRuntime.
↳ display_name string

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

The description of the NotebookRuntime.
↳ service_account string

Output only. The service account that the NotebookRuntime workload runs as.
↳ runtime_state int

Output only. The runtime (instance) state of the NotebookRuntime.
↳ is_upgradable bool

Output only. Whether NotebookRuntime is upgradable.
↳ labels array|Google\Protobuf\Internal\MapField

The labels with user-defined metadata to organize your NotebookRuntime. 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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
↳ expiration_time Google\Protobuf\Timestamp

Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
↳ version string

Output only. The VM os image version of NotebookRuntime.
↳ notebook_runtime_type int

Output only. The type of the notebook runtime.
↳ network_tags array

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

getName

Output only. The resource name of the NotebookRuntime.

Returns
Type Description
string

setName

Output only. The resource name of the NotebookRuntime.

Parameter
Name Description
var string
Returns
Type Description
$this

getRuntimeUser

Required. The user email of the NotebookRuntime.

Returns
Type Description
string

setRuntimeUser

Required. The user email of the NotebookRuntime.

Parameter
Name Description
var string
Returns
Type Description
$this

getNotebookRuntimeTemplateRef

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

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

hasNotebookRuntimeTemplateRef

clearNotebookRuntimeTemplateRef

setNotebookRuntimeTemplateRef

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

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

getProxyUri

Output only. The proxy endpoint used to access the NotebookRuntime.

Returns
Type Description
string

setProxyUri

Output only. The proxy endpoint used to access the NotebookRuntime.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this NotebookRuntime was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this NotebookRuntime was created.

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

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

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

getHealthState

Output only. The health state of the NotebookRuntime.

Returns
Type Description
int

setHealthState

Output only. The health state of the NotebookRuntime.

Parameter
Name Description
var int
Returns
Type Description
$this

getDisplayName

Required. The display name of the NotebookRuntime.

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 NotebookRuntime.

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 NotebookRuntime.

Returns
Type Description
string

setDescription

The description of the NotebookRuntime.

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceAccount

Output only. The service account that the NotebookRuntime workload runs as.

Returns
Type Description
string

setServiceAccount

Output only. The service account that the NotebookRuntime workload runs as.

Parameter
Name Description
var string
Returns
Type Description
$this

getRuntimeState

Output only. The runtime (instance) state of the NotebookRuntime.

Returns
Type Description
int

setRuntimeState

Output only. The runtime (instance) state of the NotebookRuntime.

Parameter
Name Description
var int
Returns
Type Description
$this

getIsUpgradable

Output only. Whether NotebookRuntime is upgradable.

Returns
Type Description
bool

setIsUpgradable

Output only. Whether NotebookRuntime is upgradable.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLabels

The labels with user-defined metadata to organize your NotebookRuntime.

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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime:

  • "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id.
  • "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

The labels with user-defined metadata to organize your NotebookRuntime.

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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime:

  • "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id.
  • "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getExpirationTime

Output only. Timestamp when this NotebookRuntime will be expired:

  1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.

  2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasExpirationTime

clearExpirationTime

setExpirationTime

Output only. Timestamp when this NotebookRuntime will be expired:

  1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.

  2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

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

getVersion

Output only. The VM os image version of NotebookRuntime.

Returns
Type Description
string

setVersion

Output only. The VM os image version of NotebookRuntime.

Parameter
Name Description
var string
Returns
Type Description
$this

getNotebookRuntimeType

Output only. The type of the notebook runtime.

Returns
Type Description
int

setNotebookRuntimeType

Output only. The type of the notebook runtime.

Parameter
Name Description
var int
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