Package com.google.cloud.aiplatform.v1
Class NotebookRuntime
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.NotebookRuntime
- All Implemented Interfaces:
NotebookRuntimeOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class NotebookRuntime
extends com.google.protobuf.GeneratedMessage
implements NotebookRuntimeOrBuilder
A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.Protobuf type
google.cloud.aiplatform.v1.NotebookRuntime- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime.static enumThe substate of the NotebookRuntime to display health information.static enumThe substate of the NotebookRuntime to display state of runtime.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) The labels with user-defined metadata to organize your NotebookRuntime.booleancom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.Output only.static NotebookRuntimeThe description of the NotebookRuntime.com.google.protobuf.ByteStringThe description of the NotebookRuntime.static final com.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.Output only.Output only.Output only.Output only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.intOutput only.Output only.Output only.booleanOutput only.Deprecated.intThe labels with user-defined metadata to organize your NotebookRuntime.The labels with user-defined metadata to organize your NotebookRuntime.getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize your NotebookRuntime.getLabelsOrThrow(String key) The labels with user-defined metadata to organize your NotebookRuntime.Output only.Output only.getName()Output only.com.google.protobuf.ByteStringOutput only.Output only.Output only.getNetworkTags(int index) Optional.com.google.protobuf.ByteStringgetNetworkTagsBytes(int index) Optional.intOptional.com.google.protobuf.ProtocolStringListOptional.Output only.Output only.Output only.intOutput only.com.google.protobuf.Parser<NotebookRuntime>Output only.com.google.protobuf.ByteStringOutput only.Output only.intOutput only.Required.com.google.protobuf.ByteStringRequired.booleanOutput only.booleanOutput only.intOutput only.com.google.protobuf.ByteStringOutput only.Output only.Output only.Output only.Output only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.com.google.protobuf.ByteStringOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.inthashCode()booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic NotebookRuntime.Builderstatic NotebookRuntime.BuildernewBuilder(NotebookRuntime prototype) protected NotebookRuntime.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static NotebookRuntimeparseDelimitedFrom(InputStream input) static NotebookRuntimeparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static NotebookRuntimeparseFrom(byte[] data) static NotebookRuntimeparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static NotebookRuntimeparseFrom(com.google.protobuf.ByteString data) static NotebookRuntimeparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static NotebookRuntimeparseFrom(com.google.protobuf.CodedInputStream input) static NotebookRuntimeparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static NotebookRuntimeparseFrom(InputStream input) static NotebookRuntimeparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static NotebookRuntimeparseFrom(ByteBuffer data) static NotebookRuntimeparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<NotebookRuntime>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
RUNTIME_USER_FIELD_NUMBER
public static final int RUNTIME_USER_FIELD_NUMBER- See Also:
-
NOTEBOOK_RUNTIME_TEMPLATE_REF_FIELD_NUMBER
public static final int NOTEBOOK_RUNTIME_TEMPLATE_REF_FIELD_NUMBER- See Also:
-
PROXY_URI_FIELD_NUMBER
public static final int PROXY_URI_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
HEALTH_STATE_FIELD_NUMBER
public static final int HEALTH_STATE_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER- See Also:
-
RUNTIME_STATE_FIELD_NUMBER
public static final int RUNTIME_STATE_FIELD_NUMBER- See Also:
-
IS_UPGRADABLE_FIELD_NUMBER
public static final int IS_UPGRADABLE_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
EXPIRATION_TIME_FIELD_NUMBER
public static final int EXPIRATION_TIME_FIELD_NUMBER- See Also:
-
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER- See Also:
-
NOTEBOOK_RUNTIME_TYPE_FIELD_NUMBER
public static final int NOTEBOOK_RUNTIME_TYPE_FIELD_NUMBER- See Also:
-
MACHINE_SPEC_FIELD_NUMBER
public static final int MACHINE_SPEC_FIELD_NUMBER- See Also:
-
DATA_PERSISTENT_DISK_SPEC_FIELD_NUMBER
public static final int DATA_PERSISTENT_DISK_SPEC_FIELD_NUMBER- See Also:
-
NETWORK_SPEC_FIELD_NUMBER
public static final int NETWORK_SPEC_FIELD_NUMBER- See Also:
-
IDLE_SHUTDOWN_CONFIG_FIELD_NUMBER
public static final int IDLE_SHUTDOWN_CONFIG_FIELD_NUMBER- See Also:
-
EUC_CONFIG_FIELD_NUMBER
public static final int EUC_CONFIG_FIELD_NUMBER- See Also:
-
SHIELDED_VM_CONFIG_FIELD_NUMBER
public static final int SHIELDED_VM_CONFIG_FIELD_NUMBER- See Also:
-
NETWORK_TAGS_FIELD_NUMBER
public static final int NETWORK_TAGS_FIELD_NUMBER- See Also:
-
SOFTWARE_CONFIG_FIELD_NUMBER
public static final int SOFTWARE_CONFIG_FIELD_NUMBER- See Also:
-
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER- See Also:
-
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER- See Also:
-
SATISFIES_PZI_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Output only. The resource name of the NotebookRuntime.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNamein interfaceNotebookRuntimeOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Output only. The resource name of the NotebookRuntime.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNameBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for name.
-
getRuntimeUser
Required. The user email of the NotebookRuntime.
string runtime_user = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getRuntimeUserin interfaceNotebookRuntimeOrBuilder- Returns:
- The runtimeUser.
-
getRuntimeUserBytes
public com.google.protobuf.ByteString getRuntimeUserBytes()Required. The user email of the NotebookRuntime.
string runtime_user = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getRuntimeUserBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for runtimeUser.
-
hasNotebookRuntimeTemplateRef
public boolean hasNotebookRuntimeTemplateRef()Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
.google.cloud.aiplatform.v1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasNotebookRuntimeTemplateRefin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the notebookRuntimeTemplateRef field is set.
-
getNotebookRuntimeTemplateRef
Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
.google.cloud.aiplatform.v1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNotebookRuntimeTemplateRefin interfaceNotebookRuntimeOrBuilder- Returns:
- The notebookRuntimeTemplateRef.
-
getNotebookRuntimeTemplateRefOrBuilder
Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
.google.cloud.aiplatform.v1.NotebookRuntimeTemplateRef notebook_runtime_template_ref = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNotebookRuntimeTemplateRefOrBuilderin interfaceNotebookRuntimeOrBuilder
-
getProxyUri
Output only. The proxy endpoint used to access the NotebookRuntime.
string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getProxyUriin interfaceNotebookRuntimeOrBuilder- Returns:
- The proxyUri.
-
getProxyUriBytes
public com.google.protobuf.ByteString getProxyUriBytes()Output only. The proxy endpoint used to access the NotebookRuntime.
string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getProxyUriBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for proxyUri.
-
hasCreateTime
public boolean hasCreateTime()Output only. Timestamp when this NotebookRuntime was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. Timestamp when this NotebookRuntime was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceNotebookRuntimeOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when this NotebookRuntime was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceNotebookRuntimeOrBuilder
-
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];- Specified by:
hasUpdateTimein interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. Timestamp when this NotebookRuntime was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceNotebookRuntimeOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp when this NotebookRuntime was most recently updated.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceNotebookRuntimeOrBuilder
-
getHealthStateValue
public int getHealthStateValue()Output only. The health state of the NotebookRuntime.
.google.cloud.aiplatform.v1.NotebookRuntime.HealthState health_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getHealthStateValuein interfaceNotebookRuntimeOrBuilder- Returns:
- The enum numeric value on the wire for healthState.
-
getHealthState
Output only. The health state of the NotebookRuntime.
.google.cloud.aiplatform.v1.NotebookRuntime.HealthState health_state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getHealthStatein interfaceNotebookRuntimeOrBuilder- Returns:
- The healthState.
-
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];- Specified by:
getDisplayNamein interfaceNotebookRuntimeOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.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];- Specified by:
getDisplayNameBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for displayName.
-
getDescription
The description of the NotebookRuntime.
string description = 11;- Specified by:
getDescriptionin interfaceNotebookRuntimeOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()The description of the NotebookRuntime.
string description = 11;- Specified by:
getDescriptionBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for description.
-
getServiceAccount
Output only. Deprecated: This field is no longer used 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. The service account that the NotebookRuntime workload runs as.
string service_account = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getServiceAccountin interfaceNotebookRuntimeOrBuilder- Returns:
- The serviceAccount.
-
getServiceAccountBytes
public com.google.protobuf.ByteString getServiceAccountBytes()Output only. Deprecated: This field is no longer used 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. The service account that the NotebookRuntime workload runs as.
string service_account = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getServiceAccountBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for serviceAccount.
-
getRuntimeStateValue
public int getRuntimeStateValue()Output only. The runtime (instance) state of the NotebookRuntime.
.google.cloud.aiplatform.v1.NotebookRuntime.RuntimeState runtime_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRuntimeStateValuein interfaceNotebookRuntimeOrBuilder- Returns:
- The enum numeric value on the wire for runtimeState.
-
getRuntimeState
Output only. The runtime (instance) state of the NotebookRuntime.
.google.cloud.aiplatform.v1.NotebookRuntime.RuntimeState runtime_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRuntimeStatein interfaceNotebookRuntimeOrBuilder- Returns:
- The runtimeState.
-
getIsUpgradable
public boolean getIsUpgradable()Output only. Whether NotebookRuntime is upgradable.
bool is_upgradable = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIsUpgradablein interfaceNotebookRuntimeOrBuilder- Returns:
- The isUpgradable.
-
getLabelsCount
public int getLabelsCount()Description copied from interface:NotebookRuntimeOrBuilderThe 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;- Specified by:
getLabelsCountin interfaceNotebookRuntimeOrBuilder
-
containsLabels
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;- Specified by:
containsLabelsin interfaceNotebookRuntimeOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceNotebookRuntimeOrBuilder
-
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;- Specified by:
getLabelsMapin interfaceNotebookRuntimeOrBuilder
-
getLabelsOrDefault
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;- Specified by:
getLabelsOrDefaultin interfaceNotebookRuntimeOrBuilder
-
getLabelsOrThrow
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;- Specified by:
getLabelsOrThrowin interfaceNotebookRuntimeOrBuilder
-
hasExpirationTime
public boolean hasExpirationTime()Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
.google.protobuf.Timestamp expiration_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasExpirationTimein interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the expirationTime field is set.
-
getExpirationTime
public com.google.protobuf.Timestamp getExpirationTime()Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
.google.protobuf.Timestamp expiration_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getExpirationTimein interfaceNotebookRuntimeOrBuilder- Returns:
- The expirationTime.
-
getExpirationTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getExpirationTimeOrBuilder()Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
.google.protobuf.Timestamp expiration_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getExpirationTimeOrBuilderin interfaceNotebookRuntimeOrBuilder
-
getVersion
Output only. The VM os image version of NotebookRuntime.
string version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVersionin interfaceNotebookRuntimeOrBuilder- Returns:
- The version.
-
getVersionBytes
public com.google.protobuf.ByteString getVersionBytes()Output only. The VM os image version of NotebookRuntime.
string version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getVersionBytesin interfaceNotebookRuntimeOrBuilder- Returns:
- The bytes for version.
-
getNotebookRuntimeTypeValue
public int getNotebookRuntimeTypeValue()Output only. The type of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookRuntimeType notebook_runtime_type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNotebookRuntimeTypeValuein interfaceNotebookRuntimeOrBuilder- Returns:
- The enum numeric value on the wire for notebookRuntimeType.
-
getNotebookRuntimeType
Output only. The type of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookRuntimeType notebook_runtime_type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNotebookRuntimeTypein interfaceNotebookRuntimeOrBuilder- Returns:
- The notebookRuntimeType.
-
hasMachineSpec
public boolean hasMachineSpec()Output only. The specification of a single machine used by the notebook runtime.
.google.cloud.aiplatform.v1.MachineSpec machine_spec = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasMachineSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the machineSpec field is set.
-
getMachineSpec
Output only. The specification of a single machine used by the notebook runtime.
.google.cloud.aiplatform.v1.MachineSpec machine_spec = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getMachineSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- The machineSpec.
-
getMachineSpecOrBuilder
Output only. The specification of a single machine used by the notebook runtime.
.google.cloud.aiplatform.v1.MachineSpec machine_spec = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getMachineSpecOrBuilderin interfaceNotebookRuntimeOrBuilder
-
hasDataPersistentDiskSpec
public boolean hasDataPersistentDiskSpec()Output only. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the notebook runtime as data disk storage.
.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasDataPersistentDiskSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the dataPersistentDiskSpec field is set.
-
getDataPersistentDiskSpec
Output only. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the notebook runtime as data disk storage.
.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDataPersistentDiskSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- The dataPersistentDiskSpec.
-
getDataPersistentDiskSpecOrBuilder
Output only. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the notebook runtime as data disk storage.
.google.cloud.aiplatform.v1.PersistentDiskSpec data_persistent_disk_spec = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDataPersistentDiskSpecOrBuilderin interfaceNotebookRuntimeOrBuilder
-
hasNetworkSpec
public boolean hasNetworkSpec()Output only. Network spec of the notebook runtime.
.google.cloud.aiplatform.v1.NetworkSpec network_spec = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasNetworkSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the networkSpec field is set.
-
getNetworkSpec
Output only. Network spec of the notebook runtime.
.google.cloud.aiplatform.v1.NetworkSpec network_spec = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNetworkSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- The networkSpec.
-
getNetworkSpecOrBuilder
Output only. Network spec of the notebook runtime.
.google.cloud.aiplatform.v1.NetworkSpec network_spec = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNetworkSpecOrBuilderin interfaceNotebookRuntimeOrBuilder
-
hasIdleShutdownConfig
public boolean hasIdleShutdownConfig()Output only. The idle shutdown configuration of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasIdleShutdownConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the idleShutdownConfig field is set.
-
getIdleShutdownConfig
Output only. The idle shutdown configuration of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIdleShutdownConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- The idleShutdownConfig.
-
getIdleShutdownConfigOrBuilder
Output only. The idle shutdown configuration of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookIdleShutdownConfig idle_shutdown_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIdleShutdownConfigOrBuilderin interfaceNotebookRuntimeOrBuilder
-
hasEucConfig
public boolean hasEucConfig()Output only. EUC configuration of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasEucConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the eucConfig field is set.
-
getEucConfig
Output only. EUC configuration of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEucConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- The eucConfig.
-
getEucConfigOrBuilder
Output only. EUC configuration of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookEucConfig euc_config = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEucConfigOrBuilderin interfaceNotebookRuntimeOrBuilder
-
hasShieldedVmConfig
public boolean hasShieldedVmConfig()Output only. Runtime Shielded VM spec.
.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasShieldedVmConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the shieldedVmConfig field is set.
-
getShieldedVmConfig
Output only. Runtime Shielded VM spec.
.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getShieldedVmConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- The shieldedVmConfig.
-
getShieldedVmConfigOrBuilder
Output only. Runtime Shielded VM spec.
.google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getShieldedVmConfigOrBuilderin interfaceNotebookRuntimeOrBuilder
-
getNetworkTagsList
public com.google.protobuf.ProtocolStringList 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 = 25 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getNetworkTagsListin interfaceNotebookRuntimeOrBuilder- Returns:
- A list containing the networkTags.
-
getNetworkTagsCount
public 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 = 25 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getNetworkTagsCountin interfaceNotebookRuntimeOrBuilder- Returns:
- The count of networkTags.
-
getNetworkTags
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 = 25 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getNetworkTagsin interfaceNotebookRuntimeOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The networkTags at the given index.
-
getNetworkTagsBytes
public 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 = 25 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getNetworkTagsBytesin interfaceNotebookRuntimeOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the networkTags at the given index.
-
hasSoftwareConfig
public boolean hasSoftwareConfig()Output only. Software config of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookSoftwareConfig software_config = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasSoftwareConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the softwareConfig field is set.
-
getSoftwareConfig
Output only. Software config of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookSoftwareConfig software_config = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSoftwareConfigin interfaceNotebookRuntimeOrBuilder- Returns:
- The softwareConfig.
-
getSoftwareConfigOrBuilder
Output only. Software config of the notebook runtime.
.google.cloud.aiplatform.v1.NotebookSoftwareConfig software_config = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSoftwareConfigOrBuilderin interfaceNotebookRuntimeOrBuilder
-
hasEncryptionSpec
public boolean hasEncryptionSpec()Output only. Customer-managed encryption key spec for the notebook runtime.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasEncryptionSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- Whether the encryptionSpec field is set.
-
getEncryptionSpec
Output only. Customer-managed encryption key spec for the notebook runtime.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEncryptionSpecin interfaceNotebookRuntimeOrBuilder- Returns:
- The encryptionSpec.
-
getEncryptionSpecOrBuilder
Output only. Customer-managed encryption key spec for the notebook runtime.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEncryptionSpecOrBuilderin interfaceNotebookRuntimeOrBuilder
-
getSatisfiesPzs
public boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSatisfiesPzsin interfaceNotebookRuntimeOrBuilder- Returns:
- The satisfiesPzs.
-
getSatisfiesPzi
public boolean getSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSatisfiesPziin interfaceNotebookRuntimeOrBuilder- Returns:
- The satisfiesPzi.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static NotebookRuntime parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static NotebookRuntime parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static NotebookRuntime parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static NotebookRuntime parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static NotebookRuntime parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static NotebookRuntime parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static NotebookRuntime parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static NotebookRuntime parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static NotebookRuntime parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static NotebookRuntime parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected NotebookRuntime.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-