1// Copyright 2020 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.automl.v1beta1;
18
19import "google/api/resource.proto";
20import "google/cloud/automl/v1beta1/data_stats.proto";
21import "google/cloud/automl/v1beta1/data_types.proto";
22
23option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
24option java_multiple_files = true;
25option java_package = "com.google.cloud.automl.v1beta1";
26option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
27option ruby_package = "Google::Cloud::AutoML::V1beta1";
28
29// A representation of a column in a relational table. When listing them, column specs are returned in the same order in which they were
30// given on import .
31// Used by:
32//   *   Tables
33message ColumnSpec {
34  option (google.api.resource) = {
35    type: "automl.googleapis.com/ColumnSpec"
36    pattern: "projects/{project}/locations/{location}/datasets/{dataset}/tableSpecs/{table_spec}/columnSpecs/{column_spec}"
37  };
38
39  // Identifies the table's column, and its correlation with the column this
40  // ColumnSpec describes.
41  message CorrelatedColumn {
42    // The column_spec_id of the correlated column, which belongs to the same
43    // table as the in-context column.
44    string column_spec_id = 1;
45
46    // Correlation between this and the in-context column.
47    CorrelationStats correlation_stats = 2;
48  }
49
50  // Output only. The resource name of the column specs.
51  // Form:
52  //
53  // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}/columnSpecs/{column_spec_id}`
54  string name = 1;
55
56  // The data type of elements stored in the column.
57  DataType data_type = 2;
58
59  // Output only. The name of the column to show in the interface. The name can
60  // be up to 100 characters long and can consist only of ASCII Latin letters
61  // A-Z and a-z, ASCII digits 0-9, underscores(_), and forward slashes(/), and
62  // must start with a letter or a digit.
63  string display_name = 3;
64
65  // Output only. Stats of the series of values in the column.
66  // This field may be stale, see the ancestor's
67  // Dataset.tables_dataset_metadata.stats_update_time field
68  // for the timestamp at which these stats were last updated.
69  DataStats data_stats = 4;
70
71  // Deprecated.
72  repeated CorrelatedColumn top_correlated_columns = 5;
73
74  // Used to perform consistent read-modify-write updates. If not set, a blind
75  // "overwrite" update happens.
76  string etag = 6;
77}
78