Class NotebookRuntime.Builder (3.47.0)

Version 3.47.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class NotebookRuntime.Builder extends GeneratedMessageV3.Builder<NotebookRuntime.Builder> implements NotebookRuntimeOrBuilder

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.

Protobuf type google.cloud.aiplatform.v1.NotebookRuntime

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > NotebookRuntime.Builder

Implements

NotebookRuntimeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllNetworkTags(Iterable<String> values)

public NotebookRuntime.Builder addAllNetworkTags(Iterable<String> values)

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

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

Parameter
Name	Description
values	Iterable<String> The networkTags to add.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

addNetworkTags(String value)

public NotebookRuntime.Builder addNetworkTags(String value)

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

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

Parameter
Name	Description
value	String The networkTags to add.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

addNetworkTagsBytes(ByteString value)

public NotebookRuntime.Builder addNetworkTagsBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes of the networkTags to add.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NotebookRuntime.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public NotebookRuntime build()

Returns
Type	Description
NotebookRuntime

buildPartial()

public NotebookRuntime buildPartial()

Returns
Type	Description
NotebookRuntime

clear()

public NotebookRuntime.Builder clear()

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public NotebookRuntime.Builder clearCreateTime()

Output only. Timestamp when this NotebookRuntime was created.

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

Returns
Type	Description
NotebookRuntime.Builder

clearDescription()

public NotebookRuntime.Builder clearDescription()

The description of the NotebookRuntime.

string description = 11;

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearDisplayName()

public NotebookRuntime.Builder clearDisplayName()

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
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearEncryptionSpec()

public NotebookRuntime.Builder clearEncryptionSpec()

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

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

Returns
Type	Description
NotebookRuntime.Builder

clearExpirationTime()

public NotebookRuntime.Builder clearExpirationTime()

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
Type	Description
NotebookRuntime.Builder

clearField(Descriptors.FieldDescriptor field)

public NotebookRuntime.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHealthState()

public NotebookRuntime.Builder clearHealthState()

Output only. The health state of the NotebookRuntime.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearIdleShutdownConfig()

public NotebookRuntime.Builder clearIdleShutdownConfig()

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

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

Returns
Type	Description
NotebookRuntime.Builder

clearIsUpgradable()

public NotebookRuntime.Builder clearIsUpgradable()

Output only. Whether NotebookRuntime is upgradable.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearLabels()

public NotebookRuntime.Builder clearLabels()

Returns
Type	Description
NotebookRuntime.Builder

clearName()

public NotebookRuntime.Builder clearName()

Output only. The resource name of the NotebookRuntime.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearNetworkTags()

public NotebookRuntime.Builder clearNetworkTags()

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

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearNotebookRuntimeTemplateRef()

public NotebookRuntime.Builder clearNotebookRuntimeTemplateRef()

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

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

Returns
Type	Description
NotebookRuntime.Builder

clearNotebookRuntimeType()

public NotebookRuntime.Builder clearNotebookRuntimeType()

Output only. The type of the notebook runtime.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NotebookRuntime.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProxyUri()

public NotebookRuntime.Builder clearProxyUri()

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

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearRuntimeState()

public NotebookRuntime.Builder clearRuntimeState()

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

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearRuntimeUser()

public NotebookRuntime.Builder clearRuntimeUser()

Required. The user email of the NotebookRuntime.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearSatisfiesPzi()

public NotebookRuntime.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearSatisfiesPzs()

public NotebookRuntime.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearServiceAccount()

public NotebookRuntime.Builder clearServiceAccount()

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

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clearUpdateTime()

public NotebookRuntime.Builder clearUpdateTime()

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

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

Returns
Type	Description
NotebookRuntime.Builder

clearVersion()

public NotebookRuntime.Builder clearVersion()

Output only. The VM os image version of NotebookRuntime.

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

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

clone()

public NotebookRuntime.Builder clone()

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this NotebookRuntime was created.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this NotebookRuntime was created.

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this NotebookRuntime was created.

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

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public NotebookRuntime getDefaultInstanceForType()

Returns
Type	Description
NotebookRuntime

getDescription()

public String getDescription()

The description of the NotebookRuntime.

string description = 11;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the NotebookRuntime.

string description = 11;

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public 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
Type	Description
String	The displayName.

getDisplayNameBytes()

public 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
Type	Description
ByteString	The bytes for displayName.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

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

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

Returns
Type	Description
EncryptionSpec	The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

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

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

Returns
Type	Description
EncryptionSpec.Builder

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

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

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

Returns
Type	Description
EncryptionSpecOrBuilder

getExpirationTime()

public 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
Type	Description
Timestamp	The expirationTime.

getExpirationTimeBuilder()

public Timestamp.Builder getExpirationTimeBuilder()

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

getExpirationTimeOrBuilder()

public 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];

Returns
Type	Description
TimestampOrBuilder

getHealthState()

public NotebookRuntime.HealthState getHealthState()

Output only. The health state of the NotebookRuntime.

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

Returns
Type	Description
NotebookRuntime.HealthState	The healthState.

getHealthStateValue()

public int getHealthStateValue()

Output only. The health state of the NotebookRuntime.

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

Returns
Type	Description
int	The enum numeric value on the wire for healthState.

getIdleShutdownConfig()

public NotebookIdleShutdownConfig getIdleShutdownConfig()

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

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

Returns
Type	Description
NotebookIdleShutdownConfig	The idleShutdownConfig.

getIdleShutdownConfigBuilder()

public NotebookIdleShutdownConfig.Builder getIdleShutdownConfigBuilder()

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

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

Returns
Type	Description
NotebookIdleShutdownConfig.Builder

getIdleShutdownConfigOrBuilder()

public NotebookIdleShutdownConfigOrBuilder getIdleShutdownConfigOrBuilder()

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

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

Returns
Type	Description
NotebookIdleShutdownConfigOrBuilder

getIsUpgradable()

public boolean getIsUpgradable()

Output only. Whether NotebookRuntime is upgradable.

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

Returns
Type	Description
boolean	The isUpgradable.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public 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;

Returns
Type	Description
int

getLabelsMap()

public 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;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public 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;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public String getName()

Output only. The resource name of the NotebookRuntime.

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

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the NotebookRuntime.

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

Returns
Type	Description
ByteString	The bytes for name.

getNetworkTags(int index)

public String getNetworkTags(int index)

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

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The networkTags at the given index.

getNetworkTagsBytes(int index)

public ByteString getNetworkTagsBytes(int index)

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

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

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the networkTags at the given index.

getNetworkTagsCount()

public int getNetworkTagsCount()

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

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

Returns
Type	Description
int	The count of networkTags.

getNetworkTagsList()

public ProtocolStringList getNetworkTagsList()

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

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

Returns
Type	Description
ProtocolStringList	A list containing the networkTags.

getNotebookRuntimeTemplateRef()

public NotebookRuntimeTemplateRef getNotebookRuntimeTemplateRef()

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

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

Returns
Type	Description
NotebookRuntimeTemplateRef	The notebookRuntimeTemplateRef.

getNotebookRuntimeTemplateRefBuilder()

public NotebookRuntimeTemplateRef.Builder getNotebookRuntimeTemplateRefBuilder()

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

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

Returns
Type	Description
NotebookRuntimeTemplateRef.Builder

getNotebookRuntimeTemplateRefOrBuilder()

public NotebookRuntimeTemplateRefOrBuilder getNotebookRuntimeTemplateRefOrBuilder()

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

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

Returns
Type	Description
NotebookRuntimeTemplateRefOrBuilder

getNotebookRuntimeType()

public NotebookRuntimeType getNotebookRuntimeType()

Output only. The type of the notebook runtime.

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

Returns
Type	Description
NotebookRuntimeType	The notebookRuntimeType.

getNotebookRuntimeTypeValue()

public int getNotebookRuntimeTypeValue()

Output only. The type of the notebook runtime.

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

Returns
Type	Description
int	The enum numeric value on the wire for notebookRuntimeType.

getProxyUri()

public String getProxyUri()

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

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

Returns
Type	Description
String	The proxyUri.

getProxyUriBytes()

public ByteString getProxyUriBytes()

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

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

Returns
Type	Description
ByteString	The bytes for proxyUri.

getRuntimeState()

public NotebookRuntime.RuntimeState getRuntimeState()

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

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

Returns
Type	Description
NotebookRuntime.RuntimeState	The runtimeState.

getRuntimeStateValue()

public int getRuntimeStateValue()

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

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

Returns
Type	Description
int	The enum numeric value on the wire for runtimeState.

getRuntimeUser()

public String getRuntimeUser()

Required. The user email of the NotebookRuntime.

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

Returns
Type	Description
String	The runtimeUser.

getRuntimeUserBytes()

public ByteString getRuntimeUserBytes()

Required. The user email of the NotebookRuntime.

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

Returns
Type	Description
ByteString	The bytes for runtimeUser.

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

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

Returns
Type	Description
boolean	The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
Type	Description
boolean	The satisfiesPzs.

getServiceAccount()

public String getServiceAccount()

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

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

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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

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

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getUpdateTime()

public 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
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type	Description
TimestampOrBuilder

getVersion()

public String getVersion()

Output only. The VM os image version of NotebookRuntime.

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

Returns
Type	Description
String	The version.

getVersionBytes()

public ByteString getVersionBytes()

Output only. The VM os image version of NotebookRuntime.

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

Returns
Type	Description
ByteString	The bytes for version.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this NotebookRuntime was created.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

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

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

Returns
Type	Description
boolean	Whether the encryptionSpec field is set.

hasExpirationTime()

public 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
Type	Description
boolean	Whether the expirationTime field is set.

hasIdleShutdownConfig()

public boolean hasIdleShutdownConfig()

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

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

Returns
Type	Description
boolean	Whether the idleShutdownConfig field is set.

hasNotebookRuntimeTemplateRef()

public boolean hasNotebookRuntimeTemplateRef()

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

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

Returns
Type	Description
boolean	Whether the notebookRuntimeTemplateRef field is set.

hasUpdateTime()

public 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
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public NotebookRuntime.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this NotebookRuntime was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
NotebookRuntime.Builder

mergeEncryptionSpec(EncryptionSpec value)

public NotebookRuntime.Builder mergeEncryptionSpec(EncryptionSpec value)

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

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

Parameter
Name	Description
value	EncryptionSpec

Returns
Type	Description
NotebookRuntime.Builder

mergeExpirationTime(Timestamp value)

public NotebookRuntime.Builder mergeExpirationTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
NotebookRuntime.Builder

mergeFrom(NotebookRuntime other)

public NotebookRuntime.Builder mergeFrom(NotebookRuntime other)

Parameter
Name	Description
other	NotebookRuntime

Returns
Type	Description
NotebookRuntime.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NotebookRuntime.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
NotebookRuntime.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public NotebookRuntime.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
NotebookRuntime.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeIdleShutdownConfig(NotebookIdleShutdownConfig value)

public NotebookRuntime.Builder mergeIdleShutdownConfig(NotebookIdleShutdownConfig value)

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

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

Parameter
Name	Description
value	NotebookIdleShutdownConfig

Returns
Type	Description
NotebookRuntime.Builder

mergeNotebookRuntimeTemplateRef(NotebookRuntimeTemplateRef value)

public NotebookRuntime.Builder mergeNotebookRuntimeTemplateRef(NotebookRuntimeTemplateRef value)

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

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

Parameter
Name	Description
value	NotebookRuntimeTemplateRef

Returns
Type	Description
NotebookRuntime.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NotebookRuntime.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public NotebookRuntime.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
NotebookRuntime.Builder

putAllLabels(Map<String,String> values)

public NotebookRuntime.Builder putAllLabels(Map<String,String> values)

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;

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
NotebookRuntime.Builder

putLabels(String key, String value)

public NotebookRuntime.Builder putLabels(String key, String value)

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;

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
NotebookRuntime.Builder

removeLabels(String key)

public NotebookRuntime.Builder removeLabels(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;

Parameter
Name	Description
key	String

Returns
Type	Description
NotebookRuntime.Builder

setCreateTime(Timestamp value)

public NotebookRuntime.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this NotebookRuntime was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
NotebookRuntime.Builder

setCreateTime(Timestamp.Builder builderForValue)

public NotebookRuntime.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this NotebookRuntime was created.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
NotebookRuntime.Builder

setDescription(String value)

public NotebookRuntime.Builder setDescription(String value)

The description of the NotebookRuntime.

string description = 11;

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public NotebookRuntime.Builder setDescriptionBytes(ByteString value)

The description of the NotebookRuntime.

string description = 11;

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setDisplayName(String value)

public NotebookRuntime.Builder setDisplayName(String value)

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];

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public NotebookRuntime.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public NotebookRuntime.Builder setEncryptionSpec(EncryptionSpec value)

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

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

Parameter
Name	Description
value	EncryptionSpec

Returns
Type	Description
NotebookRuntime.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public NotebookRuntime.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	EncryptionSpec.Builder

Returns
Type	Description
NotebookRuntime.Builder

setExpirationTime(Timestamp value)

public NotebookRuntime.Builder setExpirationTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
NotebookRuntime.Builder

setExpirationTime(Timestamp.Builder builderForValue)

public NotebookRuntime.Builder setExpirationTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
NotebookRuntime.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NotebookRuntime.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHealthState(NotebookRuntime.HealthState value)

public NotebookRuntime.Builder setHealthState(NotebookRuntime.HealthState value)

Output only. The health state of the NotebookRuntime.

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

Parameter
Name	Description
value	NotebookRuntime.HealthState The healthState to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setHealthStateValue(int value)

public NotebookRuntime.Builder setHealthStateValue(int value)

Output only. The health state of the NotebookRuntime.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for healthState to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setIdleShutdownConfig(NotebookIdleShutdownConfig value)

public NotebookRuntime.Builder setIdleShutdownConfig(NotebookIdleShutdownConfig value)

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

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

Parameter
Name	Description
value	NotebookIdleShutdownConfig

Returns
Type	Description
NotebookRuntime.Builder

setIdleShutdownConfig(NotebookIdleShutdownConfig.Builder builderForValue)

public NotebookRuntime.Builder setIdleShutdownConfig(NotebookIdleShutdownConfig.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	NotebookIdleShutdownConfig.Builder

Returns
Type	Description
NotebookRuntime.Builder

setIsUpgradable(boolean value)

public NotebookRuntime.Builder setIsUpgradable(boolean value)

Output only. Whether NotebookRuntime is upgradable.

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

Parameter
Name	Description
value	boolean The isUpgradable to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setName(String value)

public NotebookRuntime.Builder setName(String value)

Output only. The resource name of the NotebookRuntime.

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setNameBytes(ByteString value)

public NotebookRuntime.Builder setNameBytes(ByteString value)

Output only. The resource name of the NotebookRuntime.

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setNetworkTags(int index, String value)

public NotebookRuntime.Builder setNetworkTags(int index, String value)

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

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

Parameters
Name	Description
index	int The index to set the value at.
value	String The networkTags to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setNotebookRuntimeTemplateRef(NotebookRuntimeTemplateRef value)

public NotebookRuntime.Builder setNotebookRuntimeTemplateRef(NotebookRuntimeTemplateRef value)

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

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

Parameter
Name	Description
value	NotebookRuntimeTemplateRef

Returns
Type	Description
NotebookRuntime.Builder

setNotebookRuntimeTemplateRef(NotebookRuntimeTemplateRef.Builder builderForValue)

public NotebookRuntime.Builder setNotebookRuntimeTemplateRef(NotebookRuntimeTemplateRef.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	NotebookRuntimeTemplateRef.Builder

Returns
Type	Description
NotebookRuntime.Builder

setNotebookRuntimeType(NotebookRuntimeType value)

public NotebookRuntime.Builder setNotebookRuntimeType(NotebookRuntimeType value)

Output only. The type of the notebook runtime.

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

Parameter
Name	Description
value	NotebookRuntimeType The notebookRuntimeType to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setNotebookRuntimeTypeValue(int value)

public NotebookRuntime.Builder setNotebookRuntimeTypeValue(int value)

Output only. The type of the notebook runtime.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for notebookRuntimeType to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setProxyUri(String value)

public NotebookRuntime.Builder setProxyUri(String value)

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

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

Parameter
Name	Description
value	String The proxyUri to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setProxyUriBytes(ByteString value)

public NotebookRuntime.Builder setProxyUriBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for proxyUri to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NotebookRuntime.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRuntimeState(NotebookRuntime.RuntimeState value)

public NotebookRuntime.Builder setRuntimeState(NotebookRuntime.RuntimeState value)

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

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

Parameter
Name	Description
value	NotebookRuntime.RuntimeState The runtimeState to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setRuntimeStateValue(int value)

public NotebookRuntime.Builder setRuntimeStateValue(int value)

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

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

Parameter
Name	Description
value	int The enum numeric value on the wire for runtimeState to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setRuntimeUser(String value)

public NotebookRuntime.Builder setRuntimeUser(String value)

Required. The user email of the NotebookRuntime.

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

Parameter
Name	Description
value	String The runtimeUser to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setRuntimeUserBytes(ByteString value)

public NotebookRuntime.Builder setRuntimeUserBytes(ByteString value)

Required. The user email of the NotebookRuntime.

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

Parameter
Name	Description
value	ByteString The bytes for runtimeUser to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setSatisfiesPzi(boolean value)

public NotebookRuntime.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

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

Parameter
Name	Description
value	boolean The satisfiesPzi to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setSatisfiesPzs(boolean value)

public NotebookRuntime.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

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

Parameter
Name	Description
value	boolean The satisfiesPzs to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setServiceAccount(String value)

public NotebookRuntime.Builder setServiceAccount(String value)

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

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

Parameter
Name	Description
value	String The serviceAccount to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setServiceAccountBytes(ByteString value)

public NotebookRuntime.Builder setServiceAccountBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for serviceAccount to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final NotebookRuntime.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NotebookRuntime.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public NotebookRuntime.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
NotebookRuntime.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public NotebookRuntime.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
NotebookRuntime.Builder

setVersion(String value)

public NotebookRuntime.Builder setVersion(String value)

Output only. The VM os image version of NotebookRuntime.

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

Parameter
Name	Description
value	String The version to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.

setVersionBytes(ByteString value)

public NotebookRuntime.Builder setVersionBytes(ByteString value)

Output only. The VM os image version of NotebookRuntime.

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

Parameter
Name	Description
value	ByteString The bytes for version to set.

Returns
Type	Description
NotebookRuntime.Builder	This builder for chaining.