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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.connections.html">connections</a> . <a href="connectors_v1.projects.locations.connections.eventSubscriptions.html">eventSubscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, eventSubscriptionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new EventSubscription in a given project,location and connection.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single EventSubscription.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single EventSubscription.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List EventSubscriptions in a given project,location and connection.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single EventSubscription.</p>
<p class="toc_element">
<code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RetryEventSubscription retries the registration of Subscription.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, eventSubscriptionId=None, x__xgafv=None)</code>
<pre>Creates a new EventSubscription in a given project,location and connection.
Args:
parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
body: object, The request body.
The object takes the form of:
{ # represents the Connector's EventSubscription resource
"createTime": "A String", # Output only. Created time.
"destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
"endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
"endpointUri": "A String", # Optional. The URI of the Endpoint.
"headers": [ # Optional. List of Header to be added to the Endpoint.
{ # Header details for a given header to be added to Endpoint.
"key": "A String", # Optional. Key of Header.
"value": "A String", # Optional. Value of Header.
},
],
},
"pubsub": { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
"attributes": { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
"a_key": "A String",
},
"configVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"projectId": "A String", # Required. The project id which has the Pub/Sub topic.
"topicId": "A String", # Required. The topic id of the Pub/Sub topic.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to trigger IP workflow.
"type": "A String", # Optional. type of the destination
},
"eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
"jms": { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
"name": "A String", # Optional. Name of the JMS source. i.e. queueName or topicName
"type": "A String", # Optional. Type of the JMS Source. i.e. Queue or Topic
},
"name": "A String", # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
"status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
"description": "A String", # Output only. Description of the state.
"state": "A String", # Output only. State of Event Subscription resource.
},
"subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
"subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
"triggerConfigVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"updateTime": "A String", # Output only. Updated time.
}
eventSubscriptionId: string, Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a single EventSubscription.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single EventSubscription.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # represents the Connector's EventSubscription resource
"createTime": "A String", # Output only. Created time.
"destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
"endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
"endpointUri": "A String", # Optional. The URI of the Endpoint.
"headers": [ # Optional. List of Header to be added to the Endpoint.
{ # Header details for a given header to be added to Endpoint.
"key": "A String", # Optional. Key of Header.
"value": "A String", # Optional. Value of Header.
},
],
},
"pubsub": { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
"attributes": { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
"a_key": "A String",
},
"configVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"projectId": "A String", # Required. The project id which has the Pub/Sub topic.
"topicId": "A String", # Required. The topic id of the Pub/Sub topic.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to trigger IP workflow.
"type": "A String", # Optional. type of the destination
},
"eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
"jms": { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
"name": "A String", # Optional. Name of the JMS source. i.e. queueName or topicName
"type": "A String", # Optional. Type of the JMS Source. i.e. Queue or Topic
},
"name": "A String", # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
"status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
"description": "A String", # Output only. Description of the state.
"state": "A String", # Output only. State of Event Subscription resource.
},
"subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
"subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
"triggerConfigVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"updateTime": "A String", # Output only. Updated time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List EventSubscriptions in a given project,location and connection.
Args:
parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
filter: string, Filter.
orderBy: string, Order by parameters.
pageSize: integer, Page size.
pageToken: string, Page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ConnectorsService.ListEventSubscriptions
"eventSubscriptions": [ # Subscriptions.
{ # represents the Connector's EventSubscription resource
"createTime": "A String", # Output only. Created time.
"destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
"endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
"endpointUri": "A String", # Optional. The URI of the Endpoint.
"headers": [ # Optional. List of Header to be added to the Endpoint.
{ # Header details for a given header to be added to Endpoint.
"key": "A String", # Optional. Key of Header.
"value": "A String", # Optional. Value of Header.
},
],
},
"pubsub": { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
"attributes": { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
"a_key": "A String",
},
"configVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"projectId": "A String", # Required. The project id which has the Pub/Sub topic.
"topicId": "A String", # Required. The topic id of the Pub/Sub topic.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to trigger IP workflow.
"type": "A String", # Optional. type of the destination
},
"eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
"jms": { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
"name": "A String", # Optional. Name of the JMS source. i.e. queueName or topicName
"type": "A String", # Optional. Type of the JMS Source. i.e. Queue or Topic
},
"name": "A String", # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
"status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
"description": "A String", # Output only. Description of the state.
"state": "A String", # Output only. State of Event Subscription resource.
},
"subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
"subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
"triggerConfigVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"updateTime": "A String", # Output only. Updated time.
},
],
"nextPageToken": "A String", # Next page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single EventSubscription.
Args:
name: string, Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} (required)
body: object, The request body.
The object takes the form of:
{ # represents the Connector's EventSubscription resource
"createTime": "A String", # Output only. Created time.
"destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
"endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
"endpointUri": "A String", # Optional. The URI of the Endpoint.
"headers": [ # Optional. List of Header to be added to the Endpoint.
{ # Header details for a given header to be added to Endpoint.
"key": "A String", # Optional. Key of Header.
"value": "A String", # Optional. Value of Header.
},
],
},
"pubsub": { # Pub/Sub message includes details of the Destination Pub/Sub topic. # OPTION 3: Write the event to Pub/Sub topic.
"attributes": { # Optional. Pub/Sub message attributes to be added to the Pub/Sub message.
"a_key": "A String",
},
"configVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"projectId": "A String", # Required. The project id which has the Pub/Sub topic.
"topicId": "A String", # Required. The topic id of the Pub/Sub topic.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to trigger IP workflow.
"type": "A String", # Optional. type of the destination
},
"eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
"jms": { # JMS message denotes the source of the event # Optional. JMS is the source for the event listener.
"name": "A String", # Optional. Name of the JMS source. i.e. queueName or topicName
"type": "A String", # Optional. Type of the JMS Source. i.e. Queue or Topic
},
"name": "A String", # Required. Identifier. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
"status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
"description": "A String", # Output only. Description of the state.
"state": "A String", # Output only. State of Event Subscription resource.
},
"subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
"subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
"triggerConfigVariables": [ # Optional. Configuration for configuring the trigger
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"updateTime": "A String", # Output only. Updated time.
}
updateMask: string, Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="retry">retry(name, body=None, x__xgafv=None)</code>
<pre>RetryEventSubscription retries the registration of Subscription.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ConnectorsService.RefreshEventSubscription
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
