table_spec.proto 3.0 KB

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