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.aiplatform.v1; 18 19import "google/api/field_behavior.proto"; 20import "google/api/resource.proto"; 21import "google/cloud/aiplatform/v1/encryption_spec.proto"; 22import "google/protobuf/timestamp.proto"; 23 24option csharp_namespace = "Google.Cloud.AIPlatform.V1"; 25option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb"; 26option java_multiple_files = true; 27option java_outer_classname = "TensorboardProto"; 28option java_package = "com.google.cloud.aiplatform.v1"; 29option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; 30option ruby_package = "Google::Cloud::AIPlatform::V1"; 31 32// Tensorboard is a physical database that stores users' training metrics. 33// A default Tensorboard is provided in each region of a Google Cloud project. 34// If needed users can also create extra Tensorboards in their projects. 35message Tensorboard { 36 option (google.api.resource) = { 37 type: "aiplatform.googleapis.com/Tensorboard" 38 pattern: "projects/{project}/locations/{location}/tensorboards/{tensorboard}" 39 }; 40 41 // Output only. Name of the Tensorboard. 42 // Format: 43 // `projects/{project}/locations/{location}/tensorboards/{tensorboard}` 44 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 45 46 // Required. User provided name of this Tensorboard. 47 string display_name = 2 [(google.api.field_behavior) = REQUIRED]; 48 49 // Description of this Tensorboard. 50 string description = 3; 51 52 // Customer-managed encryption key spec for a Tensorboard. If set, this 53 // Tensorboard and all sub-resources of this Tensorboard will be secured by 54 // this key. 55 EncryptionSpec encryption_spec = 11; 56 57 // Output only. Consumer project Cloud Storage path prefix used to store blob 58 // data, which can either be a bucket or directory. Does not end with a '/'. 59 string blob_storage_path_prefix = 10 60 [(google.api.field_behavior) = OUTPUT_ONLY]; 61 62 // Output only. The number of Runs stored in this Tensorboard. 63 int32 run_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 64 65 // Output only. Timestamp when this Tensorboard was created. 66 google.protobuf.Timestamp create_time = 6 67 [(google.api.field_behavior) = OUTPUT_ONLY]; 68 69 // Output only. Timestamp when this Tensorboard was last updated. 70 google.protobuf.Timestamp update_time = 7 71 [(google.api.field_behavior) = OUTPUT_ONLY]; 72 73 // The labels with user-defined metadata to organize your Tensorboards. 74 // 75 // Label keys and values can be no longer than 64 characters 76 // (Unicode codepoints), can only contain lowercase letters, numeric 77 // characters, underscores and dashes. International characters are allowed. 78 // No more than 64 user labels can be associated with one Tensorboard 79 // (System labels are excluded). 80 // 81 // See https://goo.gl/xmQnxf for more information and examples of labels. 82 // System reserved label keys are prefixed with "aiplatform.googleapis.com/" 83 // and are immutable. 84 map<string, string> labels = 8; 85 86 // Used to perform a consistent read-modify-write updates. If not set, a blind 87 // "overwrite" update happens. 88 string etag = 9; 89 90 // Used to indicate if the TensorBoard instance is the default one. 91 // Each project & region can have at most one default TensorBoard instance. 92 // Creation of a default TensorBoard instance and updating an existing 93 // TensorBoard instance to be default will mark all other TensorBoard 94 // instances (if any) as non default. 95 bool is_default = 12; 96} 97