data_item.proto 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. // Copyright 2022 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.aiplatform.v1;
  16. import "google/api/field_behavior.proto";
  17. import "google/api/resource.proto";
  18. import "google/protobuf/struct.proto";
  19. import "google/protobuf/timestamp.proto";
  20. option csharp_namespace = "Google.Cloud.AIPlatform.V1";
  21. option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
  22. option java_multiple_files = true;
  23. option java_outer_classname = "DataItemProto";
  24. option java_package = "com.google.cloud.aiplatform.v1";
  25. option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
  26. option ruby_package = "Google::Cloud::AIPlatform::V1";
  27. // A piece of data in a Dataset. Could be an image, a video, a document or plain
  28. // text.
  29. message DataItem {
  30. option (google.api.resource) = {
  31. type: "aiplatform.googleapis.com/DataItem"
  32. pattern: "projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}"
  33. };
  34. // Output only. The resource name of the DataItem.
  35. string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  36. // Output only. Timestamp when this DataItem was created.
  37. google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  38. // Output only. Timestamp when this DataItem was last updated.
  39. google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
  40. // Optional. The labels with user-defined metadata to organize your DataItems.
  41. //
  42. // Label keys and values can be no longer than 64 characters
  43. // (Unicode codepoints), can only contain lowercase letters, numeric
  44. // characters, underscores and dashes. International characters are allowed.
  45. // No more than 64 user labels can be associated with one DataItem(System
  46. // labels are excluded).
  47. //
  48. // See https://goo.gl/xmQnxf for more information and examples of labels.
  49. // System reserved label keys are prefixed with "aiplatform.googleapis.com/"
  50. // and are immutable.
  51. map<string, string> labels = 3 [(google.api.field_behavior) = OPTIONAL];
  52. // Required. The data that the DataItem represents (for example, an image or a text
  53. // snippet). The schema of the payload is stored in the parent Dataset's
  54. // [metadata schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] dataItemSchemaUri field.
  55. google.protobuf.Value payload = 4 [(google.api.field_behavior) = REQUIRED];
  56. // Optional. Used to perform consistent read-modify-write updates. If not set, a blind
  57. // "overwrite" update happens.
  58. string etag = 7 [(google.api.field_behavior) = OPTIONAL];
  59. }