-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
integrations_v1alpha.projects.locations.products.integrations.html
584 lines (543 loc) 路 26.4 KB
/
integrations_v1alpha.projects.locations.products.integrations.html
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
<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="integrations_v1alpha.html">Application Integration API</a> . <a href="integrations_v1alpha.projects.html">projects</a> . <a href="integrations_v1alpha.projects.locations.html">locations</a> . <a href="integrations_v1alpha.projects.locations.products.html">products</a> . <a href="integrations_v1alpha.projects.locations.products.integrations.html">integrations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.products.integrations.executions.html">executions()</a></code>
</p>
<p class="firstline">Returns the executions Resource.</p>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.products.integrations.versions.html">versions()</a></code>
</p>
<p class="firstline">Returns the versions Resource.</p>
<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="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete the selected integration and all versions inside</p>
<p class="toc_element">
<code><a href="#execute">execute(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.</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">Returns the list of all integrations in the specified project.</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="#schedule">schedule(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.</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="delete">delete(name, x__xgafv=None)</code>
<pre>Delete the selected integration and all versions inside
Args:
name: string, Required. The location resource of the request. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="execute">execute(name, body=None, x__xgafv=None)</code>
<pre>Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
Args:
name: string, Required. The integration resource name. (required)
body: object, The request body.
The object takes the form of:
{ # The request for executing an integration.
"doNotPropagateError": True or False, # Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
"executionId": "A String", # Optional. The id of the ON_HOLD execution to be resumed.
"inputParameters": { # Optional. Input parameters used by integration execution.
"a_key": { # The type of the parameter.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
},
"parameterEntries": [ # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
"parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. Passed in as parameters to each integration execution. Redacted
"parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
{ # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
"requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
"triggerId": "A String", # Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of `api_trigger/TRIGGER_NAME`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for executing an integration.
"eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Details for the integration that were executed.
"parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
{ # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
"executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
"executionId": "A String", # The id of the execution corresponding to this run of integration.
"outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
"a_key": "", # Properties of the object.
},
"parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
}</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>Returns the list of all integrations in the specified project.
Args:
parent: string, Required. Project and location from which the integrations should be listed. Format: projects/{project} (required)
filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
orderBy: string, The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
pageSize: integer, The page size for the resquest.
pageToken: string, The page token for the resquest.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListIntegrations.
"integrations": [ # The integrations which match the request.
{ # The integration definition.
"active": True or False, # Required. If any integration version is published.
"creatorEmail": "A String", # Output only. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
"description": "A String", # Optional.
"lastModifierEmail": "A String", # Required. The last modifier of this integration
"name": "A String", # Required. The resource name of the integration.
"updateTime": "A String", # Output only. Auto-generated.
},
],
"nextPageToken": "A String", # The next page token for the response.
}</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="schedule">schedule(name, body=None, x__xgafv=None)</code>
<pre>Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Args:
name: string, The integration resource name. (required)
body: object, The request body.
The object takes the form of:
{ # The request for scheduling an integration. Next available id: 10
"inputParameters": { # Optional. Input parameters used by integration execution.
"a_key": { # The type of the parameter.
"booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
"booleanValues": [ # Boolean array.
True or False,
],
},
"booleanValue": True or False, # Boolean.
"doubleArray": { # This message only contains a field of double number array. # Double Number Array.
"doubleValues": [ # Double number array.
3.14,
],
},
"doubleValue": 3.14, # Double Number.
"intArray": { # This message only contains a field of integer array. # Integer Array.
"intValues": [ # Integer array.
"A String",
],
},
"intValue": "A String", # Integer.
"jsonValue": "A String", # Json.
"stringArray": { # This message only contains a field of string array. # String Array.
"stringValues": [ # String array.
"A String",
],
},
"stringValue": "A String", # String.
},
},
"parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
"dataType": "A String", # Explicitly getting the type of the parameter.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"jsonValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
"parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Passed in as parameters to each integration execution.
"parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
{ # Key-value pair of EventBus parameters.
"key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
"masked": True or False, # True if this parameter should be masked in the logs
"value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
"booleanArray": {
"booleanValues": [
True or False,
],
},
"booleanValue": True or False,
"doubleArray": {
"doubleValues": [
3.14,
],
},
"doubleValue": 3.14,
"intArray": {
"intValues": [
"A String",
],
},
"intValue": "A String",
"protoArray": {
"protoValues": [
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"protoValue": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"serializedObjectValue": {
"objectValue": "A String",
},
"stringArray": {
"stringValues": [
"A String",
],
},
"stringValue": "A String",
},
},
],
},
"requestId": "A String", # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
"scheduleTime": "A String", # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
"triggerId": "A String", # Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
"userGeneratedExecutionId": "A String", # Optional. This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for executing an integration.
"executionInfoIds": [ # The execution info id for the executed integrations.
"A String",
],
}</pre>
</div>
</body></html>