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:
  • 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:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public String getName()
       Output only. The resource name of the NotebookRuntime.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface NotebookRuntimeOrBuilder
      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:
      getNameBytes in interface NotebookRuntimeOrBuilder
      Returns:
      The bytes for name.
    • getRuntimeUser

      public String getRuntimeUser()
       Required. The user email of the NotebookRuntime.
       
      string runtime_user = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getRuntimeUser in interface NotebookRuntimeOrBuilder
      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:
      getRuntimeUserBytes in interface NotebookRuntimeOrBuilder
      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:
      hasNotebookRuntimeTemplateRef in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the notebookRuntimeTemplateRef field is set.
    • getNotebookRuntimeTemplateRef

      public NotebookRuntimeTemplateRef 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:
      getNotebookRuntimeTemplateRef in interface NotebookRuntimeOrBuilder
      Returns:
      The notebookRuntimeTemplateRef.
    • getNotebookRuntimeTemplateRefOrBuilder

      public NotebookRuntimeTemplateRefOrBuilder 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:
      getNotebookRuntimeTemplateRefOrBuilder in interface NotebookRuntimeOrBuilder
    • getProxyUri

      public String getProxyUri()
       Output only. The proxy endpoint used to access the NotebookRuntime.
       
      string proxy_uri = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProxyUri in interface NotebookRuntimeOrBuilder
      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:
      getProxyUriBytes in interface NotebookRuntimeOrBuilder
      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:
      hasCreateTime in interface NotebookRuntimeOrBuilder
      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:
      getCreateTime in interface NotebookRuntimeOrBuilder
      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:
      getCreateTimeOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasUpdateTime in interface NotebookRuntimeOrBuilder
      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:
      getUpdateTime in interface NotebookRuntimeOrBuilder
      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:
      getUpdateTimeOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      getHealthStateValue in interface NotebookRuntimeOrBuilder
      Returns:
      The enum numeric value on the wire for healthState.
    • getHealthState

      public NotebookRuntime.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:
      getHealthState in interface NotebookRuntimeOrBuilder
      Returns:
      The healthState.
    • 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];
      Specified by:
      getDisplayName in interface NotebookRuntimeOrBuilder
      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:
      getDisplayNameBytes in interface NotebookRuntimeOrBuilder
      Returns:
      The bytes for displayName.
    • getDescription

      public String getDescription()
       The description of the NotebookRuntime.
       
      string description = 11;
      Specified by:
      getDescription in interface NotebookRuntimeOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       The description of the NotebookRuntime.
       
      string description = 11;
      Specified by:
      getDescriptionBytes in interface NotebookRuntimeOrBuilder
      Returns:
      The bytes for description.
    • getServiceAccount

      public String 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:
      getServiceAccount in interface NotebookRuntimeOrBuilder
      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:
      getServiceAccountBytes in interface NotebookRuntimeOrBuilder
      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:
      getRuntimeStateValue in interface NotebookRuntimeOrBuilder
      Returns:
      The enum numeric value on the wire for runtimeState.
    • getRuntimeState

      public NotebookRuntime.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:
      getRuntimeState in interface NotebookRuntimeOrBuilder
      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:
      getIsUpgradable in interface NotebookRuntimeOrBuilder
      Returns:
      The isUpgradable.
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: NotebookRuntimeOrBuilder
       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:
      getLabelsCount in interface NotebookRuntimeOrBuilder
    • containsLabels

      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;
      Specified by:
      containsLabels in interface NotebookRuntimeOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface NotebookRuntimeOrBuilder
    • 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;
      Specified by:
      getLabelsMap in interface NotebookRuntimeOrBuilder
    • getLabelsOrDefault

      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;
      Specified by:
      getLabelsOrDefault in interface NotebookRuntimeOrBuilder
    • getLabelsOrThrow

      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;
      Specified by:
      getLabelsOrThrow in interface NotebookRuntimeOrBuilder
    • 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:
      hasExpirationTime in interface NotebookRuntimeOrBuilder
      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:
      getExpirationTime in interface NotebookRuntimeOrBuilder
      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:
      getExpirationTimeOrBuilder in interface NotebookRuntimeOrBuilder
    • getVersion

      public String getVersion()
       Output only. The VM os image version of NotebookRuntime.
       
      string version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getVersion in interface NotebookRuntimeOrBuilder
      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:
      getVersionBytes in interface NotebookRuntimeOrBuilder
      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:
      getNotebookRuntimeTypeValue in interface NotebookRuntimeOrBuilder
      Returns:
      The enum numeric value on the wire for notebookRuntimeType.
    • getNotebookRuntimeType

      public 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:
      getNotebookRuntimeType in interface NotebookRuntimeOrBuilder
      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:
      hasMachineSpec in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the machineSpec field is set.
    • getMachineSpec

      public MachineSpec 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:
      getMachineSpec in interface NotebookRuntimeOrBuilder
      Returns:
      The machineSpec.
    • getMachineSpecOrBuilder

      public MachineSpecOrBuilder 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:
      getMachineSpecOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasDataPersistentDiskSpec in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the dataPersistentDiskSpec field is set.
    • getDataPersistentDiskSpec

      public PersistentDiskSpec 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:
      getDataPersistentDiskSpec in interface NotebookRuntimeOrBuilder
      Returns:
      The dataPersistentDiskSpec.
    • getDataPersistentDiskSpecOrBuilder

      public PersistentDiskSpecOrBuilder 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:
      getDataPersistentDiskSpecOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasNetworkSpec in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the networkSpec field is set.
    • getNetworkSpec

      public NetworkSpec 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:
      getNetworkSpec in interface NotebookRuntimeOrBuilder
      Returns:
      The networkSpec.
    • getNetworkSpecOrBuilder

      public NetworkSpecOrBuilder 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:
      getNetworkSpecOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasIdleShutdownConfig in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the idleShutdownConfig field is set.
    • getIdleShutdownConfig

      public NotebookIdleShutdownConfig 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:
      getIdleShutdownConfig in interface NotebookRuntimeOrBuilder
      Returns:
      The idleShutdownConfig.
    • getIdleShutdownConfigOrBuilder

      public NotebookIdleShutdownConfigOrBuilder 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:
      getIdleShutdownConfigOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasEucConfig in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the eucConfig field is set.
    • getEucConfig

      public NotebookEucConfig 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:
      getEucConfig in interface NotebookRuntimeOrBuilder
      Returns:
      The eucConfig.
    • getEucConfigOrBuilder

      public NotebookEucConfigOrBuilder 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:
      getEucConfigOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasShieldedVmConfig in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the shieldedVmConfig field is set.
    • getShieldedVmConfig

      public ShieldedVmConfig getShieldedVmConfig()
       Output only. Runtime Shielded VM spec.
       
      .google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getShieldedVmConfig in interface NotebookRuntimeOrBuilder
      Returns:
      The shieldedVmConfig.
    • getShieldedVmConfigOrBuilder

      public ShieldedVmConfigOrBuilder getShieldedVmConfigOrBuilder()
       Output only. Runtime Shielded VM spec.
       
      .google.cloud.aiplatform.v1.ShieldedVmConfig shielded_vm_config = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getShieldedVmConfigOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      getNetworkTagsList in interface NotebookRuntimeOrBuilder
      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:
      getNetworkTagsCount in interface NotebookRuntimeOrBuilder
      Returns:
      The count of networkTags.
    • getNetworkTags

      public 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 = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNetworkTags in interface NotebookRuntimeOrBuilder
      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:
      getNetworkTagsBytes in interface NotebookRuntimeOrBuilder
      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:
      hasSoftwareConfig in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the softwareConfig field is set.
    • getSoftwareConfig

      public NotebookSoftwareConfig 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:
      getSoftwareConfig in interface NotebookRuntimeOrBuilder
      Returns:
      The softwareConfig.
    • getSoftwareConfigOrBuilder

      public NotebookSoftwareConfigOrBuilder 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:
      getSoftwareConfigOrBuilder in interface NotebookRuntimeOrBuilder
    • 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:
      hasEncryptionSpec in interface NotebookRuntimeOrBuilder
      Returns:
      Whether the encryptionSpec field is set.
    • getEncryptionSpec

      public EncryptionSpec 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:
      getEncryptionSpec in interface NotebookRuntimeOrBuilder
      Returns:
      The encryptionSpec.
    • getEncryptionSpecOrBuilder

      public EncryptionSpecOrBuilder 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:
      getEncryptionSpecOrBuilder in interface NotebookRuntimeOrBuilder
    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface NotebookRuntimeOrBuilder
      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:
      getSatisfiesPzi in interface NotebookRuntimeOrBuilder
      Returns:
      The satisfiesPzi.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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

      public static NotebookRuntime parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static NotebookRuntime parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static NotebookRuntime parseDelimitedFrom(InputStream input) throws IOException
      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

      public NotebookRuntime.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static NotebookRuntime.Builder newBuilder()
    • newBuilder

      public static NotebookRuntime.Builder newBuilder(NotebookRuntime prototype)
    • toBuilder

      public NotebookRuntime.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected NotebookRuntime.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static NotebookRuntime getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<NotebookRuntime> parser()
    • getParserForType

      public com.google.protobuf.Parser<NotebookRuntime> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public NotebookRuntime getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder