export_config.proto 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. // Copyright 2021 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.retail.v2alpha;
  16. import "google/protobuf/timestamp.proto";
  17. import "google/rpc/status.proto";
  18. option csharp_namespace = "Google.Cloud.Retail.V2Alpha";
  19. option go_package = "google.golang.org/genproto/googleapis/cloud/retail/v2alpha;retail";
  20. option java_multiple_files = true;
  21. option java_outer_classname = "ExportConfigProto";
  22. option java_package = "com.google.cloud.retail.v2alpha";
  23. option objc_class_prefix = "RETAIL";
  24. option php_namespace = "Google\\Cloud\\Retail\\V2alpha";
  25. option ruby_package = "Google::Cloud::Retail::V2alpha";
  26. // Configuration of destination for Export related errors.
  27. message ExportErrorsConfig {
  28. // Required. Errors destination.
  29. oneof destination {
  30. // Google Cloud Storage path for import errors. This must be an empty,
  31. // existing Cloud Storage bucket. Export errors will be written to a file in
  32. // this bucket, one per line, as a JSON-encoded
  33. // `google.rpc.Status` message.
  34. string gcs_prefix = 1;
  35. }
  36. }
  37. // Metadata related to the progress of the Export operation. This will be
  38. // returned by the google.longrunning.Operation.metadata field.
  39. message ExportMetadata {
  40. // Operation create time.
  41. google.protobuf.Timestamp create_time = 1;
  42. // Operation last update time. If the operation is done, this is also the
  43. // finish time.
  44. google.protobuf.Timestamp update_time = 2;
  45. }
  46. // Response of the ExportProductsRequest. If the long running
  47. // operation is done, then this message is returned by the
  48. // google.longrunning.Operations.response field if the operation was successful.
  49. message ExportProductsResponse {
  50. // A sample of errors encountered while processing the request.
  51. repeated google.rpc.Status error_samples = 1;
  52. // This field is never set.
  53. ExportErrorsConfig errors_config = 2;
  54. // Output result indicating where the data were exported to.
  55. OutputResult output_result = 3;
  56. }
  57. // Response of the ExportUserEventsRequest. If the long running
  58. // operation was successful, then this message is returned by the
  59. // google.longrunning.Operations.response field if the operation was successful.
  60. message ExportUserEventsResponse {
  61. // A sample of errors encountered while processing the request.
  62. repeated google.rpc.Status error_samples = 1;
  63. // This field is never set.
  64. ExportErrorsConfig errors_config = 2;
  65. // Output result indicating where the data were exported to.
  66. OutputResult output_result = 3;
  67. }
  68. // Output result.
  69. message OutputResult {
  70. // Export result in BigQuery.
  71. repeated BigQueryOutputResult bigquery_result = 1;
  72. }
  73. // A BigQuery output result.
  74. message BigQueryOutputResult {
  75. // The ID of a BigQuery Dataset.
  76. string dataset_id = 1;
  77. // The ID of a BigQuery Table.
  78. string table_id = 2;
  79. }