-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
eventarc.proto
632 lines (541 loc) · 22 KB
/
eventarc.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
// 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/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/eventarc/v1/channel.proto";
import "google/cloud/eventarc/v1/channel_connection.proto";
import "google/cloud/eventarc/v1/discovery.proto";
import "google/cloud/eventarc/v1/google_channel_config.proto";
import "google/cloud/eventarc/v1/trigger.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Eventarc.V1";
option go_package = "cloud.google.com/go/eventarc/apiv1/eventarcpb;eventarcpb";
option java_multiple_files = true;
option java_outer_classname = "EventarcProto";
option java_package = "com.google.cloud.eventarc.v1";
option php_namespace = "Google\\Cloud\\Eventarc\\V1";
option ruby_package = "Google::Cloud::Eventarc::V1";
// Eventarc allows users to subscribe to various events that are provided by
// Google Cloud services and forward them to supported destinations.
service Eventarc {
option (google.api.default_host) = "eventarc.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
// Get a single trigger.
rpc GetTrigger(GetTriggerRequest) returns (Trigger) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/triggers/*}"
};
option (google.api.method_signature) = "name";
}
// List triggers.
rpc ListTriggers(ListTriggersRequest) returns (ListTriggersResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/triggers"
};
option (google.api.method_signature) = "parent";
}
// Create a new trigger in a particular project and location.
rpc CreateTrigger(CreateTriggerRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/triggers"
body: "trigger"
};
option (google.api.method_signature) = "parent,trigger,trigger_id";
option (google.longrunning.operation_info) = {
response_type: "Trigger"
metadata_type: "OperationMetadata"
};
}
// Update a single trigger.
rpc UpdateTrigger(UpdateTriggerRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{trigger.name=projects/*/locations/*/triggers/*}"
body: "trigger"
};
option (google.api.method_signature) = "trigger,update_mask,allow_missing";
option (google.longrunning.operation_info) = {
response_type: "Trigger"
metadata_type: "OperationMetadata"
};
}
// Delete a single trigger.
rpc DeleteTrigger(DeleteTriggerRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/triggers/*}"
};
option (google.api.method_signature) = "name,allow_missing";
option (google.longrunning.operation_info) = {
response_type: "Trigger"
metadata_type: "OperationMetadata"
};
}
// Get a single Channel.
rpc GetChannel(GetChannelRequest) returns (Channel) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/channels/*}"
};
option (google.api.method_signature) = "name";
}
// List channels.
rpc ListChannels(ListChannelsRequest) returns (ListChannelsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/channels"
};
option (google.api.method_signature) = "parent";
}
// Create a new channel in a particular project and location.
rpc CreateChannel(CreateChannelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/channels"
body: "channel"
};
option (google.api.method_signature) = "parent,channel,channel_id";
option (google.longrunning.operation_info) = {
response_type: "Channel"
metadata_type: "OperationMetadata"
};
}
// Update a single channel.
rpc UpdateChannel(UpdateChannelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{channel.name=projects/*/locations/*/channels/*}"
body: "channel"
};
option (google.api.method_signature) = "channel,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Channel"
metadata_type: "OperationMetadata"
};
}
// Delete a single channel.
rpc DeleteChannel(DeleteChannelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/channels/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "Channel"
metadata_type: "OperationMetadata"
};
}
// Get a single Provider.
rpc GetProvider(GetProviderRequest) returns (Provider) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/providers/*}"
};
option (google.api.method_signature) = "name";
}
// List providers.
rpc ListProviders(ListProvidersRequest) returns (ListProvidersResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/providers"
};
option (google.api.method_signature) = "parent";
}
// Get a single ChannelConnection.
rpc GetChannelConnection(GetChannelConnectionRequest) returns (ChannelConnection) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/channelConnections/*}"
};
option (google.api.method_signature) = "name";
}
// List channel connections.
rpc ListChannelConnections(ListChannelConnectionsRequest) returns (ListChannelConnectionsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/channelConnections"
};
option (google.api.method_signature) = "parent";
}
// Create a new ChannelConnection in a particular project and location.
rpc CreateChannelConnection(CreateChannelConnectionRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/channelConnections"
body: "channel_connection"
};
option (google.api.method_signature) = "parent,channel_connection,channel_connection_id";
option (google.longrunning.operation_info) = {
response_type: "ChannelConnection"
metadata_type: "OperationMetadata"
};
}
// Delete a single ChannelConnection.
rpc DeleteChannelConnection(DeleteChannelConnectionRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/channelConnections/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "ChannelConnection"
metadata_type: "OperationMetadata"
};
}
// Get a GoogleChannelConfig
rpc GetGoogleChannelConfig(GetGoogleChannelConfigRequest) returns (GoogleChannelConfig) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/googleChannelConfig}"
};
option (google.api.method_signature) = "name";
}
// Update a single GoogleChannelConfig
rpc UpdateGoogleChannelConfig(UpdateGoogleChannelConfigRequest) returns (GoogleChannelConfig) {
option (google.api.http) = {
patch: "/v1/{google_channel_config.name=projects/*/locations/*/googleChannelConfig}"
body: "google_channel_config"
};
option (google.api.method_signature) = "google_channel_config,update_mask";
}
}
// The request message for the GetTrigger method.
message GetTriggerRequest {
// Required. The name of the trigger to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/Trigger"
}
];
}
// The request message for the ListTriggers method.
message ListTriggersRequest {
// Required. The parent collection to list triggers on.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/Trigger"
}
];
// The maximum number of triggers to return on each page.
//
// Note: The service may send fewer.
int32 page_size = 2;
// The page token; provide the value from the `next_page_token` field in a
// previous `ListTriggers` call to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListTriggers` must match
// the call that provided the page token.
string page_token = 3;
// The sorting order of the resources returned. Value should be a
// comma-separated list of fields. The default sorting order is ascending. To
// specify descending order for a field, append a `desc` suffix; for example:
// `name desc, trigger_id`.
string order_by = 4;
// Filter field. Used to filter the Triggers to be listed. Possible filters
// are described in https://google.aip.dev/160. For example, using
// "?filter=destination:gke" would list only Triggers with a gke destination.
string filter = 5;
}
// The response message for the `ListTriggers` method.
message ListTriggersResponse {
// The requested triggers, up to the number specified in `page_size`.
repeated Trigger triggers = 1;
// A page token that can be sent to `ListTriggers` to request the next page.
// If this is empty, then there are no more pages.
string next_page_token = 2;
// Unreachable resources, if any.
repeated string unreachable = 3;
}
// The request message for the CreateTrigger method.
message CreateTriggerRequest {
// Required. The parent collection in which to add this trigger.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/Trigger"
}
];
// Required. The trigger to create.
Trigger trigger = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The user-provided ID to be assigned to the trigger.
string trigger_id = 3 [(google.api.field_behavior) = REQUIRED];
// Required. If set, validate the request and preview the review, but do not
// post it.
bool validate_only = 4 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the UpdateTrigger method.
message UpdateTriggerRequest {
// The trigger to be updated.
Trigger trigger = 1;
// The fields to be updated; only fields explicitly provided are updated.
// If no field mask is provided, all provided fields in the request are
// updated. To update all fields, provide a field mask of "*".
google.protobuf.FieldMask update_mask = 2;
// If set to true, and the trigger is not found, a new trigger will be
// created. In this situation, `update_mask` is ignored.
bool allow_missing = 3;
// Required. If set, validate the request and preview the review, but do not
// post it.
bool validate_only = 4 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the DeleteTrigger method.
message DeleteTriggerRequest {
// Required. The name of the trigger to be deleted.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/Trigger"
}
];
// If provided, the trigger will only be deleted if the etag matches the
// current etag on the resource.
string etag = 2;
// If set to true, and the trigger is not found, the request will succeed
// but no action will be taken on the server.
bool allow_missing = 3;
// Required. If set, validate the request and preview the review, but do not
// post it.
bool validate_only = 4 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the GetChannel method.
message GetChannelRequest {
// Required. The name of the channel to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/Channel"
}
];
}
// The request message for the ListChannels method.
message ListChannelsRequest {
// Required. The parent collection to list channels on.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/Channel"
}
];
// The maximum number of channels to return on each page.
//
// Note: The service may send fewer.
int32 page_size = 2;
// The page token; provide the value from the `next_page_token` field in a
// previous `ListChannels` call to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListChannels` must
// match the call that provided the page token.
string page_token = 3;
// The sorting order of the resources returned. Value should be a
// comma-separated list of fields. The default sorting order is ascending. To
// specify descending order for a field, append a `desc` suffix; for example:
// `name desc, channel_id`.
string order_by = 4;
}
// The response message for the `ListChannels` method.
message ListChannelsResponse {
// The requested channels, up to the number specified in `page_size`.
repeated Channel channels = 1;
// A page token that can be sent to `ListChannels` to request the next page.
// If this is empty, then there are no more pages.
string next_page_token = 2;
// Unreachable resources, if any.
repeated string unreachable = 3;
}
// The request message for the CreateChannel method.
message CreateChannelRequest {
// Required. The parent collection in which to add this channel.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/Channel"
}
];
// Required. The channel to create.
Channel channel = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The user-provided ID to be assigned to the channel.
string channel_id = 3 [(google.api.field_behavior) = REQUIRED];
// Required. If set, validate the request and preview the review, but do not
// post it.
bool validate_only = 4 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the UpdateChannel method.
message UpdateChannelRequest {
// The channel to be updated.
Channel channel = 1;
// The fields to be updated; only fields explicitly provided are updated.
// If no field mask is provided, all provided fields in the request are
// updated. To update all fields, provide a field mask of "*".
google.protobuf.FieldMask update_mask = 2;
// Required. If set, validate the request and preview the review, but do not
// post it.
bool validate_only = 3 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the DeleteChannel method.
message DeleteChannelRequest {
// Required. The name of the channel to be deleted.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/Channel"
}
];
// Required. If set, validate the request and preview the review, but do not
// post it.
bool validate_only = 2 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the GetProvider method.
message GetProviderRequest {
// Required. The name of the provider to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/Provider"
}
];
}
// The request message for the ListProviders method.
message ListProvidersRequest {
// Required. The parent of the provider to get.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/Provider"
}
];
// The maximum number of providers to return on each page.
int32 page_size = 2;
// The page token; provide the value from the `next_page_token` field in a
// previous `ListProviders` call to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListProviders` must
// match the call that provided the page token.
string page_token = 3;
// The sorting order of the resources returned. Value should be a
// comma-separated list of fields. The default sorting oder is ascending. To
// specify descending order for a field, append a `desc` suffix; for example:
// `name desc, _id`.
string order_by = 4;
// The filter field that the list request will filter on.
string filter = 5;
}
// The response message for the `ListProviders` method.
message ListProvidersResponse {
// The requested providers, up to the number specified in `page_size`.
repeated Provider providers = 1;
// A page token that can be sent to `ListProviders` to request the next page.
// If this is empty, then there are no more pages.
string next_page_token = 2;
// Unreachable resources, if any.
repeated string unreachable = 3;
}
// The request message for the GetChannelConnection method.
message GetChannelConnectionRequest {
// Required. The name of the channel connection to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/ChannelConnection"
}
];
}
// The request message for the ListChannelConnections method.
message ListChannelConnectionsRequest {
// Required. The parent collection from which to list channel connections.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/ChannelConnection"
}
];
// The maximum number of channel connections to return on each page.
//
// Note: The service may send fewer responses.
int32 page_size = 2;
// The page token; provide the value from the `next_page_token` field in a
// previous `ListChannelConnections` call to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListChannelConnetions`
// match the call that provided the page token.
string page_token = 3;
}
// The response message for the `ListChannelConnections` method.
message ListChannelConnectionsResponse {
// The requested channel connections, up to the number specified in
// `page_size`.
repeated ChannelConnection channel_connections = 1;
// A page token that can be sent to `ListChannelConnections` to request the
// next page.
// If this is empty, then there are no more pages.
string next_page_token = 2;
// Unreachable resources, if any.
repeated string unreachable = 3;
}
// The request message for the CreateChannelConnection method.
message CreateChannelConnectionRequest {
// Required. The parent collection in which to add this channel connection.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "eventarc.googleapis.com/ChannelConnection"
}
];
// Required. Channel connection to create.
ChannelConnection channel_connection = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The user-provided ID to be assigned to the channel connection.
string channel_connection_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// The request message for the DeleteChannelConnection method.
message DeleteChannelConnectionRequest {
// Required. The name of the channel connection to delete.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/ChannelConnection"
}
];
}
// The request message for the UpdateGoogleChannelConfig method.
message UpdateGoogleChannelConfigRequest {
// Required. The config to be updated.
GoogleChannelConfig google_channel_config = 1 [(google.api.field_behavior) = REQUIRED];
// The fields to be updated; only fields explicitly provided are updated.
// If no field mask is provided, all provided fields in the request are
// updated. To update all fields, provide a field mask of "*".
google.protobuf.FieldMask update_mask = 2;
}
// The request message for the GetGoogleChannelConfig method.
message GetGoogleChannelConfigRequest {
// Required. The name of the config to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "eventarc.googleapis.com/GoogleChannelConfig"
}
];
}
// Represents the metadata of the long-running operation.
message OperationMetadata {
// Output only. The time the operation was created.
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Server-defined resource path for the target of the operation.
string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Name of the verb executed by the operation.
string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Human-readable status of the operation, if any.
string status_message = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
// have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
// corresponding to `Code.CANCELLED`.
bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. API version used to start the operation.
string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
}