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.v2; 18 19import "google/api/field_behavior.proto"; 20 21option csharp_namespace = "Google.Cloud.Notebooks.V2"; 22option go_package = "cloud.google.com/go/notebooks/apiv2/notebookspb;notebookspb"; 23option java_multiple_files = true; 24option java_outer_classname = "DiagnosticConfigProto"; 25option java_package = "com.google.cloud.notebooks.v2"; 26option php_namespace = "Google\\Cloud\\Notebooks\\V2"; 27option ruby_package = "Google::Cloud::Notebooks::V2"; 28 29// Defines flags that are used to run the diagnostic tool 30message DiagnosticConfig { 31 // Required. User Cloud Storage bucket location (REQUIRED). 32 // Must be formatted with path prefix (`gs://$GCS_BUCKET`). 33 // 34 // Permissions: 35 // User Managed Notebooks: 36 // - storage.buckets.writer: Must be given to the project's service account 37 // attached to VM. 38 // Google Managed Notebooks: 39 // - storage.buckets.writer: Must be given to the project's service account or 40 // user credentials attached to VM depending on authentication mode. 41 // 42 // Cloud Storage bucket Log file will be written to 43 // `gs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz` 44 string gcs_bucket = 1 [(google.api.field_behavior) = REQUIRED]; 45 46 // Optional. Defines the relative storage path in the Cloud Storage bucket 47 // where the diagnostic logs will be written: Default path will be the root 48 // directory of the Cloud Storage bucket 49 // (`gs://$GCS_BUCKET/$DATE_$TIME.tar.gz`) Example of full path where Log file 50 // will be written: `gs://$GCS_BUCKET/$RELATIVE_PATH/` 51 string relative_path = 2 [(google.api.field_behavior) = OPTIONAL]; 52 53 // Optional. Enables flag to repair service for instance 54 bool enable_repair_flag = 3 [(google.api.field_behavior) = OPTIONAL]; 55 56 // Optional. Enables flag to capture packets from the instance for 30 seconds 57 bool enable_packet_capture_flag = 4 [(google.api.field_behavior) = OPTIONAL]; 58 59 // Optional. Enables flag to copy all `/home/jupyter` folder contents 60 bool enable_copy_home_files_flag = 5 [(google.api.field_behavior) = OPTIONAL]; 61} 62