google.cloud.notebooks.v1.diagnostic_config.proto 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
//
//     http://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.

syntax = "proto3";

package google.cloud.notebooks.v1;

import "google/api/field_behavior.proto";

option go_package = "cloud.google.com/go/notebooks/apiv1/notebookspb;notebookspb";
option java_multiple_files = true;
option java_outer_classname = "DiagnosticConfigProto";
option java_package = "com.google.cloud.notebooks.v1";

// Defines flags that are used to run the diagnostic tool
message DiagnosticConfig {
  // 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];

  // 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];

  // Optional. Enables flag to repair service for instance
  bool repair_flag_enabled = 3 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Enables flag to capture packets from the instance for 30 seconds
  bool packet_capture_flag_enabled = 4 [(google.api.field_behavior) = OPTIONAL];

  // Optional. Enables flag to copy all `/home/jupyter` folder contents
  bool copy_home_files_flag_enabled = 5
      [(google.api.field_behavior) = OPTIONAL];
}