com.google.cloud.notebooks.v1.RuntimeSoftwareConfigOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Proto library for google-cloud-notebooks
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/notebooks/v1/runtime.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.notebooks.v1;
public interface RuntimeSoftwareConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v1.RuntimeSoftwareConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The notebookUpgradeSchedule.
*/
java.lang.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;
*
* @return The bytes for notebookUpgradeSchedule.
*/
com.google.protobuf.ByteString getNotebookUpgradeScheduleBytes();
/**
*
*
*
* Verifies core internal services are running.
* Default: True
*
*
* optional bool enable_health_monitoring = 2;
*
* @return Whether the enableHealthMonitoring field is set.
*/
boolean hasEnableHealthMonitoring();
/**
*
*
*
* Verifies core internal services are running.
* Default: True
*
*
* optional bool enable_health_monitoring = 2;
*
* @return The enableHealthMonitoring.
*/
boolean getEnableHealthMonitoring();
/**
*
*
*
* Runtime will automatically shutdown after idle_shutdown_time.
* Default: True
*
*
* optional bool idle_shutdown = 3;
*
* @return Whether the idleShutdown field is set.
*/
boolean hasIdleShutdown();
/**
*
*
*
* Runtime will automatically shutdown after idle_shutdown_time.
* Default: True
*
*
* optional bool idle_shutdown = 3;
*
* @return The idleShutdown.
*/
boolean getIdleShutdown();
/**
*
*
*
* Time in minutes to wait before shutting down runtime. Default: 180 minutes
*
*
* int32 idle_shutdown_timeout = 4;
*
* @return The idleShutdownTimeout.
*/
int getIdleShutdownTimeout();
/**
*
*
*
* Install Nvidia Driver automatically.
* Default: True
*
*
* bool install_gpu_driver = 5;
*
* @return The installGpuDriver.
*/
boolean getInstallGpuDriver();
/**
*
*
*
* 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;
*
* @return The customGpuDriverPath.
*/
java.lang.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;
*
* @return The bytes for customGpuDriverPath.
*/
com.google.protobuf.ByteString getCustomGpuDriverPathBytes();
/**
*
*
*
* 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;
*
* @return The postStartupScript.
*/
java.lang.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;
*
* @return The bytes for postStartupScript.
*/
com.google.protobuf.ByteString getPostStartupScriptBytes();
/**
*
*
*
* 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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.notebooks.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.notebooks.v1.ContainerImageOrBuilder getKernelsOrBuilder(int index);
/**
*
*
*
* Output only. Bool indicating whether an newer image is available in an image family.
*
*
* optional bool upgradeable = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return Whether the upgradeable field is set.
*/
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];
*
* @return The upgradeable.
*/
boolean getUpgradeable();
/**
*
*
*
* Behavior for the post startup script.
*
*
*
* .google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
*
*
* @return The enum numeric value on the wire for postStartupScriptBehavior.
*/
int getPostStartupScriptBehaviorValue();
/**
*
*
*
* Behavior for the post startup script.
*
*
*
* .google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior post_startup_script_behavior = 10;
*
*
* @return The postStartupScriptBehavior.
*/
com.google.cloud.notebooks.v1.RuntimeSoftwareConfig.PostStartupScriptBehavior
getPostStartupScriptBehavior();
/**
*
*
*
* Bool indicating whether JupyterLab terminal will be available or not.
* Default: False
*
*
* optional bool disable_terminal = 11;
*
* @return Whether the disableTerminal field is set.
*/
boolean hasDisableTerminal();
/**
*
*
*
* Bool indicating whether JupyterLab terminal will be available or not.
* Default: False
*
*
* optional bool disable_terminal = 11;
*
* @return The disableTerminal.
*/
boolean getDisableTerminal();
/**
*
*
*
* 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];
*
* @return Whether the version field is set.
*/
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];
*
* @return The version.
*/
java.lang.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];
*
* @return The bytes for version.
*/
com.google.protobuf.ByteString getVersionBytes();
}