-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
trigger.proto
251 lines (213 loc) · 10.2 KB
/
trigger.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.eventarc.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/code.proto";
option go_package = "cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpb";
option java_multiple_files = true;
option java_outer_classname = "TriggerProto";
option java_package = "com.google.cloud.eventarc.v1";
option (google.api.resource_definition) = {
type: "cloudfunctions.googleapis.com/CloudFunction"
pattern: "projects/{project}/locations/{location}/functions/{function}"
};
option (google.api.resource_definition) = {
type: "iam.googleapis.com/ServiceAccount"
pattern: "projects/{project}/serviceAccounts/{service_account}"
};
option (google.api.resource_definition) = {
type: "run.googleapis.com/Service"
pattern: "*"
};
option (google.api.resource_definition) = {
type: "workflows.googleapis.com/Workflow"
pattern: "projects/{project}/locations/{location}/workflows/{workflow}"
};
// A representation of the trigger resource.
message Trigger {
option (google.api.resource) = {
type: "eventarc.googleapis.com/Trigger"
pattern: "projects/{project}/locations/{location}/triggers/{trigger}"
plural: "triggers"
singular: "trigger"
};
// Required. The resource name of the trigger. Must be unique within the location of the
// project and must be in
// `projects/{project}/locations/{location}/triggers/{trigger}` format.
string name = 1 [(google.api.field_behavior) = REQUIRED];
// Output only. Server-assigned unique identifier for the trigger. The value is a UUID4
// string and guaranteed to remain unchanged until the resource is deleted.
string uid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The creation time.
google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last-modified time.
google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Unordered list. The list of filters that applies to event attributes. Only events that
// match all the provided filters are sent to the destination.
repeated EventFilter event_filters = 8 [
(google.api.field_behavior) = UNORDERED_LIST,
(google.api.field_behavior) = REQUIRED
];
// Optional. The IAM service account email associated with the trigger. The
// service account represents the identity of the trigger.
//
// The principal who calls this API must have the `iam.serviceAccounts.actAs`
// permission in the service account. See
// https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common
// for more information.
//
// For Cloud Run destinations, this service account is used to generate
// identity tokens when invoking the service. See
// https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account
// for information on how to invoke authenticated Cloud Run services.
// To create Audit Log triggers, the service account should also
// have the `roles/eventarc.eventReceiver` IAM role.
string service_account = 9 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "iam.googleapis.com/ServiceAccount"
}
];
// Required. Destination specifies where the events should be sent to.
Destination destination = 10 [(google.api.field_behavior) = REQUIRED];
// Optional. To deliver messages, Eventarc might use other GCP
// products as a transport intermediary. This field contains a reference to
// that transport intermediary. This information can be used for debugging
// purposes.
Transport transport = 11 [(google.api.field_behavior) = OPTIONAL];
// Optional. User labels attached to the triggers that can be used to group resources.
map<string, string> labels = 12 [(google.api.field_behavior) = OPTIONAL];
// Optional. The name of the channel associated with the trigger in
// `projects/{project}/locations/{location}/channels/{channel}` format.
// You must provide a channel to receive events from Eventarc SaaS partners.
string channel = 13 [(google.api.field_behavior) = OPTIONAL];
// Output only. The reason(s) why a trigger is in FAILED state.
map<string, StateCondition> conditions = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. This checksum is computed by the server based on the value of other
// fields, and might be sent only on create requests to ensure that the
// client has an up-to-date value before proceeding.
string etag = 99 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Filters events based on exact matches on the CloudEvents attributes.
message EventFilter {
// Required. The name of a CloudEvents attribute. Currently, only a subset of attributes
// are supported for filtering.
//
// All triggers MUST provide a filter for the 'type' attribute.
string attribute = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The value for the attribute.
string value = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. The operator used for matching the events with the value of the
// filter. If not specified, only events that have an exact key-value pair
// specified in the filter are matched. The only allowed value is
// `match-path-pattern`.
string operator = 3 [(google.api.field_behavior) = OPTIONAL];
}
// A condition that is part of the trigger state computation.
message StateCondition {
// The canonical code of the condition.
google.rpc.Code code = 1;
// Human-readable message.
string message = 2;
}
// Represents a target of an invocation over HTTP.
message Destination {
oneof descriptor {
// Cloud Run fully-managed resource that receives the events. The resource
// should be in the same project as the trigger.
CloudRun cloud_run = 1;
// The Cloud Function resource name. Only Cloud Functions V2 is supported.
// Format: `projects/{project}/locations/{location}/functions/{function}`
string cloud_function = 2 [(google.api.resource_reference) = {
type: "cloudfunctions.googleapis.com/CloudFunction"
}];
// A GKE service capable of receiving events. The service should be running
// in the same project as the trigger.
GKE gke = 3;
// The resource name of the Workflow whose Executions are triggered by
// the events. The Workflow resource should be deployed in the same project
// as the trigger.
// Format: `projects/{project}/locations/{location}/workflows/{workflow}`
string workflow = 4 [(google.api.resource_reference) = {
type: "workflows.googleapis.com/Workflow"
}];
}
}
// Represents the transport intermediaries created for the trigger to
// deliver events.
message Transport {
oneof intermediary {
// The Pub/Sub topic and subscription used by Eventarc as a transport
// intermediary.
Pubsub pubsub = 1;
}
}
// Represents a Cloud Run destination.
message CloudRun {
// Required. The name of the Cloud Run service being addressed. See
// https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services.
//
// Only services located in the same project as the trigger object
// can be addressed.
string service = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "run.googleapis.com/Service"
}
];
// Optional. The relative path on the Cloud Run service the events should be sent to.
//
// The value must conform to the definition of a URI path segment (section 3.3
// of RFC2396). Examples: "/route", "route", "route/subroute".
string path = 2 [(google.api.field_behavior) = OPTIONAL];
// Required. The region the Cloud Run service is deployed in.
string region = 3 [(google.api.field_behavior) = REQUIRED];
}
// Represents a GKE destination.
message GKE {
// Required. The name of the cluster the GKE service is running in. The cluster must be
// running in the same project as the trigger being created.
string cluster = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The name of the Google Compute Engine in which the cluster resides, which
// can either be compute zone (for example, us-central1-a) for the zonal
// clusters or region (for example, us-central1) for regional clusters.
string location = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The namespace the GKE service is running in.
string namespace = 3 [(google.api.field_behavior) = REQUIRED];
// Required. Name of the GKE service.
string service = 4 [(google.api.field_behavior) = REQUIRED];
// Optional. The relative path on the GKE service the events should be sent to.
//
// The value must conform to the definition of a URI path segment (section 3.3
// of RFC2396). Examples: "/route", "route", "route/subroute".
string path = 5 [(google.api.field_behavior) = OPTIONAL];
}
// Represents a Pub/Sub transport.
message Pubsub {
// Optional. The name of the Pub/Sub topic created and managed by Eventarc as
// a transport for the event delivery. Format:
// `projects/{PROJECT_ID}/topics/{TOPIC_NAME}`.
//
// You can set an existing topic for triggers of the type
// `google.cloud.pubsub.topic.v1.messagePublished`. The topic you provide
// here is not deleted by Eventarc at trigger deletion.
string topic = 1 [(google.api.field_behavior) = OPTIONAL];
// Output only. The name of the Pub/Sub subscription created and managed by Eventarc
// as a transport for the event delivery. Format:
// `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`.
string subscription = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}