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/timestamp.proto";
22
23option csharp_namespace = "Google.Cloud.AIPlatform.V1";
24option go_package = "cloud.google.com/go/aiplatform/apiv1/aiplatformpb;aiplatformpb";
25option java_multiple_files = true;
26option java_outer_classname = "AnnotationSpecProto";
27option java_package = "com.google.cloud.aiplatform.v1";
28option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
29option ruby_package = "Google::Cloud::AIPlatform::V1";
30
31// Identifies a concept with which DataItems may be annotated with.
32message AnnotationSpec {
33  option (google.api.resource) = {
34    type: "aiplatform.googleapis.com/AnnotationSpec"
35    pattern: "projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}"
36  };
37
38  // Output only. Resource name of the AnnotationSpec.
39  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
40
41  // Required. The user-defined name of the AnnotationSpec.
42  // The name can be up to 128 characters long and can consist of any UTF-8
43  // characters.
44  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
45
46  // Output only. Timestamp when this AnnotationSpec was created.
47  google.protobuf.Timestamp create_time = 3
48      [(google.api.field_behavior) = OUTPUT_ONLY];
49
50  // Output only. Timestamp when AnnotationSpec was last updated.
51  google.protobuf.Timestamp update_time = 4
52      [(google.api.field_behavior) = OUTPUT_ONLY];
53
54  // Optional. Used to perform consistent read-modify-write updates. If not set,
55  // a blind "overwrite" update happens.
56  string etag = 5 [(google.api.field_behavior) = OPTIONAL];
57}
58