xref: /aosp_15_r20/external/googleapis/google/cloud/aiplatform/v1/feature_group.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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/io.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 = "FeatureGroupProto";
28option java_package = "com.google.cloud.aiplatform.v1";
29option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
30option ruby_package = "Google::Cloud::AIPlatform::V1";
31
32// Vertex AI Feature Group.
33message FeatureGroup {
34  option (google.api.resource) = {
35    type: "aiplatform.googleapis.com/FeatureGroup"
36    pattern: "projects/{project}/locations/{location}/featureGroups/{feature_group}"
37    plural: "featureGroups"
38    singular: "featureGroup"
39  };
40
41  // Input source type for BigQuery Tables and Views.
42  message BigQuery {
43    // Required. Immutable. The BigQuery source URI that points to either a
44    // BigQuery Table or View.
45    BigQuerySource big_query_source = 1 [
46      (google.api.field_behavior) = IMMUTABLE,
47      (google.api.field_behavior) = REQUIRED
48    ];
49
50    // Optional. Columns to construct entity_id / row keys.
51    // If not provided defaults to `entity_id`.
52    repeated string entity_id_columns = 2
53        [(google.api.field_behavior) = OPTIONAL];
54  }
55
56  oneof source {
57    // Indicates that features for this group come from BigQuery Table/View.
58    // By default treats the source as a sparse time series source, which is
59    // required to have an entity_id and a feature_timestamp column in the
60    // source.
61    BigQuery big_query = 7;
62  }
63
64  // Identifier. Name of the FeatureGroup. Format:
65  // `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
66  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
67
68  // Output only. Timestamp when this FeatureGroup was created.
69  google.protobuf.Timestamp create_time = 2
70      [(google.api.field_behavior) = OUTPUT_ONLY];
71
72  // Output only. Timestamp when this FeatureGroup was last updated.
73  google.protobuf.Timestamp update_time = 3
74      [(google.api.field_behavior) = OUTPUT_ONLY];
75
76  // Optional. Used to perform consistent read-modify-write updates. If not set,
77  // a blind "overwrite" update happens.
78  string etag = 4 [(google.api.field_behavior) = OPTIONAL];
79
80  // Optional. The labels with user-defined metadata to organize your
81  // FeatureGroup.
82  //
83  // Label keys and values can be no longer than 64 characters
84  // (Unicode codepoints), can only contain lowercase letters, numeric
85  // characters, underscores and dashes. International characters are allowed.
86  //
87  // See https://goo.gl/xmQnxf for more information on and examples of labels.
88  // No more than 64 user labels can be associated with one
89  // FeatureGroup(System labels are excluded)." System reserved label keys
90  // are prefixed with "aiplatform.googleapis.com/" and are immutable.
91  map<string, string> labels = 5 [(google.api.field_behavior) = OPTIONAL];
92
93  // Optional. Description of the FeatureGroup.
94  string description = 6 [(google.api.field_behavior) = OPTIONAL];
95}
96