• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// Copyright 2023 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
15syntax = "proto3";
16
17package google.firestore.v1beta1;
18
19import "google/protobuf/timestamp.proto";
20
21option csharp_namespace = "Google.Cloud.Firestore.V1Beta1";
22option go_package = "cloud.google.com/go/firestore/apiv1beta1/firestorepb;firestorepb";
23option java_multiple_files = true;
24option java_outer_classname = "UndeliverableFirstGenEventProto";
25option java_package = "com.google.firestore.v1beta1";
26option php_namespace = "Google\\Cloud\\Firestore\\V1beta1";
27option ruby_package = "Google::Cloud::Firestore::V1beta1";
28
29// A message signifying an event that cannot be delivered to Cloud Functions
30// from Firestore using [Cloud Firestore triggers 1st
31// gen](https://cloud.google.com/functions/docs/calling/cloud-firestore)
32message UndeliverableFirstGenEvent {
33  // Reason for events being undeliverable.
34  enum Reason {
35    // Unspecified.
36    REASON_UNSPECIFIED = 0;
37
38    // Exceeding maximum event size limit
39    EXCEEDING_SIZE_LIMIT = 1;
40  }
41
42  // Document change type.
43  enum DocumentChangeType {
44    // Unspecified.
45    DOCUMENT_CHANGE_TYPE_UNSPECIFIED = 0;
46
47    // Represent creation operation.
48    CREATE = 1;
49
50    // Represent delete operation.
51    DELETE = 2;
52
53    // Represent update operation.
54    UPDATE = 3;
55  }
56
57  // Error message for events being undeliverable.
58  string message = 1;
59
60  // Reason for events being undeliverable.
61  Reason reason = 2;
62
63  // The resource name of the changed document, in the format of
64  // `projects/{projectId}/databases/{databaseId}/documents/{document_path}`.
65  string document_name = 3;
66
67  // The type of the document change.
68  DocumentChangeType document_change_type = 4;
69
70  // The names of the functions that were supposed to be triggered.
71  repeated string function_name = 5;
72
73  // The commit time of triggered write operation.
74  google.protobuf.Timestamp triggered_time = 6;
75}
76