- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 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 interface NotebookRuntimeTemplateOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 abstract 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. |
getCreateTimeOrBuilder()
public abstract 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 abstract 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. |
getDataPersistentDiskSpecOrBuilder()
public abstract 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 |
|
getDescription()
public abstract String getDescription()The description of the NotebookRuntimeTemplate.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()The description of the NotebookRuntimeTemplate.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract NotebookEucConfig getEucConfig()EUC configuration of the NotebookRuntimeTemplate.
.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;
| Returns | |
|---|---|
| Type | Description |
NotebookEucConfig |
The eucConfig. |
getEucConfigOrBuilder()
public abstract NotebookEucConfigOrBuilder getEucConfigOrBuilder()EUC configuration of the NotebookRuntimeTemplate.
.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 18;
| Returns | |
|---|---|
| Type | Description |
NotebookEucConfigOrBuilder |
|
getIdleShutdownConfig()
public abstract 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. |
getIdleShutdownConfigOrBuilder()
public abstract 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 abstract 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 abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getMachineSpecOrBuilder()
public abstract 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 |
|
getName()
public abstract String getName()Output only. The resource name of the NotebookRuntimeTemplate.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Output only. The resource name of the NotebookRuntimeTemplate.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNetworkSpec()
public abstract NetworkSpec getNetworkSpec()Optional. Network spec.
.google.cloud.aiplatform.v1.NetworkSpec network_spec = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
NetworkSpec |
The networkSpec. |
getNetworkSpecOrBuilder()
public abstract 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 abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The networkTags at the given index. |
getNetworkTagsBytes(int index)
public abstract 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the networkTags at the given index. |
getNetworkTagsCount()
public abstract 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 abstract List<String> 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 |
List<String> |
A list containing the networkTags. |
getNotebookRuntimeType()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getShieldedVmConfigOrBuilder()
public abstract 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 abstract 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. |
getUpdateTimeOrBuilder()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |