com.google.cloud.notebooks.v2.DiagnosticConfigOrBuilder 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-v2 Show documentation
Proto library for google-cloud-notebooks
There is a newer version: 1.53.0
Show newest version
/*
 * Copyright 2023 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/v2/diagnostic_config.proto

package com.google.cloud.notebooks.v2;

public interface DiagnosticConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v2.DiagnosticConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. User Cloud Storage bucket location (REQUIRED).
   * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
   *
   * Permissions:
   * User Managed Notebooks:
   * - storage.buckets.writer: Must be given to the project's service account
   *   attached to VM.
   * Google Managed Notebooks:
   * - storage.buckets.writer: Must be given to the project's service account or
   *   user credentials attached to VM depending on authentication mode.
   *
   * Cloud Storage bucket Log file will be written to
   * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
   * 
   *
   * string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The gcsBucket.
   */
  java.lang.String getGcsBucket();
  /**
   *
   *
   *    * Required. User Cloud Storage bucket location (REQUIRED).
   * Must be formatted with path prefix (`gs://$GCS_BUCKET`).
   *
   * Permissions:
   * User Managed Notebooks:
   * - storage.buckets.writer: Must be given to the project's service account
   *   attached to VM.
   * Google Managed Notebooks:
   * - storage.buckets.writer: Must be given to the project's service account or
   *   user credentials attached to VM depending on authentication mode.
   *
   * Cloud Storage bucket Log file will be written to
   * `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz`
   * 
   *
   * string gcs_bucket = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for gcsBucket.
   */
  com.google.protobuf.ByteString getGcsBucketBytes();

  /**
   *
   *
   *    * Optional. Defines the relative storage path in the Cloud Storage bucket
   * where the diagnostic logs will be written: Default path will be the root
   * directory of the Cloud Storage bucket
   * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file
   * will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
   * 
   *
   * string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The relativePath.
   */
  java.lang.String getRelativePath();
  /**
   *
   *
   *    * Optional. Defines the relative storage path in the Cloud Storage bucket
   * where the diagnostic logs will be written: Default path will be the root
   * directory of the Cloud Storage bucket
   * (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file
   * will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/`
   * 
   *
   * string relative_path = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for relativePath.
   */
  com.google.protobuf.ByteString getRelativePathBytes();

  /**
   *
   *
   *    * Optional. Enables flag to repair service for instance
   * 
   *
   * bool enable_repair_flag = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The enableRepairFlag.
   */
  boolean getEnableRepairFlag();

  /**
   *
   *
   *    * Optional. Enables flag to capture packets from the instance for 30 seconds
   * 
   *
   * bool enable_packet_capture_flag = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The enablePacketCaptureFlag.
   */
  boolean getEnablePacketCaptureFlag();

  /**
   *
   *
   *    * Optional. Enables flag to copy all `/home/jupyter` folder contents
   * 
   *
   * bool enable_copy_home_files_flag = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The enableCopyHomeFilesFlag.
   */
  boolean getEnableCopyHomeFilesFlag();
}