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/protobuf/struct.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 = "SavedQueryProto"; 28option java_package = "com.google.cloud.aiplatform.v1"; 29option php_namespace = "Google\\Cloud\\AIPlatform\\V1"; 30option ruby_package = "Google::Cloud::AIPlatform::V1"; 31 32// A SavedQuery is a view of the dataset. It references a subset of annotations 33// by problem type and filters. 34message SavedQuery { 35 option (google.api.resource) = { 36 type: "aiplatform.googleapis.com/SavedQuery" 37 pattern: "projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}" 38 }; 39 40 // Output only. Resource name of the SavedQuery. 41 string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 42 43 // Required. The user-defined name of the SavedQuery. 44 // The name can be up to 128 characters long and can consist of any UTF-8 45 // characters. 46 string display_name = 2 [(google.api.field_behavior) = REQUIRED]; 47 48 // Some additional information about the SavedQuery. 49 google.protobuf.Value metadata = 12; 50 51 // Output only. Timestamp when this SavedQuery was created. 52 google.protobuf.Timestamp create_time = 3 53 [(google.api.field_behavior) = OUTPUT_ONLY]; 54 55 // Output only. Timestamp when SavedQuery was last updated. 56 google.protobuf.Timestamp update_time = 4 57 [(google.api.field_behavior) = OUTPUT_ONLY]; 58 59 // Output only. Filters on the Annotations in the dataset. 60 string annotation_filter = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 61 62 // Required. Problem type of the SavedQuery. 63 // Allowed values: 64 // 65 // * IMAGE_CLASSIFICATION_SINGLE_LABEL 66 // * IMAGE_CLASSIFICATION_MULTI_LABEL 67 // * IMAGE_BOUNDING_POLY 68 // * IMAGE_BOUNDING_BOX 69 // * TEXT_CLASSIFICATION_SINGLE_LABEL 70 // * TEXT_CLASSIFICATION_MULTI_LABEL 71 // * TEXT_EXTRACTION 72 // * TEXT_SENTIMENT 73 // * VIDEO_CLASSIFICATION 74 // * VIDEO_OBJECT_TRACKING 75 string problem_type = 6 [(google.api.field_behavior) = REQUIRED]; 76 77 // Output only. Number of AnnotationSpecs in the context of the SavedQuery. 78 int32 annotation_spec_count = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; 79 80 // Used to perform a consistent read-modify-write update. If not set, a blind 81 // "overwrite" update happens. 82 string etag = 8; 83 84 // Output only. If the Annotations belonging to the SavedQuery can be used for 85 // AutoML training. 86 bool support_automl_training = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; 87} 88