com.google.cloud.aiplatform.v1

Interface NotebookRuntimeTemplateOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

NotebookRuntimeTemplate, NotebookRuntimeTemplate.Builder

public interface NotebookRuntimeTemplateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize the NotebookRuntimeTemplates.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
PersistentDiskSpec	getDataPersistentDiskSpec() Optional.
PersistentDiskSpecOrBuilder	getDataPersistentDiskSpecOrBuilder() Optional.
String	getDescription() The description of the NotebookRuntimeTemplate.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the NotebookRuntimeTemplate.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
EncryptionSpec	getEncryptionSpec() Customer-managed encryption key spec for the notebook runtime.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Customer-managed encryption key spec for the notebook runtime.
String	getEtag() Used to perform consistent read-modify-write updates.
com.google.protobuf.ByteString	getEtagBytes() Used to perform consistent read-modify-write updates.
NotebookEucConfig	getEucConfig() EUC configuration of the NotebookRuntimeTemplate.
NotebookEucConfigOrBuilder	getEucConfigOrBuilder() EUC configuration of the NotebookRuntimeTemplate.
NotebookIdleShutdownConfig	getIdleShutdownConfig() The idle shutdown configuration of NotebookRuntimeTemplate.
NotebookIdleShutdownConfigOrBuilder	getIdleShutdownConfigOrBuilder() The idle shutdown configuration of NotebookRuntimeTemplate.
boolean	getIsDefault() Deprecated. google.cloud.aiplatform.v1.NotebookRuntimeTemplate.is_default is deprecated. See google/cloud/aiplatform/v1/notebook_runtime.proto;l=74
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize the NotebookRuntimeTemplates.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize the NotebookRuntimeTemplates.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize the NotebookRuntimeTemplates.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize the NotebookRuntimeTemplates.
MachineSpec	getMachineSpec() Optional.
MachineSpecOrBuilder	getMachineSpecOrBuilder() Optional.
String	getName() The resource name of the NotebookRuntimeTemplate.
com.google.protobuf.ByteString	getNameBytes() The resource name of the NotebookRuntimeTemplate.
NetworkSpec	getNetworkSpec() Optional.
NetworkSpecOrBuilder	getNetworkSpecOrBuilder() Optional.
String	getNetworkTags(int index) Optional.
com.google.protobuf.ByteString	getNetworkTagsBytes(int index) Optional.
int	getNetworkTagsCount() Optional.
List<String>	getNetworkTagsList() Optional.
NotebookRuntimeType	getNotebookRuntimeType() Optional.
int	getNotebookRuntimeTypeValue() Optional.
String	getServiceAccount() Deprecated. google.cloud.aiplatform.v1.NotebookRuntimeTemplate.service_account is deprecated. See google/cloud/aiplatform/v1/notebook_runtime.proto;l=109
com.google.protobuf.ByteString	getServiceAccountBytes() Deprecated. google.cloud.aiplatform.v1.NotebookRuntimeTemplate.service_account is deprecated. See google/cloud/aiplatform/v1/notebook_runtime.proto;l=109
ShieldedVmConfig	getShieldedVmConfig() Optional.
ShieldedVmConfigOrBuilder	getShieldedVmConfigOrBuilder() Optional.
NotebookSoftwareConfig	getSoftwareConfig() Optional.
NotebookSoftwareConfigOrBuilder	getSoftwareConfigOrBuilder() Optional.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasDataPersistentDiskSpec() Optional.
boolean	hasEncryptionSpec() Customer-managed encryption key spec for the notebook runtime.
boolean	hasEucConfig() EUC configuration of the NotebookRuntimeTemplate.
boolean	hasIdleShutdownConfig() The idle shutdown configuration of NotebookRuntimeTemplate.
boolean	hasMachineSpec() Optional.
boolean	hasNetworkSpec() Optional.
boolean	hasShieldedVmConfig() Optional.
boolean	hasSoftwareConfig() Optional.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 The resource name of the NotebookRuntimeTemplate.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The resource name of the NotebookRuntimeTemplate.
 

string name = 1;

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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

The bytes for displayName.

getDescription

String getDescription()

 The description of the NotebookRuntimeTemplate.
 

string description = 3;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 The description of the NotebookRuntimeTemplate.
 

string description = 3;

Returns:

The bytes for description.

getIsDefault

@Deprecated
boolean getIsDefault()

Deprecated. google.cloud.aiplatform.v1.NotebookRuntimeTemplate.is_default is deprecated. See google/cloud/aiplatform/v1/notebook_runtime.proto;l=74

 Output only. Deprecated: This field has no behavior. Use
 notebook_runtime_type = 'ONE_CLICK' instead.

 The default template to use if not specified.
 

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

Returns:

The isDefault.

hasMachineSpec

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:

Whether the machineSpec field is set.

getMachineSpec

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:

The machineSpec.

getMachineSpecOrBuilder

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

hasDataPersistentDiskSpec

boolean hasDataPersistentDiskSpec()

 Optional. The specification of [persistent
 disk][https://cloud.google.com/compute/docs/disks/persistent-disks]
 attached to the runtime as data disk storage.
 

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

Returns:

Whether the dataPersistentDiskSpec field is set.

getDataPersistentDiskSpec

PersistentDiskSpec getDataPersistentDiskSpec()

 Optional. The specification of [persistent
 disk][https://cloud.google.com/compute/docs/disks/persistent-disks]
 attached to the runtime as data disk storage.
 

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

Returns:

The dataPersistentDiskSpec.

getDataPersistentDiskSpecOrBuilder

PersistentDiskSpecOrBuilder getDataPersistentDiskSpecOrBuilder()

 Optional. The specification of [persistent
 disk][https://cloud.google.com/compute/docs/disks/persistent-disks]
 attached to the runtime as data disk storage.
 

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

hasNetworkSpec

boolean hasNetworkSpec()

 Optional. Network spec.
 

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

Returns:

Whether the networkSpec field is set.

getNetworkSpec

NetworkSpec getNetworkSpec()

 Optional. Network spec.
 

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

Returns:

The networkSpec.

getNetworkSpecOrBuilder

NetworkSpecOrBuilder getNetworkSpecOrBuilder()

 Optional. Network spec.
 

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

getServiceAccount

@Deprecated
String getServiceAccount()

Deprecated. google.cloud.aiplatform.v1.NotebookRuntimeTemplate.service_account is deprecated. See google/cloud/aiplatform/v1/notebook_runtime.proto;l=109

 Deprecated: This field is ignored and the "Vertex AI Notebook Service
 Account"
 (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is
 used for the runtime workload identity.
 See
 https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account
 for more details.
 For NotebookExecutionJob, use NotebookExecutionJob.service_account instead.

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

 If not specified, the [Compute Engine default service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.
 

string service_account = 13 [deprecated = true];

Returns:

The serviceAccount.

getServiceAccountBytes

@Deprecated
com.google.protobuf.ByteString getServiceAccountBytes()

Deprecated. google.cloud.aiplatform.v1.NotebookRuntimeTemplate.service_account is deprecated. See google/cloud/aiplatform/v1/notebook_runtime.proto;l=109

 Deprecated: This field is ignored and the "Vertex AI Notebook Service
 Account"
 (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is
 used for the runtime workload identity.
 See
 https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account
 for more details.
 For NotebookExecutionJob, use NotebookExecutionJob.service_account instead.

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

 If not specified, the [Compute Engine default service
 account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
 is used.
 

string service_account = 13 [deprecated = true];

Returns:

The bytes for serviceAccount.

getEtag

String getEtag()

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

string etag = 14;

Returns:

The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

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

string etag = 14;

Returns:

The bytes for etag.

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

hasIdleShutdownConfig

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:

Whether the idleShutdownConfig field is set.

getIdleShutdownConfig

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:

The idleShutdownConfig.

getIdleShutdownConfigOrBuilder

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;

hasEucConfig

boolean hasEucConfig()

 EUC configuration of the NotebookRuntimeTemplate.
 

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

Returns:

Whether the eucConfig field is set.

getEucConfig

NotebookEucConfig getEucConfig()

 EUC configuration of the NotebookRuntimeTemplate.
 

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

Returns:

The eucConfig.

getEucConfigOrBuilder

NotebookEucConfigOrBuilder getEucConfigOrBuilder()

 EUC configuration of the NotebookRuntimeTemplate.
 

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

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this NotebookRuntimeTemplate was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this NotebookRuntimeTemplate was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this NotebookRuntimeTemplate was created.
 

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

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

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

getNotebookRuntimeTypeValue

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:

The enum numeric value on the wire for notebookRuntimeType.

getNotebookRuntimeType

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:

The notebookRuntimeType.

hasShieldedVmConfig

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:

Whether the shieldedVmConfig field is set.

getShieldedVmConfig

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:

The shieldedVmConfig.

getShieldedVmConfigOrBuilder

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

getNetworkTagsList

List<String> getNetworkTagsList()

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

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

Returns:

A list containing the networkTags.

getNetworkTagsCount

int getNetworkTagsCount()

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

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

Returns:

The count of networkTags.

getNetworkTags

String getNetworkTags(int index)

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

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

Parameters:

index - The index of the element to return.

Returns:

The networkTags at the given index.

getNetworkTagsBytes

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

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

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the networkTags at the given index.

hasEncryptionSpec

boolean hasEncryptionSpec()

 Customer-managed encryption key spec for the notebook runtime.
 

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 23;

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

EncryptionSpec getEncryptionSpec()

 Customer-managed encryption key spec for the notebook runtime.
 

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 23;

Returns:

The encryptionSpec.

getEncryptionSpecOrBuilder

EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

 Customer-managed encryption key spec for the notebook runtime.
 

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 23;

hasSoftwareConfig

boolean hasSoftwareConfig()

 Optional. The notebook software configuration of the notebook runtime.
 

.google.cloud.aiplatform.v1.NotebookSoftwareConfig software_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the softwareConfig field is set.

getSoftwareConfig

NotebookSoftwareConfig getSoftwareConfig()

 Optional. The notebook software configuration of the notebook runtime.
 

.google.cloud.aiplatform.v1.NotebookSoftwareConfig software_config = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The softwareConfig.

getSoftwareConfigOrBuilder

NotebookSoftwareConfigOrBuilder getSoftwareConfigOrBuilder()

 Optional. The notebook software configuration of the notebook runtime.
 

.google.cloud.aiplatform.v1.NotebookSoftwareConfig software_config = 24 [(.google.api.field_behavior) = OPTIONAL];