com.google.cloud.aiplatform.v1beta1

Interface NotebookRuntimeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NotebookRuntime, NotebookRuntime.Builder

public interface NotebookRuntimeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize your NotebookRuntime.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() The description of the NotebookRuntime.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the NotebookRuntime.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
EncryptionSpec	getEncryptionSpec() Output only.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Output only.
com.google.protobuf.Timestamp	getExpirationTime() Output only.
com.google.protobuf.TimestampOrBuilder	getExpirationTimeOrBuilder() Output only.
NotebookRuntime.HealthState	getHealthState() Output only.
int	getHealthStateValue() Output only.
NotebookIdleShutdownConfig	getIdleShutdownConfig() Output only.
NotebookIdleShutdownConfigOrBuilder	getIdleShutdownConfigOrBuilder() Output only.
boolean	getIsUpgradable() Output only.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize your NotebookRuntime.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize your NotebookRuntime.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize your NotebookRuntime.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize your NotebookRuntime.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getNetworkTags(int index) Optional.
com.google.protobuf.ByteString	getNetworkTagsBytes(int index) Optional.
int	getNetworkTagsCount() Optional.
List<String>	getNetworkTagsList() Optional.
NotebookRuntimeTemplateRef	getNotebookRuntimeTemplateRef() Output only.
NotebookRuntimeTemplateRefOrBuilder	getNotebookRuntimeTemplateRefOrBuilder() Output only.
NotebookRuntimeType	getNotebookRuntimeType() Output only.
int	getNotebookRuntimeTypeValue() Output only.
String	getProxyUri() Output only.
com.google.protobuf.ByteString	getProxyUriBytes() Output only.
NotebookRuntime.RuntimeState	getRuntimeState() Output only.
int	getRuntimeStateValue() Output only.
String	getRuntimeUser() Required.
com.google.protobuf.ByteString	getRuntimeUserBytes() Required.
boolean	getSatisfiesPzi() Output only.
boolean	getSatisfiesPzs() Output only.
String	getServiceAccount() Output only.
com.google.protobuf.ByteString	getServiceAccountBytes() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
String	getVersion() Output only.
com.google.protobuf.ByteString	getVersionBytes() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionSpec() Output only.
boolean	hasExpirationTime() Output only.
boolean	hasIdleShutdownConfig() Output only.
boolean	hasNotebookRuntimeTemplateRef() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. The resource name of the NotebookRuntime.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. The resource name of the NotebookRuntime.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getRuntimeUser

String getRuntimeUser()

 Required. The user email of the NotebookRuntime.
 

string runtime_user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The runtimeUser.

getRuntimeUserBytes

com.google.protobuf.ByteString getRuntimeUserBytes()

 Required. The user email of the NotebookRuntime.
 

string runtime_user = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for runtimeUser.

hasNotebookRuntimeTemplateRef

boolean hasNotebookRuntimeTemplateRef()

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

.google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the notebookRuntimeTemplateRef field is set.

getNotebookRuntimeTemplateRef

NotebookRuntimeTemplateRef getNotebookRuntimeTemplateRef()

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

.google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The notebookRuntimeTemplateRef.

getNotebookRuntimeTemplateRefOrBuilder

NotebookRuntimeTemplateRefOrBuilder getNotebookRuntimeTemplateRefOrBuilder()

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

.google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

getProxyUri

String getProxyUri()

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

string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The proxyUri.

getProxyUriBytes

com.google.protobuf.ByteString getProxyUriBytes()

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

string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for proxyUri.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this NotebookRuntime was created.
 

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this NotebookRuntime was created.
 

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this NotebookRuntime was created.
 

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

getHealthStateValue

int getHealthStateValue()

 Output only. The health state of the NotebookRuntime.
 

.google.cloud.aiplatform.v1beta1.NotebookRuntime.HealthState health_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for healthState.

getHealthState

NotebookRuntime.HealthState getHealthState()

 Output only. The health state of the NotebookRuntime.
 

.google.cloud.aiplatform.v1beta1.NotebookRuntime.HealthState health_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The healthState.

getDisplayName

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

string display_name = 10 [(.google.api.field_behavior) = REQUIRED];

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 10 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for displayName.

getDescription

String getDescription()

 The description of the NotebookRuntime.
 

string description = 11;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 The description of the NotebookRuntime.
 

string description = 11;

Returns:

The bytes for description.

getServiceAccount

String getServiceAccount()

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

string service_account = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.ByteString getServiceAccountBytes()

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

string service_account = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for serviceAccount.

getRuntimeStateValue

int getRuntimeStateValue()

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

.google.cloud.aiplatform.v1beta1.NotebookRuntime.RuntimeState runtime_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for runtimeState.

getRuntimeState

NotebookRuntime.RuntimeState getRuntimeState()

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

.google.cloud.aiplatform.v1beta1.NotebookRuntime.RuntimeState runtime_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The runtimeState.

getIsUpgradable

boolean getIsUpgradable()

 Output only. Whether NotebookRuntime is upgradable.
 

bool is_upgradable = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The isUpgradable.

getLabelsCount

int getLabelsCount()

 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.
 

map<string, string> labels = 16;

containsLabels

boolean containsLabels(String key)

 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.
 

map<string, string> labels = 16;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 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.
 

map<string, string> labels = 16;

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 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.
 

map<string, string> labels = 16;

getLabelsOrThrow

String getLabelsOrThrow(String key)

 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.
 

map<string, string> labels = 16;

hasExpirationTime

boolean hasExpirationTime()

 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.
 

.google.protobuf.Timestamp expiration_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the expirationTime field is set.

getExpirationTime

com.google.protobuf.Timestamp 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.
 

.google.protobuf.Timestamp expiration_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The expirationTime.

getExpirationTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()

 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.
 

.google.protobuf.Timestamp expiration_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

getVersion

String getVersion()

 Output only. The VM os image version of NotebookRuntime.
 

string version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The version.

getVersionBytes

com.google.protobuf.ByteString getVersionBytes()

 Output only. The VM os image version of NotebookRuntime.
 

string version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for version.

getNotebookRuntimeTypeValue

int getNotebookRuntimeTypeValue()

 Output only. The type of the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.NotebookRuntimeType notebook_runtime_type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for notebookRuntimeType.

getNotebookRuntimeType

NotebookRuntimeType getNotebookRuntimeType()

 Output only. The type of the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.NotebookRuntimeType notebook_runtime_type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The notebookRuntimeType.

hasIdleShutdownConfig

boolean hasIdleShutdownConfig()

 Output only. The idle shutdown configuration of the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the idleShutdownConfig field is set.

getIdleShutdownConfig

NotebookIdleShutdownConfig getIdleShutdownConfig()

 Output only. The idle shutdown configuration of the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The idleShutdownConfig.

getIdleShutdownConfigOrBuilder

NotebookIdleShutdownConfigOrBuilder getIdleShutdownConfigOrBuilder()

 Output only. The idle shutdown configuration of the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

getNetworkTagsList

List<String> getNetworkTagsList()

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
 

repeated string network_tags = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the networkTags.

getNetworkTagsCount

int getNetworkTagsCount()

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
 

repeated string network_tags = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of networkTags.

getNetworkTags

String getNetworkTags(int index)

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
 

repeated string network_tags = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The networkTags at the given index.

getNetworkTagsBytes

com.google.protobuf.ByteString getNetworkTagsBytes(int index)

 Optional. The Compute Engine tags to add to runtime (see [Tagging
 instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
 

repeated string network_tags = 25 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the networkTags at the given index.

hasEncryptionSpec

boolean hasEncryptionSpec()

 Output only. Customer-managed encryption key spec for the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

EncryptionSpec getEncryptionSpec()

 Output only. Customer-managed encryption key spec for the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The encryptionSpec.

getEncryptionSpecOrBuilder

EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

 Output only. Customer-managed encryption key spec for the notebook runtime.
 

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSatisfiesPzs

boolean getSatisfiesPzs()

 Output only. Reserved for future use.
 

bool satisfies_pzs = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzs.

getSatisfiesPzi

boolean getSatisfiesPzi()

 Output only. Reserved for future use.
 

bool satisfies_pzi = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzi.