- 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 final class NotebookRuntime extends GeneratedMessageV3 implements NotebookRuntimeOrBuilderA 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.v1beta1.NotebookRuntime
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NotebookRuntimeImplements
NotebookRuntimeOrBuilderStatic Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXPIRATION_TIME_FIELD_NUMBER
public static final int EXPIRATION_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
HEALTH_STATE_FIELD_NUMBER
public static final int HEALTH_STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IDLE_SHUTDOWN_CONFIG_FIELD_NUMBER
public static final int IDLE_SHUTDOWN_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
IS_UPGRADABLE_FIELD_NUMBER
public static final int IS_UPGRADABLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NETWORK_TAGS_FIELD_NUMBER
public static final int NETWORK_TAGS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NOTEBOOK_RUNTIME_TEMPLATE_REF_FIELD_NUMBER
public static final int NOTEBOOK_RUNTIME_TEMPLATE_REF_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NOTEBOOK_RUNTIME_TYPE_FIELD_NUMBER
public static final int NOTEBOOK_RUNTIME_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROXY_URI_FIELD_NUMBER
public static final int PROXY_URI_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RUNTIME_STATE_FIELD_NUMBER
public static final int RUNTIME_STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RUNTIME_USER_FIELD_NUMBER
public static final int RUNTIME_USER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SATISFIES_PZI_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static NotebookRuntime getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static NotebookRuntime.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
NotebookRuntime.Builder |
|
newBuilder(NotebookRuntime prototype)
public static NotebookRuntime.Builder newBuilder(NotebookRuntime prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
NotebookRuntime |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime.Builder |
|
parseDelimitedFrom(InputStream input)
public static NotebookRuntime parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookRuntime parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static NotebookRuntime parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NotebookRuntime parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static NotebookRuntime parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotebookRuntime parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static NotebookRuntime parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookRuntime parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static NotebookRuntime parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookRuntime parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static NotebookRuntime parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NotebookRuntime parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<NotebookRuntime> parser()| Returns | |
|---|---|
| Type | Description |
Parser<NotebookRuntime> |
|
Methods
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 |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| 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. |
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. |
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.v1beta1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecOrBuilder()
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()Output only. Customer-managed encryption key spec for the notebook runtime.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder |
|
getExpirationTime()
public Timestamp getExpirationTime()Output only. Timestamp when this NotebookRuntime will be expired:
- System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.
- 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. |
getExpirationTimeOrBuilder()
public TimestampOrBuilder getExpirationTimeOrBuilder()Output only. Timestamp when this NotebookRuntime will be expired:
- System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.
- 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.v1beta1.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.v1beta1.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.v1beta1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
NotebookIdleShutdownConfig |
The idleShutdownConfig. |
getIdleShutdownConfigOrBuilder()
public NotebookIdleShutdownConfigOrBuilder getIdleShutdownConfigOrBuilder()Output only. The idle shutdown configuration of the notebook runtime.
.google.cloud.aiplatform.v1beta1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 |
|
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 |
intThe 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 |
intThe 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.v1beta1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
NotebookRuntimeTemplateRef |
The notebookRuntimeTemplateRef. |
getNotebookRuntimeTemplateRefOrBuilder()
public NotebookRuntimeTemplateRefOrBuilder getNotebookRuntimeTemplateRefOrBuilder()Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
.google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
NotebookRuntimeTemplateRefOrBuilder |
|
getNotebookRuntimeType()
public NotebookRuntimeType getNotebookRuntimeType()Output only. The type of the notebook runtime.
.google.cloud.aiplatform.v1beta1.NotebookRuntimeType notebook_runtime_type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
NotebookRuntimeType |
The notebookRuntimeType. |
getNotebookRuntimeTypeValue()
public int getNotebookRuntimeTypeValue()Output only. The type of the notebook runtime.
.google.cloud.aiplatform.v1beta1.NotebookRuntimeType notebook_runtime_type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for notebookRuntimeType. |
getParserForType()
public Parser<NotebookRuntime> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<NotebookRuntime> |
|
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.v1beta1.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.v1beta1.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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
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.v1beta1.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:
- System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted.
- 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.v1beta1.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.v1beta1.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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public NotebookRuntime.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
NotebookRuntime.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NotebookRuntime.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
NotebookRuntime.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public NotebookRuntime.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
NotebookRuntime.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|