com.google.cloud.notebooks.v1.EnvironmentOrBuilder 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
Proto library for google-cloud-notebooks
The newest version!
/*
 * 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/environment.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.notebooks.v1;

public interface EnvironmentOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v1.Environment)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Output only. Name of this environment.
   * Format:
   * `projects/{project_id}/locations/{location}/environments/{environment_id}`
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Output only. Name of this environment.
   * Format:
   * `projects/{project_id}/locations/{location}/environments/{environment_id}`
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Display name of this environment for the UI.
   * 
   *
   * string display_name = 2;
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Display name of this environment for the UI.
   * 
   *
   * string display_name = 2;
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * A brief description of this environment.
   * 
   *
   * string description = 3;
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * A brief description of this environment.
   * 
   *
   * string description = 3;
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * Use a Compute Engine VM image to start the notebook instance.
   * 
   *
   * .google.cloud.notebooks.v1.VmImage vm_image = 6;
   *
   * @return Whether the vmImage field is set.
   */
  boolean hasVmImage();
  /**
   *
   *
   *    * Use a Compute Engine VM image to start the notebook instance.
   * 
   *
   * .google.cloud.notebooks.v1.VmImage vm_image = 6;
   *
   * @return The vmImage.
   */
  com.google.cloud.notebooks.v1.VmImage getVmImage();
  /**
   *
   *
   *    * Use a Compute Engine VM image to start the notebook instance.
   * 
   *
   * .google.cloud.notebooks.v1.VmImage vm_image = 6;
   */
  com.google.cloud.notebooks.v1.VmImageOrBuilder getVmImageOrBuilder();

  /**
   *
   *
   *    * Use a container image to start the notebook instance.
   * 
   *
   * .google.cloud.notebooks.v1.ContainerImage container_image = 7;
   *
   * @return Whether the containerImage field is set.
   */
  boolean hasContainerImage();
  /**
   *
   *
   *    * Use a container image to start the notebook instance.
   * 
   *
   * .google.cloud.notebooks.v1.ContainerImage container_image = 7;
   *
   * @return The containerImage.
   */
  com.google.cloud.notebooks.v1.ContainerImage getContainerImage();
  /**
   *
   *
   *    * Use a container image to start the notebook instance.
   * 
   *
   * .google.cloud.notebooks.v1.ContainerImage container_image = 7;
   */
  com.google.cloud.notebooks.v1.ContainerImageOrBuilder getContainerImageOrBuilder();

  /**
   *
   *
   *    * 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. Example: `"gs://path-to-file/file-name"`
   * 
   *
   * string post_startup_script = 8;
   *
   * @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. Example: `"gs://path-to-file/file-name"`
   * 
   *
   * string post_startup_script = 8;
   *
   * @return The bytes for postStartupScript.
   */
  com.google.protobuf.ByteString getPostStartupScriptBytes();

  /**
   *
   *
   *    * Output only. The time at which this environment was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   *    * Output only. The time at which this environment was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   *    * Output only. The time at which this environment was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  com.google.cloud.notebooks.v1.Environment.ImageTypeCase getImageTypeCase();
}