@maxim_mazurok/gapi.client.connectors-v2 0.0.20231106 → 0.0.20231205

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +911 -1050
  2. package/package.json +6 -6
  3. package/readme.md +17 -12
  4. package/tests.ts +0 -142
  5. package/tsconfig.json +0 -18
  6. package/tslint.json +0 -6
package/index.d.ts CHANGED
@@ -9,1060 +9,921 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://connectors.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20231106
12
+ // Revision: 20231205
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Connectors API v2 */
18
- function load(urlOrObject: "https://connectors.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "connectors", version: "v2"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "connectors", version: "v2", callback: () => any): void;
17
+ /** Load Connectors API v2 */
18
+ function load(
19
+ urlOrObject: 'https://connectors.googleapis.com/$discovery/rest?version=v2'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'connectors', version: 'v2'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(name: 'connectors', version: 'v2', callback: () => any): void;
23
25
 
24
- namespace connectors {
25
- interface Action {
26
- /** Brief Description of action */
27
- description?:
28
- string;
29
- /** Display Name of action to be shown on client side */
30
- displayName?:
31
- string;
32
- /** JsonSchema representation of this actions's input schema */
33
- inputJsonSchema?:
34
- JsonSchema;
35
- /** List containing input parameter metadata. */
36
- inputParameters?:
37
- InputParameter[];
38
- /** Name of the action. */
39
- name?:
40
- string;
41
- /** JsonSchema representation of this actions's result schema */
42
- resultJsonSchema?:
43
- JsonSchema;
44
- /** List containing the metadata of result fields. */
45
- resultMetadata?:
46
- ResultMetadata[];
47
- }
48
- // tslint:disable-next-line:no-empty-interface
49
- interface Empty {
50
- }
51
- interface Entity {
52
- /** Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field. */
53
- fields?:
54
- { [P in string]: any };
55
- /** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
56
- name?:
57
- string;
58
- }
59
- interface EntityType {
60
- /** List containing metadata information about each field of the entity type. */
61
- fields?:
62
- Field[];
63
- /** JsonSchema representation of this entity's schema */
64
- jsonSchema?:
65
- JsonSchema;
66
- /** The name of the entity type. */
67
- name?:
68
- string;
69
- }
70
- interface ExecuteActionRequest {
71
- /** Parameters for executing the action. The parameters can be key/value pairs or nested structs. */
72
- parameters?:
73
- { [P in string]: any };
74
- }
75
- interface ExecuteActionResponse {
76
- /**
77
- * In the case of successful invocation of the specified action, the results Struct contains values based on the response of the action invoked. 1. If the action execution produces any
78
- * entities as a result, they are returned as an array of Structs with the 'key' being the field name and the 'value' being the value of that field in each result row. { 'results':
79
- * [{'key': 'value'}, ...] }
80
- */
81
- results?:
82
- Array<{ [P in string]: any }>;
83
- }
84
- interface ExecuteSqlQueryRequest {
85
- /** Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems. */
86
- query?:
87
- Query;
88
- }
89
- interface ExecuteSqlQueryResponse {
90
- /**
91
- * In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the
92
- * 'results' Struct list - "results": [ { "field1": "val1", "field2": "val2",.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists.
93
- */
94
- results?:
95
- Array<{ [P in string]: any }>;
96
- }
97
- interface Field {
98
- /** The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. */
99
- additionalDetails?:
100
- { [P in string]: any };
101
- /** The data type of the Field. */
102
- dataType?:
103
- string;
104
- /** The following field specifies the default value of the Field provided by the external system if a value is not provided. */
105
- defaultValue?:
106
- any;
107
- /** A brief description of the Field. */
108
- description?:
109
- string;
110
- /** JsonSchema of the field, applicable only if field is of type `STRUCT` */
111
- jsonSchema?:
112
- JsonSchema;
113
- /** The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity. */
114
- key?:
115
- boolean;
116
- /** Name of the Field. */
117
- name?:
118
- string;
119
- /** Specifies whether a null value is allowed. */
120
- nullable?:
121
- boolean;
122
- /** Reference captures the association between two different entity types. Value links to the reference of another entity type. */
123
- reference?:
124
- Reference;
125
- }
126
- interface InputParameter {
127
- /** The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. */
128
- additionalDetails?:
129
- { [P in string]: any };
130
- /** The data type of the Parameter */
131
- dataType?:
132
- string;
133
- /** The following field specifies the default value of the Parameter provided by the external system if a value is not provided. */
134
- defaultValue?:
135
- any;
136
- /** A brief description of the Parameter. */
137
- description?:
138
- string;
139
- /** JsonSchema of the parameter, applicable only if parameter is of type `STRUCT` */
140
- jsonSchema?:
141
- JsonSchema;
142
- /** Name of the Parameter. */
143
- name?:
144
- string;
145
- /** Specifies whether a null value is allowed. */
146
- nullable?:
147
- boolean;
148
- }
149
- interface JsonSchema {
150
- /** Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema */
151
- additionalDetails?:
152
- { [P in string]: any };
153
- /** The default value of the field or object described by this schema. */
154
- default?:
155
- any;
156
- /** A description of this schema. */
157
- description?:
158
- string;
159
- /** Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values */
160
- enum?:
161
- any[];
162
- /** Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format */
163
- format?:
164
- string;
165
- /** Schema that applies to array values, applicable only if this is of type `array`. */
166
- items?:
167
- JsonSchema;
168
- /** JDBC datatype of the field. */
169
- jdbcType?:
170
- string;
171
- /** The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property */
172
- properties?:
173
- { [P in string]: JsonSchema };
174
- /** Whether this property is required. */
175
- required?:
176
- string[];
177
- /** JSON Schema Validation: A Vocabulary for Structural Validation of JSON */
178
- type?:
179
- string[];
180
- }
181
- interface ListActionsResponse {
182
- /** List of action metadata. */
183
- actions?:
184
- Action[];
185
- /** Next page token if more actions available. */
186
- nextPageToken?:
187
- string;
188
- /** List of actions which contain unsupported Datatypes. Check datatype.proto for more information. */
189
- unsupportedActionNames?:
190
- string[];
191
- }
192
- interface ListEntitiesResponse {
193
- /** List containing entity rows. */
194
- entities?:
195
- Entity[];
196
- /** Next page token if more records are available. */
197
- nextPageToken?:
198
- string;
199
- }
200
- interface ListEntityTypesResponse {
201
- /** Next page token if more entity types available. */
202
- nextPageToken?:
203
- string;
204
- /** List of metadata related to all entity types. */
205
- types?:
206
- EntityType[];
207
- /** List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information. */
208
- unsupportedTypeNames?:
209
- string[];
210
- }
211
- interface Query {
212
- /** Sets the limit for the maximum number of rows returned after the query execution. */
213
- maxRows?:
214
- string;
215
- /** Required. Sql query to execute. */
216
- query?:
217
- string;
218
- /** In the struct, the value corresponds to the value of query parameter and date type corresponds to the date type of the query parameter. */
219
- queryParameters?:
220
- QueryParameter[];
221
- /** Sets the number of seconds the driver will wait for a query to execute. */
222
- timeout?:
223
- string;
224
- }
225
- interface QueryParameter {
226
- dataType?:
227
- string;
228
- value?:
229
- any;
230
- }
231
- interface Reference {
232
- /** Name of the reference field. */
233
- name?:
234
- string;
235
- /** Name of reference entity type. */
236
- type?:
237
- string;
238
- }
239
- interface ResultMetadata {
240
- /** The data type of the metadata field */
241
- dataType?:
242
- string;
243
- /** A brief description of the metadata field. */
244
- description?:
245
- string;
246
- /** JsonSchema of the result, applicable only if parameter is of type `STRUCT` */
247
- jsonSchema?:
248
- JsonSchema;
249
- /** Name of the metadata field. */
250
- name?:
251
- string;
252
- }
253
- interface UpdateEntitiesWithConditionsResponse {
254
- /** Response returned by the external system. */
255
- response?:
256
- { [P in string]: any };
257
- }
258
- interface ActionsResource {
259
- /** Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request. */
260
- execute(request: {
261
- /** V1 error format. */
262
- "$.xgafv"?:
263
- string;
264
- /** OAuth access token. */
265
- access_token?:
266
- string;
267
- /** Data format for response. */
268
- alt?:
269
- string;
270
- /** JSONP */
271
- callback?:
272
- string;
273
- /** Selector specifying which fields to include in a partial response. */
274
- fields?:
275
- string;
276
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
277
- key?:
278
- string;
279
- /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
280
- name:
281
- string;
282
- /** OAuth 2.0 token for the current user. */
283
- oauth_token?:
284
- string;
285
- /** Returns response with indentations and line breaks. */
286
- prettyPrint?:
287
- boolean;
288
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
289
- quotaUser?:
290
- string;
291
- /** Upload protocol for media (e.g. "raw", "multipart"). */
292
- upload_protocol?:
293
- string;
294
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
295
- uploadType?:
296
- string;
297
- /** Request body */
298
- resource:
299
- ExecuteActionRequest;
300
- }): Request<ExecuteActionResponse>;
301
- execute(request: {
302
- /** V1 error format. */
303
- "$.xgafv"?:
304
- string;
305
- /** OAuth access token. */
306
- access_token?:
307
- string;
308
- /** Data format for response. */
309
- alt?:
310
- string;
311
- /** JSONP */
312
- callback?:
313
- string;
314
- /** Selector specifying which fields to include in a partial response. */
315
- fields?:
316
- string;
317
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
318
- key?:
319
- string;
320
- /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
321
- name:
322
- string;
323
- /** OAuth 2.0 token for the current user. */
324
- oauth_token?:
325
- string;
326
- /** Returns response with indentations and line breaks. */
327
- prettyPrint?:
328
- boolean;
329
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
330
- quotaUser?:
331
- string;
332
- /** Upload protocol for media (e.g. "raw", "multipart"). */
333
- upload_protocol?:
334
- string;
335
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
336
- uploadType?:
337
- string;
338
- },
339
- body: ExecuteActionRequest): Request<ExecuteActionResponse>;
340
- /** Gets the schema of the given action. */
341
- get(request?: {
342
- /** V1 error format. */
343
- "$.xgafv"?:
344
- string;
345
- /** OAuth access token. */
346
- access_token?:
347
- string;
348
- /** Data format for response. */
349
- alt?:
350
- string;
351
- /** JSONP */
352
- callback?:
353
- string;
354
- /** Selector specifying which fields to include in a partial response. */
355
- fields?:
356
- string;
357
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
358
- key?:
359
- string;
360
- /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
361
- name:
362
- string;
363
- /** OAuth 2.0 token for the current user. */
364
- oauth_token?:
365
- string;
366
- /** Returns response with indentations and line breaks. */
367
- prettyPrint?:
368
- boolean;
369
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
370
- quotaUser?:
371
- string;
372
- /** Upload protocol for media (e.g. "raw", "multipart"). */
373
- upload_protocol?:
374
- string;
375
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
376
- uploadType?:
377
- string;
378
- }): Request<Action>;
379
- /** Gets the schema of all the actions supported by the connector. */
380
- list(request?: {
381
- /** V1 error format. */
382
- "$.xgafv"?:
383
- string;
384
- /** OAuth access token. */
385
- access_token?:
386
- string;
387
- /** Data format for response. */
388
- alt?:
389
- string;
390
- /** JSONP */
391
- callback?:
392
- string;
393
- /** Selector specifying which fields to include in a partial response. */
394
- fields?:
395
- string;
396
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
397
- key?:
398
- string;
399
- /** OAuth 2.0 token for the current user. */
400
- oauth_token?:
401
- string;
402
- /** Number of Actions to return. Defaults to 25. */
403
- pageSize?:
404
- number;
405
- /** Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions. */
406
- pageToken?:
407
- string;
408
- /** Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection} */
409
- parent:
410
- string;
411
- /** Returns response with indentations and line breaks. */
412
- prettyPrint?:
413
- boolean;
414
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
415
- quotaUser?:
416
- string;
417
- /** Upload protocol for media (e.g. "raw", "multipart"). */
418
- upload_protocol?:
419
- string;
420
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
421
- uploadType?:
422
- string;
423
- /** Specifies which fields of the Action are returned in the response. */
424
- view?:
425
- string;
426
- }): Request<ListActionsResponse>;
427
- }
428
- interface EntitiesResource {
429
- /**
430
- * Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message
431
- * contains a `Entity` message object returned as a response by the external system.
432
- */
433
- create(request: {
434
- /** V1 error format. */
435
- "$.xgafv"?:
436
- string;
437
- /** OAuth access token. */
438
- access_token?:
439
- string;
440
- /** Data format for response. */
441
- alt?:
442
- string;
443
- /** JSONP */
444
- callback?:
445
- string;
446
- /** Selector specifying which fields to include in a partial response. */
447
- fields?:
448
- string;
449
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
450
- key?:
451
- string;
452
- /** OAuth 2.0 token for the current user. */
453
- oauth_token?:
454
- string;
455
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
456
- parent:
457
- string;
458
- /** Returns response with indentations and line breaks. */
459
- prettyPrint?:
460
- boolean;
461
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
462
- quotaUser?:
463
- string;
464
- /** Upload protocol for media (e.g. "raw", "multipart"). */
465
- upload_protocol?:
466
- string;
467
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
468
- uploadType?:
469
- string;
470
- /** Request body */
471
- resource:
472
- Entity;
473
- }): Request<Entity>;
474
- create(request: {
475
- /** V1 error format. */
476
- "$.xgafv"?:
477
- string;
478
- /** OAuth access token. */
479
- access_token?:
480
- string;
481
- /** Data format for response. */
482
- alt?:
483
- string;
484
- /** JSONP */
485
- callback?:
486
- string;
487
- /** Selector specifying which fields to include in a partial response. */
488
- fields?:
489
- string;
490
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
491
- key?:
492
- string;
493
- /** OAuth 2.0 token for the current user. */
494
- oauth_token?:
495
- string;
496
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
497
- parent:
498
- string;
499
- /** Returns response with indentations and line breaks. */
500
- prettyPrint?:
501
- boolean;
502
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
503
- quotaUser?:
504
- string;
505
- /** Upload protocol for media (e.g. "raw", "multipart"). */
506
- upload_protocol?:
507
- string;
508
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
509
- uploadType?:
510
- string;
511
- },
512
- body: Entity): Request<Entity>;
513
- /** Deletes an existing entity row matching the entity type and entity id specified in the request. */
514
- delete(request?: {
515
- /** V1 error format. */
516
- "$.xgafv"?:
517
- string;
518
- /** OAuth access token. */
519
- access_token?:
520
- string;
521
- /** Data format for response. */
522
- alt?:
523
- string;
524
- /** JSONP */
525
- callback?:
526
- string;
527
- /** Selector specifying which fields to include in a partial response. */
528
- fields?:
529
- string;
530
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
531
- key?:
532
- string;
533
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
534
- name:
535
- string;
536
- /** OAuth 2.0 token for the current user. */
537
- oauth_token?:
538
- string;
539
- /** Returns response with indentations and line breaks. */
540
- prettyPrint?:
541
- boolean;
542
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
543
- quotaUser?:
544
- string;
545
- /** Upload protocol for media (e.g. "raw", "multipart"). */
546
- upload_protocol?:
547
- string;
548
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
549
- uploadType?:
550
- string;
551
- }): Request<{}>;
552
- /** Deletes entities based on conditions specified in the request and not on entity id. */
553
- deleteEntitiesWithConditions(request?: {
554
- /** V1 error format. */
555
- "$.xgafv"?:
556
- string;
557
- /** OAuth access token. */
558
- access_token?:
559
- string;
560
- /** Data format for response. */
561
- alt?:
562
- string;
563
- /** JSONP */
564
- callback?:
565
- string;
566
- /**
567
- * Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation
568
- * should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider
569
- * 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
570
- */
571
- conditions?:
572
- string;
573
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
574
- entityType:
575
- string;
576
- /** Selector specifying which fields to include in a partial response. */
577
- fields?:
578
- string;
579
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
580
- key?:
581
- string;
582
- /** OAuth 2.0 token for the current user. */
583
- oauth_token?:
584
- string;
585
- /** Returns response with indentations and line breaks. */
586
- prettyPrint?:
587
- boolean;
588
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
589
- quotaUser?:
590
- string;
591
- /** Upload protocol for media (e.g. "raw", "multipart"). */
592
- upload_protocol?:
593
- string;
594
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
595
- uploadType?:
596
- string;
597
- }): Request<{}>;
598
- /** Gets a single entity row matching the entity type and entity id specified in the request. */
599
- get(request?: {
600
- /** V1 error format. */
601
- "$.xgafv"?:
602
- string;
603
- /** OAuth access token. */
604
- access_token?:
605
- string;
606
- /** Data format for response. */
607
- alt?:
608
- string;
609
- /** JSONP */
610
- callback?:
611
- string;
612
- /** Selector specifying which fields to include in a partial response. */
613
- fields?:
614
- string;
615
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
616
- key?:
617
- string;
618
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
619
- name:
620
- string;
621
- /** OAuth 2.0 token for the current user. */
622
- oauth_token?:
623
- string;
624
- /** Returns response with indentations and line breaks. */
625
- prettyPrint?:
626
- boolean;
627
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
628
- quotaUser?:
629
- string;
630
- /** Upload protocol for media (e.g. "raw", "multipart"). */
631
- upload_protocol?:
632
- string;
633
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
634
- uploadType?:
635
- string;
636
- }): Request<Entity>;
637
- /**
638
- * Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the
639
- * primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The
640
- * values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any
641
- * updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.
642
- */
643
- list(request?: {
644
- /** V1 error format. */
645
- "$.xgafv"?:
646
- string;
647
- /** OAuth access token. */
648
- access_token?:
649
- string;
650
- /** Data format for response. */
651
- alt?:
652
- string;
653
- /** JSONP */
654
- callback?:
655
- string;
656
- /**
657
- * Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have
658
- * information about what format of filters/conditions are supported.
659
- */
660
- conditions?:
661
- string;
662
- /** Selector specifying which fields to include in a partial response. */
663
- fields?:
664
- string;
665
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
666
- key?:
667
- string;
668
- /** OAuth 2.0 token for the current user. */
669
- oauth_token?:
670
- string;
671
- /** Number of entity rows to return. Defaults page size = 25. Max page size = 200. */
672
- pageSize?:
673
- number;
674
- /** Page token value if available from a previous request. */
675
- pageToken?:
676
- string;
677
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
678
- parent:
679
- string;
680
- /** Returns response with indentations and line breaks. */
681
- prettyPrint?:
682
- boolean;
683
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
684
- quotaUser?:
685
- string;
686
- /** List of 'sort_by' columns to use when returning the results. */
687
- sortBy?:
688
- string | string[];
689
- /** Upload protocol for media (e.g. "raw", "multipart"). */
690
- upload_protocol?:
691
- string;
692
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
693
- uploadType?:
694
- string;
695
- }): Request<ListEntitiesResponse>;
696
- /**
697
- * Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of
698
- * the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.
699
- */
700
- patch(request: {
701
- /** V1 error format. */
702
- "$.xgafv"?:
703
- string;
704
- /** OAuth access token. */
705
- access_token?:
706
- string;
707
- /** Data format for response. */
708
- alt?:
709
- string;
710
- /** JSONP */
711
- callback?:
712
- string;
713
- /** Selector specifying which fields to include in a partial response. */
714
- fields?:
715
- string;
716
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
717
- key?:
718
- string;
719
- /** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
720
- name:
721
- string;
722
- /** OAuth 2.0 token for the current user. */
723
- oauth_token?:
724
- string;
725
- /** Returns response with indentations and line breaks. */
726
- prettyPrint?:
727
- boolean;
728
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
729
- quotaUser?:
730
- string;
731
- /** Upload protocol for media (e.g. "raw", "multipart"). */
732
- upload_protocol?:
733
- string;
734
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
735
- uploadType?:
736
- string;
737
- /** Request body */
738
- resource:
739
- Entity;
740
- }): Request<Entity>;
741
- patch(request: {
742
- /** V1 error format. */
743
- "$.xgafv"?:
744
- string;
745
- /** OAuth access token. */
746
- access_token?:
747
- string;
748
- /** Data format for response. */
749
- alt?:
750
- string;
751
- /** JSONP */
752
- callback?:
753
- string;
754
- /** Selector specifying which fields to include in a partial response. */
755
- fields?:
756
- string;
757
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
758
- key?:
759
- string;
760
- /** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
761
- name:
762
- string;
763
- /** OAuth 2.0 token for the current user. */
764
- oauth_token?:
765
- string;
766
- /** Returns response with indentations and line breaks. */
767
- prettyPrint?:
768
- boolean;
769
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
770
- quotaUser?:
771
- string;
772
- /** Upload protocol for media (e.g. "raw", "multipart"). */
773
- upload_protocol?:
774
- string;
775
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
776
- uploadType?:
777
- string;
778
- },
779
- body: Entity): Request<Entity>;
780
- /** Updates entities based on conditions specified in the request and not on entity id. */
781
- updateEntitiesWithConditions(request: {
782
- /** V1 error format. */
783
- "$.xgafv"?:
784
- string;
785
- /** OAuth access token. */
786
- access_token?:
787
- string;
788
- /** Data format for response. */
789
- alt?:
790
- string;
791
- /** JSONP */
792
- callback?:
793
- string;
794
- /**
795
- * Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation
796
- * should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider
797
- * 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
798
- */
799
- conditions?:
800
- string;
801
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
802
- entityType:
803
- string;
804
- /** Selector specifying which fields to include in a partial response. */
805
- fields?:
806
- string;
807
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
808
- key?:
809
- string;
810
- /** OAuth 2.0 token for the current user. */
811
- oauth_token?:
812
- string;
813
- /** Returns response with indentations and line breaks. */
814
- prettyPrint?:
815
- boolean;
816
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
817
- quotaUser?:
818
- string;
819
- /** Upload protocol for media (e.g. "raw", "multipart"). */
820
- upload_protocol?:
821
- string;
822
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
823
- uploadType?:
824
- string;
825
- /** Request body */
826
- resource:
827
- Entity;
828
- }): Request<UpdateEntitiesWithConditionsResponse>;
829
- updateEntitiesWithConditions(request: {
830
- /** V1 error format. */
831
- "$.xgafv"?:
832
- string;
833
- /** OAuth access token. */
834
- access_token?:
835
- string;
836
- /** Data format for response. */
837
- alt?:
838
- string;
839
- /** JSONP */
840
- callback?:
841
- string;
842
- /**
843
- * Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation
844
- * should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider
845
- * 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
846
- */
847
- conditions?:
848
- string;
849
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
850
- entityType:
851
- string;
852
- /** Selector specifying which fields to include in a partial response. */
853
- fields?:
854
- string;
855
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
856
- key?:
857
- string;
858
- /** OAuth 2.0 token for the current user. */
859
- oauth_token?:
860
- string;
861
- /** Returns response with indentations and line breaks. */
862
- prettyPrint?:
863
- boolean;
864
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
865
- quotaUser?:
866
- string;
867
- /** Upload protocol for media (e.g. "raw", "multipart"). */
868
- upload_protocol?:
869
- string;
870
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
871
- uploadType?:
872
- string;
873
- },
874
- body: Entity): Request<UpdateEntitiesWithConditionsResponse>;
875
- }
876
- interface EntityTypesResource {
877
- /** Gets metadata of given entity type */
878
- get(request?: {
879
- /** V1 error format. */
880
- "$.xgafv"?:
881
- string;
882
- /** OAuth access token. */
883
- access_token?:
884
- string;
885
- /** Data format for response. */
886
- alt?:
887
- string;
888
- /** JSONP */
889
- callback?:
890
- string;
891
- /** Selector specifying which fields to include in a partial response. */
892
- fields?:
893
- string;
894
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
895
- key?:
896
- string;
897
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} */
898
- name:
899
- string;
900
- /** OAuth 2.0 token for the current user. */
901
- oauth_token?:
902
- string;
903
- /** Returns response with indentations and line breaks. */
904
- prettyPrint?:
905
- boolean;
906
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
907
- quotaUser?:
908
- string;
909
- /** Upload protocol for media (e.g. "raw", "multipart"). */
910
- upload_protocol?:
911
- string;
912
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
913
- uploadType?:
914
- string;
915
- }): Request<EntityType>;
916
- /** Lists metadata related to all entity types present in the external system. */
917
- list(request?: {
918
- /** V1 error format. */
919
- "$.xgafv"?:
920
- string;
921
- /** OAuth access token. */
922
- access_token?:
923
- string;
924
- /** Data format for response. */
925
- alt?:
926
- string;
927
- /** JSONP */
928
- callback?:
929
- string;
930
- /** Selector specifying which fields to include in a partial response. */
931
- fields?:
932
- string;
933
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
934
- key?:
935
- string;
936
- /** OAuth 2.0 token for the current user. */
937
- oauth_token?:
938
- string;
939
- /** Number of entity types to return. Defaults to 25. */
940
- pageSize?:
941
- number;
942
- /** Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types. */
943
- pageToken?:
944
- string;
945
- /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection} */
946
- parent:
947
- string;
948
- /** Returns response with indentations and line breaks. */
949
- prettyPrint?:
950
- boolean;
951
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
952
- quotaUser?:
953
- string;
954
- /** Upload protocol for media (e.g. "raw", "multipart"). */
955
- upload_protocol?:
956
- string;
957
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
958
- uploadType?:
959
- string;
960
- /** Specifies which fields of the Entity Type are returned in the response. */
961
- view?:
962
- string;
963
- }): Request<ListEntityTypesResponse>;
964
- entities:
965
- EntitiesResource;
966
- }
967
- interface ConnectionsResource {
968
- /**
969
- * Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where
970
- * a.Id = o.AccountId'.
971
- */
972
- executeSqlQuery(request: {
973
- /** V1 error format. */
974
- "$.xgafv"?:
975
- string;
976
- /** OAuth access token. */
977
- access_token?:
978
- string;
979
- /** Data format for response. */
980
- alt?:
981
- string;
982
- /** JSONP */
983
- callback?:
984
- string;
985
- /** Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} */
986
- connection:
987
- string;
988
- /** Selector specifying which fields to include in a partial response. */
989
- fields?:
990
- string;
991
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
992
- key?:
993
- string;
994
- /** OAuth 2.0 token for the current user. */
995
- oauth_token?:
996
- string;
997
- /** Returns response with indentations and line breaks. */
998
- prettyPrint?:
999
- boolean;
1000
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1001
- quotaUser?:
1002
- string;
1003
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1004
- upload_protocol?:
1005
- string;
1006
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1007
- uploadType?:
1008
- string;
1009
- /** Request body */
1010
- resource:
1011
- ExecuteSqlQueryRequest;
1012
- }): Request<ExecuteSqlQueryResponse>;
1013
- executeSqlQuery(request: {
1014
- /** V1 error format. */
1015
- "$.xgafv"?:
1016
- string;
1017
- /** OAuth access token. */
1018
- access_token?:
1019
- string;
1020
- /** Data format for response. */
1021
- alt?:
1022
- string;
1023
- /** JSONP */
1024
- callback?:
1025
- string;
1026
- /** Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} */
1027
- connection:
1028
- string;
1029
- /** Selector specifying which fields to include in a partial response. */
1030
- fields?:
1031
- string;
1032
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1033
- key?:
1034
- string;
1035
- /** OAuth 2.0 token for the current user. */
1036
- oauth_token?:
1037
- string;
1038
- /** Returns response with indentations and line breaks. */
1039
- prettyPrint?:
1040
- boolean;
1041
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1042
- quotaUser?:
1043
- string;
1044
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1045
- upload_protocol?:
1046
- string;
1047
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1048
- uploadType?:
1049
- string;
1050
- },
1051
- body: ExecuteSqlQueryRequest): Request<ExecuteSqlQueryResponse>;
1052
- actions:
1053
- ActionsResource;
1054
- entityTypes:
1055
- EntityTypesResource;
1056
- }
1057
- interface LocationsResource {
1058
- connections:
1059
- ConnectionsResource;
1060
- }
1061
- interface ProjectsResource {
1062
- locations:
1063
- LocationsResource;
1064
- }
1065
-
1066
- const projects: ProjectsResource;
26
+ namespace connectors {
27
+ interface AccessCredentials {
28
+ /** OAuth access token. */
29
+ accessToken?: string;
30
+ /** Duration till the access token expires. */
31
+ expiresIn?: string;
32
+ /** OAuth refresh token. */
33
+ refreshToken?: string;
34
+ }
35
+ interface Action {
36
+ /** Brief Description of action */
37
+ description?: string;
38
+ /** Display Name of action to be shown on client side */
39
+ displayName?: string;
40
+ /** JsonSchema representation of this actions's input schema */
41
+ inputJsonSchema?: JsonSchema;
42
+ /** List containing input parameter metadata. */
43
+ inputParameters?: InputParameter[];
44
+ /** Name of the action. */
45
+ name?: string;
46
+ /** JsonSchema representation of this actions's result schema */
47
+ resultJsonSchema?: JsonSchema;
48
+ /** List containing the metadata of result fields. */
49
+ resultMetadata?: ResultMetadata[];
50
+ }
51
+ interface CheckReadinessResponse {
52
+ status?: string;
53
+ }
54
+ interface CheckStatusResponse {
55
+ /** When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state. */
56
+ description?: string;
57
+ /** State of the connector. */
58
+ state?: string;
59
+ }
60
+ interface Empty {}
61
+ interface Entity {
62
+ /** Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field. */
63
+ fields?: {[P in string]: any};
64
+ /** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
65
+ name?: string;
66
+ }
67
+ interface EntityType {
68
+ /** List containing metadata information about each field of the entity type. */
69
+ fields?: Field[];
70
+ /** JsonSchema representation of this entity's schema */
71
+ jsonSchema?: JsonSchema;
72
+ /** The name of the entity type. */
73
+ name?: string;
74
+ }
75
+ interface ExchangeAuthCodeRequest {}
76
+ interface ExchangeAuthCodeResponse {
77
+ accessCredentials?: AccessCredentials;
78
+ }
79
+ interface ExecuteActionRequest {
80
+ /** Parameters for executing the action. The parameters can be key/value pairs or nested structs. */
81
+ parameters?: {[P in string]: any};
82
+ }
83
+ interface ExecuteActionResponse {
84
+ /** In the case of successful invocation of the specified action, the results Struct contains values based on the response of the action invoked. 1. If the action execution produces any entities as a result, they are returned as an array of Structs with the 'key' being the field name and the 'value' being the value of that field in each result row. { 'results': [{'key': 'value'}, ...] } */
85
+ results?: Array<{[P in string]: any}>;
86
+ }
87
+ interface ExecuteSqlQueryRequest {
88
+ /** Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems. */
89
+ query?: Query;
90
+ }
91
+ interface ExecuteSqlQueryResponse {
92
+ /** In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the 'results' Struct list - "results": [ { "field1": "val1", "field2": "val2",.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists. */
93
+ results?: Array<{[P in string]: any}>;
94
+ }
95
+ interface Field {
96
+ /** The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. */
97
+ additionalDetails?: {[P in string]: any};
98
+ /** The data type of the Field. */
99
+ dataType?: string;
100
+ /** The following field specifies the default value of the Field provided by the external system if a value is not provided. */
101
+ defaultValue?: any;
102
+ /** A brief description of the Field. */
103
+ description?: string;
104
+ /** JsonSchema of the field, applicable only if field is of type `STRUCT` */
105
+ jsonSchema?: JsonSchema;
106
+ /** The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity. */
107
+ key?: boolean;
108
+ /** Name of the Field. */
109
+ name?: string;
110
+ /** Specifies whether a null value is allowed. */
111
+ nullable?: boolean;
112
+ /** Reference captures the association between two different entity types. Value links to the reference of another entity type. */
113
+ reference?: Reference;
114
+ }
115
+ interface InputParameter {
116
+ /** The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. */
117
+ additionalDetails?: {[P in string]: any};
118
+ /** The data type of the Parameter */
119
+ dataType?: string;
120
+ /** The following field specifies the default value of the Parameter provided by the external system if a value is not provided. */
121
+ defaultValue?: any;
122
+ /** A brief description of the Parameter. */
123
+ description?: string;
124
+ /** JsonSchema of the parameter, applicable only if parameter is of type `STRUCT` */
125
+ jsonSchema?: JsonSchema;
126
+ /** Name of the Parameter. */
127
+ name?: string;
128
+ /** Specifies whether a null value is allowed. */
129
+ nullable?: boolean;
130
+ }
131
+ interface JsonSchema {
132
+ /** Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema */
133
+ additionalDetails?: {[P in string]: any};
134
+ /** The default value of the field or object described by this schema. */
135
+ default?: any;
136
+ /** A description of this schema. */
137
+ description?: string;
138
+ /** Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values */
139
+ enum?: any[];
140
+ /** Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format */
141
+ format?: string;
142
+ /** Schema that applies to array values, applicable only if this is of type `array`. */
143
+ items?: JsonSchema;
144
+ /** JDBC datatype of the field. */
145
+ jdbcType?: string;
146
+ /** The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property */
147
+ properties?: {[P in string]: JsonSchema};
148
+ /** Whether this property is required. */
149
+ required?: string[];
150
+ /** JSON Schema Validation: A Vocabulary for Structural Validation of JSON */
151
+ type?: string[];
152
+ }
153
+ interface ListActionsResponse {
154
+ /** List of action metadata. */
155
+ actions?: Action[];
156
+ /** Next page token if more actions available. */
157
+ nextPageToken?: string;
158
+ /** List of actions which contain unsupported Datatypes. Check datatype.proto for more information. */
159
+ unsupportedActionNames?: string[];
1067
160
  }
161
+ interface ListEntitiesResponse {
162
+ /** List containing entity rows. */
163
+ entities?: Entity[];
164
+ /** Next page token if more records are available. */
165
+ nextPageToken?: string;
166
+ }
167
+ interface ListEntityTypesResponse {
168
+ /** Next page token if more entity types available. */
169
+ nextPageToken?: string;
170
+ /** List of metadata related to all entity types. */
171
+ types?: EntityType[];
172
+ /** List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information. */
173
+ unsupportedTypeNames?: string[];
174
+ }
175
+ interface Query {
176
+ /** Sets the limit for the maximum number of rows returned after the query execution. */
177
+ maxRows?: string;
178
+ /** Required. Sql query to execute. */
179
+ query?: string;
180
+ /** In the struct, the value corresponds to the value of query parameter and date type corresponds to the date type of the query parameter. */
181
+ queryParameters?: QueryParameter[];
182
+ /** Sets the number of seconds the driver will wait for a query to execute. */
183
+ timeout?: string;
184
+ }
185
+ interface QueryParameter {
186
+ dataType?: string;
187
+ value?: any;
188
+ }
189
+ interface Reference {
190
+ /** Name of the reference field. */
191
+ name?: string;
192
+ /** Name of reference entity type. */
193
+ type?: string;
194
+ }
195
+ interface RefreshAccessTokenRequest {}
196
+ interface RefreshAccessTokenResponse {
197
+ accessCredentials?: AccessCredentials;
198
+ }
199
+ interface ResultMetadata {
200
+ /** The data type of the metadata field */
201
+ dataType?: string;
202
+ /** A brief description of the metadata field. */
203
+ description?: string;
204
+ /** JsonSchema of the result, applicable only if parameter is of type `STRUCT` */
205
+ jsonSchema?: JsonSchema;
206
+ /** Name of the metadata field. */
207
+ name?: string;
208
+ }
209
+ interface UpdateEntitiesWithConditionsResponse {
210
+ /** Response returned by the external system. */
211
+ response?: {[P in string]: any};
212
+ }
213
+ interface ActionsResource {
214
+ /** Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request. */
215
+ execute(request: {
216
+ /** V1 error format. */
217
+ '$.xgafv'?: string;
218
+ /** OAuth access token. */
219
+ access_token?: string;
220
+ /** Data format for response. */
221
+ alt?: string;
222
+ /** JSONP */
223
+ callback?: string;
224
+ /** Selector specifying which fields to include in a partial response. */
225
+ fields?: string;
226
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
227
+ key?: string;
228
+ /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
229
+ name: string;
230
+ /** OAuth 2.0 token for the current user. */
231
+ oauth_token?: string;
232
+ /** Returns response with indentations and line breaks. */
233
+ prettyPrint?: boolean;
234
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
235
+ quotaUser?: string;
236
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
237
+ upload_protocol?: string;
238
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
239
+ uploadType?: string;
240
+ /** Request body */
241
+ resource: ExecuteActionRequest;
242
+ }): Request<ExecuteActionResponse>;
243
+ execute(
244
+ request: {
245
+ /** V1 error format. */
246
+ '$.xgafv'?: string;
247
+ /** OAuth access token. */
248
+ access_token?: string;
249
+ /** Data format for response. */
250
+ alt?: string;
251
+ /** JSONP */
252
+ callback?: string;
253
+ /** Selector specifying which fields to include in a partial response. */
254
+ fields?: string;
255
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
256
+ key?: string;
257
+ /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
258
+ name: string;
259
+ /** OAuth 2.0 token for the current user. */
260
+ oauth_token?: string;
261
+ /** Returns response with indentations and line breaks. */
262
+ prettyPrint?: boolean;
263
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
264
+ quotaUser?: string;
265
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
266
+ upload_protocol?: string;
267
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
268
+ uploadType?: string;
269
+ },
270
+ body: ExecuteActionRequest
271
+ ): Request<ExecuteActionResponse>;
272
+ /** Gets the schema of the given action. */
273
+ get(request?: {
274
+ /** V1 error format. */
275
+ '$.xgafv'?: string;
276
+ /** OAuth access token. */
277
+ access_token?: string;
278
+ /** Data format for response. */
279
+ alt?: string;
280
+ /** JSONP */
281
+ callback?: string;
282
+ /** Selector specifying which fields to include in a partial response. */
283
+ fields?: string;
284
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
285
+ key?: string;
286
+ /** Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} */
287
+ name: string;
288
+ /** OAuth 2.0 token for the current user. */
289
+ oauth_token?: string;
290
+ /** Returns response with indentations and line breaks. */
291
+ prettyPrint?: boolean;
292
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
293
+ quotaUser?: string;
294
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
295
+ upload_protocol?: string;
296
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
297
+ uploadType?: string;
298
+ }): Request<Action>;
299
+ /** Gets the schema of all the actions supported by the connector. */
300
+ list(request?: {
301
+ /** V1 error format. */
302
+ '$.xgafv'?: string;
303
+ /** OAuth access token. */
304
+ access_token?: string;
305
+ /** Data format for response. */
306
+ alt?: string;
307
+ /** JSONP */
308
+ callback?: string;
309
+ /** Selector specifying which fields to include in a partial response. */
310
+ fields?: string;
311
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
312
+ key?: string;
313
+ /** OAuth 2.0 token for the current user. */
314
+ oauth_token?: string;
315
+ /** Number of Actions to return. Defaults to 25. */
316
+ pageSize?: number;
317
+ /** Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions. */
318
+ pageToken?: string;
319
+ /** Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection} */
320
+ parent: string;
321
+ /** Returns response with indentations and line breaks. */
322
+ prettyPrint?: boolean;
323
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
324
+ quotaUser?: string;
325
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
326
+ upload_protocol?: string;
327
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
328
+ uploadType?: string;
329
+ /** Specifies which fields of the Action are returned in the response. */
330
+ view?: string;
331
+ }): Request<ListActionsResponse>;
332
+ }
333
+ interface EntitiesResource {
334
+ /** Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system. */
335
+ create(request: {
336
+ /** V1 error format. */
337
+ '$.xgafv'?: string;
338
+ /** OAuth access token. */
339
+ access_token?: string;
340
+ /** Data format for response. */
341
+ alt?: string;
342
+ /** JSONP */
343
+ callback?: string;
344
+ /** Selector specifying which fields to include in a partial response. */
345
+ fields?: string;
346
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
347
+ key?: string;
348
+ /** OAuth 2.0 token for the current user. */
349
+ oauth_token?: string;
350
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
351
+ parent: string;
352
+ /** Returns response with indentations and line breaks. */
353
+ prettyPrint?: boolean;
354
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
355
+ quotaUser?: string;
356
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
357
+ upload_protocol?: string;
358
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
359
+ uploadType?: string;
360
+ /** Request body */
361
+ resource: Entity;
362
+ }): Request<Entity>;
363
+ create(
364
+ request: {
365
+ /** V1 error format. */
366
+ '$.xgafv'?: string;
367
+ /** OAuth access token. */
368
+ access_token?: string;
369
+ /** Data format for response. */
370
+ alt?: string;
371
+ /** JSONP */
372
+ callback?: string;
373
+ /** Selector specifying which fields to include in a partial response. */
374
+ fields?: string;
375
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
376
+ key?: string;
377
+ /** OAuth 2.0 token for the current user. */
378
+ oauth_token?: string;
379
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
380
+ parent: string;
381
+ /** Returns response with indentations and line breaks. */
382
+ prettyPrint?: boolean;
383
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
384
+ quotaUser?: string;
385
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
386
+ upload_protocol?: string;
387
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
388
+ uploadType?: string;
389
+ },
390
+ body: Entity
391
+ ): Request<Entity>;
392
+ /** Deletes an existing entity row matching the entity type and entity id specified in the request. */
393
+ delete(request?: {
394
+ /** V1 error format. */
395
+ '$.xgafv'?: string;
396
+ /** OAuth access token. */
397
+ access_token?: string;
398
+ /** Data format for response. */
399
+ alt?: string;
400
+ /** JSONP */
401
+ callback?: string;
402
+ /** Selector specifying which fields to include in a partial response. */
403
+ fields?: string;
404
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
405
+ key?: string;
406
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
407
+ name: string;
408
+ /** OAuth 2.0 token for the current user. */
409
+ oauth_token?: string;
410
+ /** Returns response with indentations and line breaks. */
411
+ prettyPrint?: boolean;
412
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
413
+ quotaUser?: string;
414
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
415
+ upload_protocol?: string;
416
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
417
+ uploadType?: string;
418
+ }): Request<{}>;
419
+ /** Deletes entities based on conditions specified in the request and not on entity id. */
420
+ deleteEntitiesWithConditions(request?: {
421
+ /** V1 error format. */
422
+ '$.xgafv'?: string;
423
+ /** OAuth access token. */
424
+ access_token?: string;
425
+ /** Data format for response. */
426
+ alt?: string;
427
+ /** JSONP */
428
+ callback?: string;
429
+ /** Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be. */
430
+ conditions?: string;
431
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
432
+ entityType: string;
433
+ /** Selector specifying which fields to include in a partial response. */
434
+ fields?: string;
435
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
436
+ key?: string;
437
+ /** OAuth 2.0 token for the current user. */
438
+ oauth_token?: string;
439
+ /** Returns response with indentations and line breaks. */
440
+ prettyPrint?: boolean;
441
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
442
+ quotaUser?: string;
443
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
444
+ upload_protocol?: string;
445
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
446
+ uploadType?: string;
447
+ }): Request<{}>;
448
+ /** Gets a single entity row matching the entity type and entity id specified in the request. */
449
+ get(request?: {
450
+ /** V1 error format. */
451
+ '$.xgafv'?: string;
452
+ /** OAuth access token. */
453
+ access_token?: string;
454
+ /** Data format for response. */
455
+ alt?: string;
456
+ /** JSONP */
457
+ callback?: string;
458
+ /** Selector specifying which fields to include in a partial response. */
459
+ fields?: string;
460
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
461
+ key?: string;
462
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
463
+ name: string;
464
+ /** OAuth 2.0 token for the current user. */
465
+ oauth_token?: string;
466
+ /** Returns response with indentations and line breaks. */
467
+ prettyPrint?: boolean;
468
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
469
+ quotaUser?: string;
470
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
471
+ upload_protocol?: string;
472
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
473
+ uploadType?: string;
474
+ }): Request<Entity>;
475
+ /** Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors. */
476
+ list(request?: {
477
+ /** V1 error format. */
478
+ '$.xgafv'?: string;
479
+ /** OAuth access token. */
480
+ access_token?: string;
481
+ /** Data format for response. */
482
+ alt?: string;
483
+ /** JSONP */
484
+ callback?: string;
485
+ /** Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. */
486
+ conditions?: string;
487
+ /** Selector specifying which fields to include in a partial response. */
488
+ fields?: string;
489
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
490
+ key?: string;
491
+ /** OAuth 2.0 token for the current user. */
492
+ oauth_token?: string;
493
+ /** Number of entity rows to return. Defaults page size = 25. Max page size = 200. */
494
+ pageSize?: number;
495
+ /** Page token value if available from a previous request. */
496
+ pageToken?: string;
497
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
498
+ parent: string;
499
+ /** Returns response with indentations and line breaks. */
500
+ prettyPrint?: boolean;
501
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
502
+ quotaUser?: string;
503
+ /** List of 'sort_by' columns to use when returning the results. */
504
+ sortBy?: string | string[];
505
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
506
+ upload_protocol?: string;
507
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
508
+ uploadType?: string;
509
+ }): Request<ListEntitiesResponse>;
510
+ /** Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system. */
511
+ patch(request: {
512
+ /** V1 error format. */
513
+ '$.xgafv'?: string;
514
+ /** OAuth access token. */
515
+ access_token?: string;
516
+ /** Data format for response. */
517
+ alt?: string;
518
+ /** JSONP */
519
+ callback?: string;
520
+ /** Selector specifying which fields to include in a partial response. */
521
+ fields?: string;
522
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
523
+ key?: string;
524
+ /** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
525
+ name: string;
526
+ /** OAuth 2.0 token for the current user. */
527
+ oauth_token?: string;
528
+ /** Returns response with indentations and line breaks. */
529
+ prettyPrint?: boolean;
530
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
531
+ quotaUser?: string;
532
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
533
+ upload_protocol?: string;
534
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
535
+ uploadType?: string;
536
+ /** Request body */
537
+ resource: Entity;
538
+ }): Request<Entity>;
539
+ patch(
540
+ request: {
541
+ /** V1 error format. */
542
+ '$.xgafv'?: string;
543
+ /** OAuth access token. */
544
+ access_token?: string;
545
+ /** Data format for response. */
546
+ alt?: string;
547
+ /** JSONP */
548
+ callback?: string;
549
+ /** Selector specifying which fields to include in a partial response. */
550
+ fields?: string;
551
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
552
+ key?: string;
553
+ /** Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} */
554
+ name: string;
555
+ /** OAuth 2.0 token for the current user. */
556
+ oauth_token?: string;
557
+ /** Returns response with indentations and line breaks. */
558
+ prettyPrint?: boolean;
559
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
560
+ quotaUser?: string;
561
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
562
+ upload_protocol?: string;
563
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
564
+ uploadType?: string;
565
+ },
566
+ body: Entity
567
+ ): Request<Entity>;
568
+ /** Updates entities based on conditions specified in the request and not on entity id. */
569
+ updateEntitiesWithConditions(request: {
570
+ /** V1 error format. */
571
+ '$.xgafv'?: string;
572
+ /** OAuth access token. */
573
+ access_token?: string;
574
+ /** Data format for response. */
575
+ alt?: string;
576
+ /** JSONP */
577
+ callback?: string;
578
+ /** Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be. */
579
+ conditions?: string;
580
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
581
+ entityType: string;
582
+ /** Selector specifying which fields to include in a partial response. */
583
+ fields?: string;
584
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
585
+ key?: string;
586
+ /** OAuth 2.0 token for the current user. */
587
+ oauth_token?: string;
588
+ /** Returns response with indentations and line breaks. */
589
+ prettyPrint?: boolean;
590
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
591
+ quotaUser?: string;
592
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
593
+ upload_protocol?: string;
594
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
595
+ uploadType?: string;
596
+ /** Request body */
597
+ resource: Entity;
598
+ }): Request<UpdateEntitiesWithConditionsResponse>;
599
+ updateEntitiesWithConditions(
600
+ request: {
601
+ /** V1 error format. */
602
+ '$.xgafv'?: string;
603
+ /** OAuth access token. */
604
+ access_token?: string;
605
+ /** Data format for response. */
606
+ alt?: string;
607
+ /** JSONP */
608
+ callback?: string;
609
+ /** Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be. */
610
+ conditions?: string;
611
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} */
612
+ entityType: string;
613
+ /** Selector specifying which fields to include in a partial response. */
614
+ fields?: string;
615
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
616
+ key?: string;
617
+ /** OAuth 2.0 token for the current user. */
618
+ oauth_token?: string;
619
+ /** Returns response with indentations and line breaks. */
620
+ prettyPrint?: boolean;
621
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
622
+ quotaUser?: string;
623
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
624
+ upload_protocol?: string;
625
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
626
+ uploadType?: string;
627
+ },
628
+ body: Entity
629
+ ): Request<UpdateEntitiesWithConditionsResponse>;
630
+ }
631
+ interface EntityTypesResource {
632
+ /** Gets metadata of given entity type */
633
+ get(request?: {
634
+ /** V1 error format. */
635
+ '$.xgafv'?: string;
636
+ /** OAuth access token. */
637
+ access_token?: string;
638
+ /** Data format for response. */
639
+ alt?: string;
640
+ /** JSONP */
641
+ callback?: string;
642
+ /** Selector specifying which fields to include in a partial response. */
643
+ fields?: string;
644
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
645
+ key?: string;
646
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} */
647
+ name: string;
648
+ /** OAuth 2.0 token for the current user. */
649
+ oauth_token?: string;
650
+ /** Returns response with indentations and line breaks. */
651
+ prettyPrint?: boolean;
652
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
653
+ quotaUser?: string;
654
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
655
+ upload_protocol?: string;
656
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
657
+ uploadType?: string;
658
+ }): Request<EntityType>;
659
+ /** Lists metadata related to all entity types present in the external system. */
660
+ list(request?: {
661
+ /** V1 error format. */
662
+ '$.xgafv'?: string;
663
+ /** OAuth access token. */
664
+ access_token?: string;
665
+ /** Data format for response. */
666
+ alt?: string;
667
+ /** JSONP */
668
+ callback?: string;
669
+ /** Selector specifying which fields to include in a partial response. */
670
+ fields?: string;
671
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
672
+ key?: string;
673
+ /** OAuth 2.0 token for the current user. */
674
+ oauth_token?: string;
675
+ /** Number of entity types to return. Defaults to 25. */
676
+ pageSize?: number;
677
+ /** Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types. */
678
+ pageToken?: string;
679
+ /** Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection} */
680
+ parent: string;
681
+ /** Returns response with indentations and line breaks. */
682
+ prettyPrint?: boolean;
683
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
684
+ quotaUser?: string;
685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
686
+ upload_protocol?: string;
687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
688
+ uploadType?: string;
689
+ /** Specifies which fields of the Entity Type are returned in the response. */
690
+ view?: string;
691
+ }): Request<ListEntityTypesResponse>;
692
+ entities: EntitiesResource;
693
+ }
694
+ interface ConnectionsResource {
695
+ /** Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand. */
696
+ checkReadiness(request?: {
697
+ /** V1 error format. */
698
+ '$.xgafv'?: string;
699
+ /** OAuth access token. */
700
+ access_token?: string;
701
+ /** Data format for response. */
702
+ alt?: string;
703
+ /** JSONP */
704
+ callback?: string;
705
+ /** Selector specifying which fields to include in a partial response. */
706
+ fields?: string;
707
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
708
+ key?: string;
709
+ name: string;
710
+ /** OAuth 2.0 token for the current user. */
711
+ oauth_token?: string;
712
+ /** Returns response with indentations and line breaks. */
713
+ prettyPrint?: boolean;
714
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
715
+ quotaUser?: string;
716
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
717
+ upload_protocol?: string;
718
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
719
+ uploadType?: string;
720
+ }): Request<CheckReadinessResponse>;
721
+ /** Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed. */
722
+ checkStatus(request?: {
723
+ /** V1 error format. */
724
+ '$.xgafv'?: string;
725
+ /** OAuth access token. */
726
+ access_token?: string;
727
+ /** Data format for response. */
728
+ alt?: string;
729
+ /** JSONP */
730
+ callback?: string;
731
+ /** Selector specifying which fields to include in a partial response. */
732
+ fields?: string;
733
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
734
+ key?: string;
735
+ name: string;
736
+ /** OAuth 2.0 token for the current user. */
737
+ oauth_token?: string;
738
+ /** Returns response with indentations and line breaks. */
739
+ prettyPrint?: boolean;
740
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
741
+ quotaUser?: string;
742
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
743
+ upload_protocol?: string;
744
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
745
+ uploadType?: string;
746
+ }): Request<CheckStatusResponse>;
747
+ /** ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials). */
748
+ exchangeAuthCode(request: {
749
+ /** V1 error format. */
750
+ '$.xgafv'?: string;
751
+ /** OAuth access token. */
752
+ access_token?: string;
753
+ /** Data format for response. */
754
+ alt?: string;
755
+ /** JSONP */
756
+ callback?: string;
757
+ /** Selector specifying which fields to include in a partial response. */
758
+ fields?: string;
759
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
760
+ key?: string;
761
+ name: string;
762
+ /** OAuth 2.0 token for the current user. */
763
+ oauth_token?: string;
764
+ /** Returns response with indentations and line breaks. */
765
+ prettyPrint?: boolean;
766
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
767
+ quotaUser?: string;
768
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
769
+ upload_protocol?: string;
770
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
771
+ uploadType?: string;
772
+ /** Request body */
773
+ resource: ExchangeAuthCodeRequest;
774
+ }): Request<ExchangeAuthCodeResponse>;
775
+ exchangeAuthCode(
776
+ request: {
777
+ /** V1 error format. */
778
+ '$.xgafv'?: string;
779
+ /** OAuth access token. */
780
+ access_token?: string;
781
+ /** Data format for response. */
782
+ alt?: string;
783
+ /** JSONP */
784
+ callback?: string;
785
+ /** Selector specifying which fields to include in a partial response. */
786
+ fields?: string;
787
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
788
+ key?: string;
789
+ name: string;
790
+ /** OAuth 2.0 token for the current user. */
791
+ oauth_token?: string;
792
+ /** Returns response with indentations and line breaks. */
793
+ prettyPrint?: boolean;
794
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
795
+ quotaUser?: string;
796
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
797
+ upload_protocol?: string;
798
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
799
+ uploadType?: string;
800
+ },
801
+ body: ExchangeAuthCodeRequest
802
+ ): Request<ExchangeAuthCodeResponse>;
803
+ /** Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'. */
804
+ executeSqlQuery(request: {
805
+ /** V1 error format. */
806
+ '$.xgafv'?: string;
807
+ /** OAuth access token. */
808
+ access_token?: string;
809
+ /** Data format for response. */
810
+ alt?: string;
811
+ /** JSONP */
812
+ callback?: string;
813
+ /** Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} */
814
+ connection: string;
815
+ /** Selector specifying which fields to include in a partial response. */
816
+ fields?: string;
817
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
818
+ key?: string;
819
+ /** OAuth 2.0 token for the current user. */
820
+ oauth_token?: string;
821
+ /** Returns response with indentations and line breaks. */
822
+ prettyPrint?: boolean;
823
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
824
+ quotaUser?: string;
825
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
826
+ upload_protocol?: string;
827
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
828
+ uploadType?: string;
829
+ /** Request body */
830
+ resource: ExecuteSqlQueryRequest;
831
+ }): Request<ExecuteSqlQueryResponse>;
832
+ executeSqlQuery(
833
+ request: {
834
+ /** V1 error format. */
835
+ '$.xgafv'?: string;
836
+ /** OAuth access token. */
837
+ access_token?: string;
838
+ /** Data format for response. */
839
+ alt?: string;
840
+ /** JSONP */
841
+ callback?: string;
842
+ /** Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} */
843
+ connection: string;
844
+ /** Selector specifying which fields to include in a partial response. */
845
+ fields?: string;
846
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
847
+ key?: string;
848
+ /** OAuth 2.0 token for the current user. */
849
+ oauth_token?: string;
850
+ /** Returns response with indentations and line breaks. */
851
+ prettyPrint?: boolean;
852
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
853
+ quotaUser?: string;
854
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
855
+ upload_protocol?: string;
856
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
857
+ uploadType?: string;
858
+ },
859
+ body: ExecuteSqlQueryRequest
860
+ ): Request<ExecuteSqlQueryResponse>;
861
+ /** RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials). */
862
+ refreshAccessToken(request: {
863
+ /** V1 error format. */
864
+ '$.xgafv'?: string;
865
+ /** OAuth access token. */
866
+ access_token?: string;
867
+ /** Data format for response. */
868
+ alt?: string;
869
+ /** JSONP */
870
+ callback?: string;
871
+ /** Selector specifying which fields to include in a partial response. */
872
+ fields?: string;
873
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
874
+ key?: string;
875
+ name: string;
876
+ /** OAuth 2.0 token for the current user. */
877
+ oauth_token?: string;
878
+ /** Returns response with indentations and line breaks. */
879
+ prettyPrint?: boolean;
880
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
881
+ quotaUser?: string;
882
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
883
+ upload_protocol?: string;
884
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
885
+ uploadType?: string;
886
+ /** Request body */
887
+ resource: RefreshAccessTokenRequest;
888
+ }): Request<RefreshAccessTokenResponse>;
889
+ refreshAccessToken(
890
+ request: {
891
+ /** V1 error format. */
892
+ '$.xgafv'?: string;
893
+ /** OAuth access token. */
894
+ access_token?: string;
895
+ /** Data format for response. */
896
+ alt?: string;
897
+ /** JSONP */
898
+ callback?: string;
899
+ /** Selector specifying which fields to include in a partial response. */
900
+ fields?: string;
901
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
902
+ key?: string;
903
+ name: string;
904
+ /** OAuth 2.0 token for the current user. */
905
+ oauth_token?: string;
906
+ /** Returns response with indentations and line breaks. */
907
+ prettyPrint?: boolean;
908
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
909
+ quotaUser?: string;
910
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
911
+ upload_protocol?: string;
912
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
913
+ uploadType?: string;
914
+ },
915
+ body: RefreshAccessTokenRequest
916
+ ): Request<RefreshAccessTokenResponse>;
917
+ actions: ActionsResource;
918
+ entityTypes: EntityTypesResource;
919
+ }
920
+ interface LocationsResource {
921
+ connections: ConnectionsResource;
922
+ }
923
+ interface ProjectsResource {
924
+ locations: LocationsResource;
925
+ }
926
+
927
+ const projects: ProjectsResource;
928
+ }
1068
929
  }