1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.cloud.notebooks.v1; 18 19import "google/api/field_behavior.proto"; 20 21option go_package = "cloud.google.com/go/notebooks/apiv1/notebookspb;notebookspb"; 22option java_multiple_files = true; 23option java_outer_classname = "DiagnosticConfigProto"; 24option java_package = "com.google.cloud.notebooks.v1"; 25 26// Defines flags that are used to run the diagnostic tool 27message DiagnosticConfig { 28 // Required. User Cloud Storage bucket location (REQUIRED). 29 // Must be formatted with path prefix (`gs://$GCS_BUCKET`). 30 // 31 // Permissions: 32 // User Managed Notebooks: 33 // - storage.buckets.writer: Must be given to the project's service account 34 // attached to VM. 35 // Google Managed Notebooks: 36 // - storage.buckets.writer: Must be given to the project's service account or 37 // user credentials attached to VM depending on authentication mode. 38 // 39 // Cloud Storage bucket Log file will be written to 40 // `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz` 41 string gcs_bucket = 1 [(google.api.field_behavior) = REQUIRED]; 42 43 // Optional. Defines the relative storage path in the Cloud Storage bucket 44 // where the diagnostic logs will be written: Default path will be the root 45 // directory of the Cloud Storage bucket 46 // (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) 47 // Example of full path where Log file will be written: 48 // `gs://$GCS_BUCKET/$RELATIVE_PATH/` 49 string relative_path = 2 [(google.api.field_behavior) = OPTIONAL]; 50 51 // Optional. Enables flag to repair service for instance 52 bool repair_flag_enabled = 3 [(google.api.field_behavior) = OPTIONAL]; 53 54 // Optional. Enables flag to capture packets from the instance for 30 seconds 55 bool packet_capture_flag_enabled = 4 [(google.api.field_behavior) = OPTIONAL]; 56 57 // Optional. Enables flag to copy all `/home/jupyter` folder contents 58 bool copy_home_files_flag_enabled = 5 59 [(google.api.field_behavior) = OPTIONAL]; 60} 61