Class NotebookRuntimeTemplate.Builder (3.45.0)

public static final class NotebookRuntimeTemplate.Builder extends GeneratedMessageV3.Builder<NotebookRuntimeTemplate.Builder> implements NotebookRuntimeTemplateOrBuilder

A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template.

Protobuf type google.cloud.aiplatform.v1.NotebookRuntimeTemplate

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllNetworkTags(Iterable<String> values)

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

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

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

Parameter
Name Description
values Iterable<String>

The networkTags to add.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

addNetworkTags(String value)

public NotebookRuntimeTemplate.Builder addNetworkTags(String value)

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

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

Parameter
Name Description
value String

The networkTags to add.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

addNetworkTagsBytes(ByteString value)

public NotebookRuntimeTemplate.Builder addNetworkTagsBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes of the networkTags to add.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NotebookRuntimeTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

build()

public NotebookRuntimeTemplate build()
Returns
Type Description
NotebookRuntimeTemplate

buildPartial()

public NotebookRuntimeTemplate buildPartial()
Returns
Type Description
NotebookRuntimeTemplate

clear()

public NotebookRuntimeTemplate.Builder clear()
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

clearCreateTime()

public NotebookRuntimeTemplate.Builder clearCreateTime()

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearDataPersistentDiskSpec()

public NotebookRuntimeTemplate.Builder clearDataPersistentDiskSpec()

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearDescription()

public NotebookRuntimeTemplate.Builder clearDescription()

The description of the NotebookRuntimeTemplate.

string description = 3;

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearDisplayName()

public NotebookRuntimeTemplate.Builder clearDisplayName()

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

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

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearEtag()

public NotebookRuntimeTemplate.Builder clearEtag()

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

string etag = 14;

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearEucConfig()

public NotebookRuntimeTemplate.Builder clearEucConfig()

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearField(Descriptors.FieldDescriptor field)

public NotebookRuntimeTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

clearIdleShutdownConfig()

public NotebookRuntimeTemplate.Builder clearIdleShutdownConfig()

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearIsDefault()

public NotebookRuntimeTemplate.Builder clearIsDefault()

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

bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearLabels()

public NotebookRuntimeTemplate.Builder clearLabels()
Returns
Type Description
NotebookRuntimeTemplate.Builder

clearMachineSpec()

public NotebookRuntimeTemplate.Builder clearMachineSpec()

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearName()

public NotebookRuntimeTemplate.Builder clearName()

The resource name of the NotebookRuntimeTemplate.

string name = 1;

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearNetworkSpec()

public NotebookRuntimeTemplate.Builder clearNetworkSpec()

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearNetworkTags()

public NotebookRuntimeTemplate.Builder clearNetworkTags()

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

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

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearNotebookRuntimeType()

public NotebookRuntimeTemplate.Builder clearNotebookRuntimeType()

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

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

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NotebookRuntimeTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

clearServiceAccount()

public NotebookRuntimeTemplate.Builder clearServiceAccount()

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 13;

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

clearShieldedVmConfig()

public NotebookRuntimeTemplate.Builder clearShieldedVmConfig()

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NotebookRuntimeTemplate.Builder

clearUpdateTime()

public NotebookRuntimeTemplate.Builder clearUpdateTime()

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

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

Returns
Type Description
NotebookRuntimeTemplate.Builder

clone()

public NotebookRuntimeTemplate.Builder clone()
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

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

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Returns
Type Description
TimestampOrBuilder

getDataPersistentDiskSpec()

public PersistentDiskSpec getDataPersistentDiskSpec()

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistentDiskSpec

The dataPersistentDiskSpec.

getDataPersistentDiskSpecBuilder()

public PersistentDiskSpec.Builder getDataPersistentDiskSpecBuilder()

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistentDiskSpec.Builder

getDataPersistentDiskSpecOrBuilder()

public PersistentDiskSpecOrBuilder getDataPersistentDiskSpecOrBuilder()

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistentDiskSpecOrBuilder

getDefaultInstanceForType()

public NotebookRuntimeTemplate getDefaultInstanceForType()
Returns
Type Description
NotebookRuntimeTemplate

getDescription()

public String getDescription()

The description of the NotebookRuntimeTemplate.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the NotebookRuntimeTemplate.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

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

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 14;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 14;

Returns
Type Description
ByteString

The bytes for etag.

getEucConfig()

public NotebookEucConfig getEucConfig()

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Returns
Type Description
NotebookEucConfig

The eucConfig.

getEucConfigBuilder()

public NotebookEucConfig.Builder getEucConfigBuilder()

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Returns
Type Description
NotebookEucConfig.Builder

getEucConfigOrBuilder()

public NotebookEucConfigOrBuilder getEucConfigOrBuilder()

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Returns
Type Description
NotebookEucConfigOrBuilder

getIdleShutdownConfig()

public NotebookIdleShutdownConfig getIdleShutdownConfig()

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Returns
Type Description
NotebookIdleShutdownConfig

The idleShutdownConfig.

getIdleShutdownConfigBuilder()

public NotebookIdleShutdownConfig.Builder getIdleShutdownConfigBuilder()

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Returns
Type Description
NotebookIdleShutdownConfig.Builder

getIdleShutdownConfigOrBuilder()

public NotebookIdleShutdownConfigOrBuilder getIdleShutdownConfigOrBuilder()

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Returns
Type Description
NotebookIdleShutdownConfigOrBuilder

getIsDefault()

public boolean getIsDefault()

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

bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The isDefault.

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 the NotebookRuntimeTemplates.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

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 the NotebookRuntimeTemplates.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

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 the NotebookRuntimeTemplates.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

Parameter
Name Description
key String
Returns
Type Description
String

getMachineSpec()

public MachineSpec getMachineSpec()

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MachineSpec

The machineSpec.

getMachineSpecBuilder()

public MachineSpec.Builder getMachineSpecBuilder()

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MachineSpec.Builder

getMachineSpecOrBuilder()

public MachineSpecOrBuilder getMachineSpecOrBuilder()

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MachineSpecOrBuilder

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

The resource name of the NotebookRuntimeTemplate.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the NotebookRuntimeTemplate.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetworkSpec()

public NetworkSpec getNetworkSpec()

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NetworkSpec

The networkSpec.

getNetworkSpecBuilder()

public NetworkSpec.Builder getNetworkSpecBuilder()

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NetworkSpec.Builder

getNetworkSpecOrBuilder()

public NetworkSpecOrBuilder getNetworkSpecOrBuilder()

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NetworkSpecOrBuilder

getNetworkTags(int index)

public String getNetworkTags(int index)

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

repeated string network_tags = 21 [(.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 = 21 [(.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 = 21 [(.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 = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the networkTags.

getNotebookRuntimeType()

public NotebookRuntimeType getNotebookRuntimeType()

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

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

Returns
Type Description
NotebookRuntimeType

The notebookRuntimeType.

getNotebookRuntimeTypeValue()

public int getNotebookRuntimeTypeValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for notebookRuntimeType.

getServiceAccount()

public String getServiceAccount()

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 13;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 13;

Returns
Type Description
ByteString

The bytes for serviceAccount.

getShieldedVmConfig()

public ShieldedVmConfig getShieldedVmConfig()

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ShieldedVmConfig

The shieldedVmConfig.

getShieldedVmConfigBuilder()

public ShieldedVmConfig.Builder getShieldedVmConfigBuilder()

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ShieldedVmConfig.Builder

getShieldedVmConfigOrBuilder()

public ShieldedVmConfigOrBuilder getShieldedVmConfigOrBuilder()

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ShieldedVmConfigOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

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

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataPersistentDiskSpec()

public boolean hasDataPersistentDiskSpec()

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataPersistentDiskSpec field is set.

hasEucConfig()

public boolean hasEucConfig()

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Returns
Type Description
boolean

Whether the eucConfig field is set.

hasIdleShutdownConfig()

public boolean hasIdleShutdownConfig()

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Returns
Type Description
boolean

Whether the idleShutdownConfig field is set.

hasMachineSpec()

public boolean hasMachineSpec()

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the machineSpec field is set.

hasNetworkSpec()

public boolean hasNetworkSpec()

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the networkSpec field is set.

hasShieldedVmConfig()

public boolean hasShieldedVmConfig()

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the shieldedVmConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 11 [(.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

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

mergeCreateTime(Timestamp value)

public NotebookRuntimeTemplate.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeDataPersistentDiskSpec(PersistentDiskSpec value)

public NotebookRuntimeTemplate.Builder mergeDataPersistentDiskSpec(PersistentDiskSpec value)

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PersistentDiskSpec
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeEucConfig(NotebookEucConfig value)

public NotebookRuntimeTemplate.Builder mergeEucConfig(NotebookEucConfig value)

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Parameter
Name Description
value NotebookEucConfig
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeFrom(NotebookRuntimeTemplate other)

public NotebookRuntimeTemplate.Builder mergeFrom(NotebookRuntimeTemplate other)
Parameter
Name Description
other NotebookRuntimeTemplate
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NotebookRuntimeTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public NotebookRuntimeTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

mergeIdleShutdownConfig(NotebookIdleShutdownConfig value)

public NotebookRuntimeTemplate.Builder mergeIdleShutdownConfig(NotebookIdleShutdownConfig value)

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Parameter
Name Description
value NotebookIdleShutdownConfig
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeMachineSpec(MachineSpec value)

public NotebookRuntimeTemplate.Builder mergeMachineSpec(MachineSpec value)

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value MachineSpec
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeNetworkSpec(NetworkSpec value)

public NotebookRuntimeTemplate.Builder mergeNetworkSpec(NetworkSpec value)

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value NetworkSpec
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeShieldedVmConfig(ShieldedVmConfig value)

public NotebookRuntimeTemplate.Builder mergeShieldedVmConfig(ShieldedVmConfig value)

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ShieldedVmConfig
Returns
Type Description
NotebookRuntimeTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NotebookRuntimeTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

mergeUpdateTime(Timestamp value)

public NotebookRuntimeTemplate.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
NotebookRuntimeTemplate.Builder

putAllLabels(Map<String,String> values)

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

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

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
NotebookRuntimeTemplate.Builder

putLabels(String key, String value)

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

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

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

Parameters
Name Description
key String
value String
Returns
Type Description
NotebookRuntimeTemplate.Builder

removeLabels(String key)

public NotebookRuntimeTemplate.Builder removeLabels(String key)

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

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 15;

Parameter
Name Description
key String
Returns
Type Description
NotebookRuntimeTemplate.Builder

setCreateTime(Timestamp value)

public NotebookRuntimeTemplate.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
NotebookRuntimeTemplate.Builder

setCreateTime(Timestamp.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this NotebookRuntimeTemplate was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setDataPersistentDiskSpec(PersistentDiskSpec value)

public NotebookRuntimeTemplate.Builder setDataPersistentDiskSpec(PersistentDiskSpec value)

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PersistentDiskSpec
Returns
Type Description
NotebookRuntimeTemplate.Builder

setDataPersistentDiskSpec(PersistentDiskSpec.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setDataPersistentDiskSpec(PersistentDiskSpec.Builder builderForValue)

Optional. The specification of persistent disk attached to the runtime as data disk storage.

.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PersistentDiskSpec.Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setDescription(String value)

public NotebookRuntimeTemplate.Builder setDescription(String value)

The description of the NotebookRuntimeTemplate.

string description = 3;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public NotebookRuntimeTemplate.Builder setDescriptionBytes(ByteString value)

The description of the NotebookRuntimeTemplate.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setDisplayName(String value)

public NotebookRuntimeTemplate.Builder setDisplayName(String value)

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

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public NotebookRuntimeTemplate.Builder setDisplayNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setEtag(String value)

public NotebookRuntimeTemplate.Builder setEtag(String value)

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

string etag = 14;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public NotebookRuntimeTemplate.Builder setEtagBytes(ByteString value)

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

string etag = 14;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setEucConfig(NotebookEucConfig value)

public NotebookRuntimeTemplate.Builder setEucConfig(NotebookEucConfig value)

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Parameter
Name Description
value NotebookEucConfig
Returns
Type Description
NotebookRuntimeTemplate.Builder

setEucConfig(NotebookEucConfig.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setEucConfig(NotebookEucConfig.Builder builderForValue)

EUC configuration of the NotebookRuntimeTemplate.

.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;

Parameter
Name Description
builderForValue NotebookEucConfig.Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NotebookRuntimeTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

setIdleShutdownConfig(NotebookIdleShutdownConfig value)

public NotebookRuntimeTemplate.Builder setIdleShutdownConfig(NotebookIdleShutdownConfig value)

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Parameter
Name Description
value NotebookIdleShutdownConfig
Returns
Type Description
NotebookRuntimeTemplate.Builder

setIdleShutdownConfig(NotebookIdleShutdownConfig.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setIdleShutdownConfig(NotebookIdleShutdownConfig.Builder builderForValue)

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

.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 17;

Parameter
Name Description
builderForValue NotebookIdleShutdownConfig.Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setIsDefault(boolean value)

public NotebookRuntimeTemplate.Builder setIsDefault(boolean value)

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

bool is_default = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The isDefault to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setMachineSpec(MachineSpec value)

public NotebookRuntimeTemplate.Builder setMachineSpec(MachineSpec value)

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value MachineSpec
Returns
Type Description
NotebookRuntimeTemplate.Builder

setMachineSpec(MachineSpec.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setMachineSpec(MachineSpec.Builder builderForValue)

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

.google.cloud.aiplatform.v1.MachineSpec machine_spec = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue MachineSpec.Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setName(String value)

public NotebookRuntimeTemplate.Builder setName(String value)

The resource name of the NotebookRuntimeTemplate.

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public NotebookRuntimeTemplate.Builder setNameBytes(ByteString value)

The resource name of the NotebookRuntimeTemplate.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setNetworkSpec(NetworkSpec value)

public NotebookRuntimeTemplate.Builder setNetworkSpec(NetworkSpec value)

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value NetworkSpec
Returns
Type Description
NotebookRuntimeTemplate.Builder

setNetworkSpec(NetworkSpec.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setNetworkSpec(NetworkSpec.Builder builderForValue)

Optional. Network spec.

.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue NetworkSpec.Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setNetworkTags(int index, String value)

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

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

repeated string network_tags = 21 [(.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
NotebookRuntimeTemplate.Builder

This builder for chaining.

setNotebookRuntimeType(NotebookRuntimeType value)

public NotebookRuntimeTemplate.Builder setNotebookRuntimeType(NotebookRuntimeType value)

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

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

Parameter
Name Description
value NotebookRuntimeType

The notebookRuntimeType to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setNotebookRuntimeTypeValue(int value)

public NotebookRuntimeTemplate.Builder setNotebookRuntimeTypeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for notebookRuntimeType to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

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

public NotebookRuntimeTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

setServiceAccount(String value)

public NotebookRuntimeTemplate.Builder setServiceAccount(String value)

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 13;

Parameter
Name Description
value String

The serviceAccount to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public NotebookRuntimeTemplate.Builder setServiceAccountBytes(ByteString value)

The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, the Compute Engine default service account is used.

string service_account = 13;

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.

Returns
Type Description
NotebookRuntimeTemplate.Builder

This builder for chaining.

setShieldedVmConfig(ShieldedVmConfig value)

public NotebookRuntimeTemplate.Builder setShieldedVmConfig(ShieldedVmConfig value)

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ShieldedVmConfig
Returns
Type Description
NotebookRuntimeTemplate.Builder

setShieldedVmConfig(ShieldedVmConfig.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setShieldedVmConfig(ShieldedVmConfig.Builder builderForValue)

Optional. Immutable. Runtime Shielded VM spec.

.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue ShieldedVmConfig.Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final NotebookRuntimeTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NotebookRuntimeTemplate.Builder
Overrides

setUpdateTime(Timestamp value)

public NotebookRuntimeTemplate.Builder setUpdateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
NotebookRuntimeTemplate.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public NotebookRuntimeTemplate.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
NotebookRuntimeTemplate.Builder