table_spec.proto 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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. syntax = "proto3";
  15. package google.cloud.automl.v1beta1;
  16. import "google/api/resource.proto";
  17. import "google/cloud/automl/v1beta1/io.proto";
  18. import "google/api/annotations.proto";
  19. option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
  20. option java_multiple_files = true;
  21. option java_package = "com.google.cloud.automl.v1beta1";
  22. option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
  23. option ruby_package = "Google::Cloud::AutoML::V1beta1";
  24. // A specification of a relational table.
  25. // The table's schema is represented via its child column specs. It is
  26. // pre-populated as part of ImportData by schema inference algorithm, the
  27. // version of which is a required parameter of ImportData InputConfig.
  28. // Note: While working with a table, at times the schema may be
  29. // inconsistent with the data in the table (e.g. string in a FLOAT64 column).
  30. // The consistency validation is done upon creation of a model.
  31. // Used by:
  32. // * Tables
  33. message TableSpec {
  34. option (google.api.resource) = {
  35. type: "automl.googleapis.com/TableSpec"
  36. pattern: "projects/{project}/locations/{location}/datasets/{dataset}/tableSpecs/{table_spec}"
  37. };
  38. // Output only. The resource name of the table spec.
  39. // Form:
  40. //
  41. // `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/tableSpecs/{table_spec_id}`
  42. string name = 1;
  43. // column_spec_id of the time column. Only used if the parent dataset's
  44. // ml_use_column_spec_id is not set. Used to split rows into TRAIN, VALIDATE
  45. // and TEST sets such that oldest rows go to TRAIN set, newest to TEST, and
  46. // those in between to VALIDATE.
  47. // Required type: TIMESTAMP.
  48. // If both this column and ml_use_column are not set, then ML use of all rows
  49. // will be assigned by AutoML. NOTE: Updates of this field will instantly
  50. // affect any other users concurrently working with the dataset.
  51. string time_column_spec_id = 2;
  52. // Output only. The number of rows (i.e. examples) in the table.
  53. int64 row_count = 3;
  54. // Output only. The number of valid rows (i.e. without values that don't match
  55. // DataType-s of their columns).
  56. int64 valid_row_count = 4;
  57. // Output only. The number of columns of the table. That is, the number of
  58. // child ColumnSpec-s.
  59. int64 column_count = 7;
  60. // Output only. Input configs via which data currently residing in the table
  61. // had been imported.
  62. repeated InputConfig input_configs = 5;
  63. // Used to perform consistent read-modify-write updates. If not set, a blind
  64. // "overwrite" update happens.
  65. string etag = 6;
  66. }