Package com.google.cloud.notebooks.v1

Class RuntimeSoftwareConfig

  • All Implemented Interfaces:
    RuntimeSoftwareConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RuntimeSoftwareConfig
extends com.google.protobuf.GeneratedMessageV3
implements RuntimeSoftwareConfigOrBuilder
     Specifies the selection and configuration of software inside the runtime.
 The properties to set on runtime.
 Properties keys are specified in `key:value` format, for example:

 * `idle_shutdown: true`
 * `idle_shutdown_timeout: 180`
 * `enable_health_monitoring: true`
    Protobuf type google.cloud.notebooks.v1.RuntimeSoftwareConfig
    See Also:
    Serialized Form

    • Field Detail

      • NOTEBOOK_UPGRADE_SCHEDULE_FIELD_NUMBER

        public static final int NOTEBOOK_UPGRADE_SCHEDULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_HEALTH_MONITORING_FIELD_NUMBER

        public static final int ENABLE_HEALTH_MONITORING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IDLE_SHUTDOWN_FIELD_NUMBER

        public static final int IDLE_SHUTDOWN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IDLE_SHUTDOWN_TIMEOUT_FIELD_NUMBER

        public static final int IDLE_SHUTDOWN_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INSTALL_GPU_DRIVER_FIELD_NUMBER

        public static final int INSTALL_GPU_DRIVER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER

        public static final int CUSTOM_GPU_DRIVER_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_STARTUP_SCRIPT_FIELD_NUMBER

        public static final int POST_STARTUP_SCRIPT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPGRADEABLE_FIELD_NUMBER

        public static final int UPGRADEABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • POST_STARTUP_SCRIPT_BEHAVIOR_FIELD_NUMBER

        public static final int POST_STARTUP_SCRIPT_BEHAVIOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_TERMINAL_FIELD_NUMBER

        public static final int DISABLE_TERMINAL_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getNotebookUpgradeSchedule

        public 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;
        Specified by:
        getNotebookUpgradeSchedule in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The notebookUpgradeSchedule.

      • getNotebookUpgradeScheduleBytes

        public 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;
        Specified by:
        getNotebookUpgradeScheduleBytes in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The bytes for notebookUpgradeSchedule.

      • hasEnableHealthMonitoring

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

      • getEnableHealthMonitoring

        public boolean getEnableHealthMonitoring()
         Verifies core internal services are running.
 Default: True
        optional bool enable_health_monitoring = 2;
        Specified by:
        getEnableHealthMonitoring in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The enableHealthMonitoring.

      • hasIdleShutdown

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

      • getIdleShutdown

        public boolean getIdleShutdown()
         Runtime will automatically shutdown after idle_shutdown_time.
 Default: True
        optional bool idle_shutdown = 3;
        Specified by:
        getIdleShutdown in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The idleShutdown.

      • getIdleShutdownTimeout

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

      • getInstallGpuDriver

        public boolean getInstallGpuDriver()
         Install Nvidia Driver automatically.
 Default: True
        bool install_gpu_driver = 5;
        Specified by:
        getInstallGpuDriver in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The installGpuDriver.

      • getCustomGpuDriverPath

        public 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;
        Specified by:
        getCustomGpuDriverPath in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The customGpuDriverPath.

      • getCustomGpuDriverPathBytes

        public 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;
        Specified by:
        getCustomGpuDriverPathBytes in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The bytes for customGpuDriverPath.

      • getPostStartupScript

        public 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;
        Specified by:
        getPostStartupScript in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The postStartupScript.

      • getPostStartupScriptBytes

        public 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;
        Specified by:
        getPostStartupScriptBytes in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The bytes for postStartupScript.

      • getKernelsList

        public 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];
        Specified by:
        getKernelsList in interface RuntimeSoftwareConfigOrBuilder

      • getKernelsCount

        public 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];
        Specified by:
        getKernelsCount in interface RuntimeSoftwareConfigOrBuilder

      • getKernels

        public 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];
        Specified by:
        getKernels in interface RuntimeSoftwareConfigOrBuilder

      • getKernelsOrBuilder

        public 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];
        Specified by:
        getKernelsOrBuilder in interface RuntimeSoftwareConfigOrBuilder

      • hasUpgradeable

        public 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];
        Specified by:
        hasUpgradeable in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        Whether the upgradeable field is set.

      • getUpgradeable

        public 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];
        Specified by:
        getUpgradeable in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The upgradeable.

      • getPostStartupScriptBehaviorValue

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

      • hasDisableTerminal

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

      • getDisableTerminal

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

      • hasVersion

        public 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];
        Specified by:
        hasVersion in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        Whether the version field is set.

      • getVersion

        public 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];
        Specified by:
        getVersion in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The version.

      • getVersionBytes

        public 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];
        Specified by:
        getVersionBytes in interface RuntimeSoftwareConfigOrBuilder
        Returns:
        The bytes for version.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 RuntimeSoftwareConfig parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeSoftwareConfig parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeSoftwareConfig parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeSoftwareConfig parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeSoftwareConfig parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RuntimeSoftwareConfig parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected RuntimeSoftwareConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<RuntimeSoftwareConfig> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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