event.proto 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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/timestamp.proto";
  19. option csharp_namespace = "Google.Cloud.AIPlatform.V1";
  20. option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
  21. option java_multiple_files = true;
  22. option java_outer_classname = "EventProto";
  23. option java_package = "com.google.cloud.aiplatform.v1";
  24. option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
  25. option ruby_package = "Google::Cloud::AIPlatform::V1";
  26. // An edge describing the relationship between an Artifact and an Execution in
  27. // a lineage graph.
  28. message Event {
  29. // Describes whether an Event's Artifact is the Execution's input or output.
  30. enum Type {
  31. // Unspecified whether input or output of the Execution.
  32. TYPE_UNSPECIFIED = 0;
  33. // An input of the Execution.
  34. INPUT = 1;
  35. // An output of the Execution.
  36. OUTPUT = 2;
  37. }
  38. // Required. The relative resource name of the Artifact in the Event.
  39. string artifact = 1 [
  40. (google.api.field_behavior) = REQUIRED,
  41. (google.api.resource_reference) = {
  42. type: "aiplatform.googleapis.com/Artifact"
  43. }
  44. ];
  45. // Output only. The relative resource name of the Execution in the Event.
  46. string execution = 2 [
  47. (google.api.field_behavior) = OUTPUT_ONLY,
  48. (google.api.resource_reference) = {
  49. type: "aiplatform.googleapis.com/Execution"
  50. }
  51. ];
  52. // Output only. Time the Event occurred.
  53. google.protobuf.Timestamp event_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
  54. // Required. The type of the Event.
  55. Type type = 4 [(google.api.field_behavior) = REQUIRED];
  56. // The labels with user-defined metadata to annotate Events.
  57. //
  58. // Label keys and values can be no longer than 64 characters
  59. // (Unicode codepoints), can only contain lowercase letters, numeric
  60. // characters, underscores and dashes. International characters are allowed.
  61. // No more than 64 user labels can be associated with one Event (System
  62. // labels are excluded).
  63. //
  64. // See https://goo.gl/xmQnxf for more information and examples of labels.
  65. // System reserved label keys are prefixed with "aiplatform.googleapis.com/"
  66. // and are immutable.
  67. map<string, string> labels = 5;
  68. }