Package com.google.cloud.notebooks.v1

Interface RuntimeSoftwareConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RuntimeSoftwareConfig, RuntimeSoftwareConfig.Builder
    public interface RuntimeSoftwareConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getNotebookUpgradeSchedule

        String getNotebookUpgradeSchedule()
         Cron expression in UTC timezone, used to schedule instance auto upgrade.
 Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
        string notebook_upgrade_schedule = 1;
        Returns:
        The notebookUpgradeSchedule.

      • getNotebookUpgradeScheduleBytes

        com.google.protobuf.ByteString getNotebookUpgradeScheduleBytes()
         Cron expression in UTC timezone, used to schedule instance auto upgrade.
 Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).
        string notebook_upgrade_schedule = 1;
        Returns:
        The bytes for notebookUpgradeSchedule.

      • hasEnableHealthMonitoring

        boolean hasEnableHealthMonitoring()
         Verifies core internal services are running.
 Default: True
        optional bool enable_health_monitoring = 2;
        Returns:
        Whether the enableHealthMonitoring field is set.

      • getEnableHealthMonitoring

        boolean getEnableHealthMonitoring()
         Verifies core internal services are running.
 Default: True
        optional bool enable_health_monitoring = 2;
        Returns:
        The enableHealthMonitoring.

      • hasIdleShutdown

        boolean hasIdleShutdown()
         Runtime will automatically shutdown after idle_shutdown_time.
 Default: True
        optional bool idle_shutdown = 3;
        Returns:
        Whether the idleShutdown field is set.

      • getIdleShutdown

        boolean getIdleShutdown()
         Runtime will automatically shutdown after idle_shutdown_time.
 Default: True
        optional bool idle_shutdown = 3;
        Returns:
        The idleShutdown.

      • getIdleShutdownTimeout

        int getIdleShutdownTimeout()
         Time in minutes to wait before shutting down runtime. Default: 180 minutes
        int32 idle_shutdown_timeout = 4;
        Returns:
        The idleShutdownTimeout.

      • getInstallGpuDriver

        boolean getInstallGpuDriver()
         Install Nvidia Driver automatically.
 Default: True
        bool install_gpu_driver = 5;
        Returns:
        The installGpuDriver.

      • getCustomGpuDriverPath

        String getCustomGpuDriverPath()
         Specify a custom Cloud Storage path where the GPU driver is stored.
 If not specified, we'll automatically choose from official GPU drivers.
        string custom_gpu_driver_path = 6;
        Returns:
        The customGpuDriverPath.

      • getCustomGpuDriverPathBytes

        com.google.protobuf.ByteString getCustomGpuDriverPathBytes()
         Specify a custom Cloud Storage path where the GPU driver is stored.
 If not specified, we'll automatically choose from official GPU drivers.
        string custom_gpu_driver_path = 6;
        Returns:
        The bytes for customGpuDriverPath.

      • getPostStartupScript

        String getPostStartupScript()
         Path to a Bash script that automatically runs after a notebook instance
 fully boots up. The path must be a URL or
 Cloud Storage path (`gs://path-to-file/file-name`).
        string post_startup_script = 7;
        Returns:
        The postStartupScript.

      • getPostStartupScriptBytes

        com.google.protobuf.ByteString getPostStartupScriptBytes()
         Path to a Bash script that automatically runs after a notebook instance
 fully boots up. The path must be a URL or
 Cloud Storage path (`gs://path-to-file/file-name`).
        string post_startup_script = 7;
        Returns:
        The bytes for postStartupScript.

      • getKernelsList

        List<ContainerImage> getKernelsList()
         Optional. Use a list of container images to use as Kernels in the notebook instance.
        repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getKernels

        ContainerImage getKernels​(int index)
         Optional. Use a list of container images to use as Kernels in the notebook instance.
        repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getKernelsCount

        int getKernelsCount()
         Optional. Use a list of container images to use as Kernels in the notebook instance.
        repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getKernelsOrBuilderList

        List<? extends ContainerImageOrBuilder> getKernelsOrBuilderList()
         Optional. Use a list of container images to use as Kernels in the notebook instance.
        repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getKernelsOrBuilder

        ContainerImageOrBuilder getKernelsOrBuilder​(int index)
         Optional. Use a list of container images to use as Kernels in the notebook instance.
        repeated .google.cloud.notebooks.v1.ContainerImage kernels = 8 [(.google.api.field_behavior) = OPTIONAL];

      • hasUpgradeable

        boolean hasUpgradeable()
         Output only. Bool indicating whether an newer image is available in an image family.
        optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the upgradeable field is set.

      • getUpgradeable

        boolean getUpgradeable()
         Output only. Bool indicating whether an newer image is available in an image family.
        optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The upgradeable.

      • getPostStartupScriptBehaviorValue

        int getPostStartupScriptBehaviorValue()
         Behavior for the post startup script.
        .google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
        Returns:
        The enum numeric value on the wire for postStartupScriptBehavior.

      • getPostStartupScriptBehavior

        RuntimeSoftwareConfig.PostStartupScriptBehavior getPostStartupScriptBehavior()
         Behavior for the post startup script.
        .google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
        Returns:
        The postStartupScriptBehavior.

      • hasDisableTerminal

        boolean hasDisableTerminal()
         Bool indicating whether JupyterLab terminal will be available or not.
 Default: False
        optional bool disable_terminal = 11;
        Returns:
        Whether the disableTerminal field is set.

      • getDisableTerminal

        boolean getDisableTerminal()
         Bool indicating whether JupyterLab terminal will be available or not.
 Default: False
        optional bool disable_terminal = 11;
        Returns:
        The disableTerminal.

      • hasVersion

        boolean hasVersion()
         Output only. version of boot image such as M100, from release label of the image.
        optional string version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the version field is set.

      • getVersion

        String getVersion()
         Output only. version of boot image such as M100, from release label of the image.
        optional string version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The version.

      • getVersionBytes

        com.google.protobuf.ByteString getVersionBytes()
         Output only. version of boot image such as M100, from release label of the image.
        optional string version = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for version.