-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
connectors-api.json
2463 lines (2463 loc) · 97.5 KB
/
connectors-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://connectors.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Connectors",
"description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "connectors:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://connectors.mtls.googleapis.com/",
"name": "connectors",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "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.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"connections": {
"methods": {
"checkReadiness": {
"description": "Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkReadiness",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.checkReadiness",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:checkReadiness",
"response": {
"$ref": "CheckReadinessResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"checkStatus": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.checkStatus",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:checkStatus",
"response": {
"$ref": "CheckStatusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"exchangeAuthCode": {
"description": "ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:exchangeAuthCode",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.exchangeAuthCode",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:exchangeAuthCode",
"request": {
"$ref": "ExchangeAuthCodeRequest"
},
"response": {
"$ref": "ExchangeAuthCodeResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"executeSqlQuery": {
"description": "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'.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeSqlQuery",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.executeSqlQuery",
"parameterOrder": [
"connection"
],
"parameters": {
"connection": {
"description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+connection}:executeSqlQuery",
"request": {
"$ref": "ExecuteSqlQueryRequest"
},
"response": {
"$ref": "ExecuteSqlQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"refreshAccessToken": {
"description": "RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.refreshAccessToken",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:refreshAccessToken",
"request": {
"$ref": "RefreshAccessTokenRequest"
},
"response": {
"$ref": "RefreshAccessTokenResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"actions": {
"methods": {
"execute": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}:execute",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.actions.execute",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:execute",
"request": {
"$ref": "ExecuteActionRequest"
},
"response": {
"$ref": "ExecuteActionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the schema of the given action.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.actions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Action"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Gets the schema of all the actions supported by the connector.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.actions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Number of Actions to return. Defaults to 25.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Specifies which fields of the Action are returned in the response.",
"enum": [
"ACTION_VIEW_UNSPECIFIED",
"ACTION_VIEW_BASIC",
"ACTION_VIEW_FULL"
],
"enumDescriptions": [
"VIEW_UNSPECIFIED. The unset value Defaults to FULL View.",
"Return only action names.",
"Return actions with schema."
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/actions",
"response": {
"$ref": "ListActionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"entityTypes": {
"methods": {
"get": {
"description": "Gets metadata of given entity type",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.entityTypes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "EntityType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists metadata related to all entity types present in the external system.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.entityTypes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Number of entity types to return. Defaults to 25.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "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.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Specifies which fields of the Entity Type are returned in the response.",
"enum": [
"ENTITY_TYPE_VIEW_UNSPECIFIED",
"ENTITY_TYPE_VIEW_BASIC",
"ENTITY_TYPE_VIEW_FULL"
],
"enumDescriptions": [
"VIEW_UNSPECIFIED. The unset value. Defaults to FULL View.",
"Return only entity type names.",
"Return entity types with schema"
],
"location": "query",
"type": "string"
}
},
"path": "v2/{+parent}/entityTypes",
"response": {
"$ref": "ListEntityTypesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"entities": {
"methods": {
"create": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.entityTypes.entities.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities",
"request": {
"$ref": "Entity"
},
"response": {
"$ref": "Entity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an existing entity row matching the entity type and entity id specified in the request.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}",
"httpMethod": "DELETE",
"id": "connectors.projects.locations.connections.entityTypes.entities.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"deleteEntitiesWithConditions": {
"description": "Deletes entities based on conditions specified in the request and not on entity id.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:deleteEntitiesWithConditions",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.entityTypes.entities.deleteEntitiesWithConditions",
"parameterOrder": [
"entityType"
],
"parameters": {
"conditions": {
"description": "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.",
"location": "query",
"type": "string"
},
"entityType": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+entityType}/entities:deleteEntitiesWithConditions",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a single entity row matching the entity type and entity id specified in the request.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.entityTypes.entities.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Entity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities",
"httpMethod": "GET",
"id": "connectors.projects.locations.connections.entityTypes.entities.list",
"parameterOrder": [
"parent"
],
"parameters": {
"conditions": {
"description": "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.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Number of entity rows to return. Defaults page size = 25. Max page size = 200.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token value if available from a previous request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
},
"sortBy": {
"description": "List of 'sort_by' columns to use when returning the results.",
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "v2/{+parent}/entities",
"response": {
"$ref": "ListEntitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "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.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}",
"httpMethod": "PATCH",
"id": "connectors.projects.locations.connections.entityTypes.entities.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "Entity"
},
"response": {
"$ref": "Entity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateEntitiesWithConditions": {
"description": "Updates entities based on conditions specified in the request and not on entity id.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:updateEntitiesWithConditions",
"httpMethod": "POST",
"id": "connectors.projects.locations.connections.entityTypes.entities.updateEntitiesWithConditions",
"parameterOrder": [
"entityType"
],
"parameters": {
"conditions": {
"description": "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.",
"location": "query",
"type": "string"
},
"entityType": {
"description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+entityType}/entities:updateEntitiesWithConditions",
"request": {
"$ref": "Entity"
},
"response": {
"$ref": "UpdateEntitiesWithConditionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
}
}
}
}
},
"revision": "20240415",
"rootUrl": "https://connectors.googleapis.com/",
"schemas": {
"AccessCredentials": {
"description": "AccessCredentials includes the OAuth access token, and the other fields returned along with it.",
"id": "AccessCredentials",
"properties": {
"accessToken": {
"description": "OAuth access token.",
"type": "string"
},
"expiresIn": {
"description": "Duration till the access token expires.",
"format": "google-duration",
"type": "string"
},
"refreshToken": {
"description": "OAuth refresh token.",
"type": "string"
}
},
"type": "object"
},
"Action": {
"description": "Action message contains metadata information about a single action present in the external system.",
"id": "Action",
"properties": {
"description": {
"description": "Brief Description of action",
"type": "string"
},
"displayName": {
"description": "Display Name of action to be shown on client side",
"type": "string"
},
"inputJsonSchema": {
"$ref": "JsonSchema",
"description": "JsonSchema representation of this actions's input schema"
},
"inputParameters": {
"description": "List containing input parameter metadata.",
"items": {
"$ref": "InputParameter"
},
"type": "array"
},
"name": {
"description": "Name of the action.",
"type": "string"
},
"resultJsonSchema": {
"$ref": "JsonSchema",
"description": "JsonSchema representation of this actions's result schema"
},
"resultMetadata": {
"description": "List containing the metadata of result fields.",
"items": {
"$ref": "ResultMetadata"
},
"type": "array"
}
},
"type": "object"
},
"CheckReadinessResponse": {
"description": "Response containing status of the connector for readiness prober.",
"id": "CheckReadinessResponse",
"properties": {
"status": {
"type": "string"
}
},
"type": "object"
},
"CheckStatusResponse": {
"description": "The status of the connector.",
"id": "CheckStatusResponse",
"properties": {
"description": {
"description": "When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state.",
"type": "string"
},
"state": {
"description": "State of the connector.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"ERROR",
"AUTH_ERROR"
],
"enumDescriptions": [
"State unspecified.",
"The connector is active and ready to process runtime requests. This can also mean that from the connector's perspective, the connector is not in an error state and should be able to process runtime requests successfully.",
"The connector is in an error state and cannot process runtime requests. An example reason would be that the connection container has some network issues that prevent outbound requests from being sent.",
"This is a more specific error state that the developers can opt to use when the connector is facing auth-related errors caused by auth configuration not present, invalid auth credentials, etc."
],
"type": "string"
}
},
"type": "object"
},
"DailyCycle": {
"description": "Time window specified for daily operations.",
"id": "DailyCycle",
"properties": {
"duration": {
"description": "Output only. Duration of the time window, set by service producer.",
"format": "google-duration",
"type": "string"
},
"startTime": {
"$ref": "TimeOfDay",
"description": "Time within the day to start the operations."
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DenyMaintenancePeriod": {
"description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.",
"id": "DenyMaintenancePeriod",
"properties": {
"endDate": {
"$ref": "Date",
"description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end."
},
"startDate": {
"$ref": "Date",
"description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start."
},
"time": {
"$ref": "TimeOfDay",
"description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC"
}
},
"type": "object"
},
"Empty": {
"description": "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); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"Entity": {
"description": "'Entity row'/ 'Entity' refers to a single row of an entity type.",
"id": "Entity",
"properties": {
"fields": {
"additionalProperties": {
"type": "any"
},
"description": "Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.",
"type": "object"
},
"name": {
"description": "Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"EntityType": {
"description": "EntityType message contains metadata information about a single entity type present in the external system.",
"id": "EntityType",
"properties": {
"fields": {
"description": "List containing metadata information about each field of the entity type.",
"items": {
"$ref": "Field"
},
"type": "array"
},
"jsonSchema": {
"$ref": "JsonSchema",
"description": "JsonSchema representation of this entity's schema"
},
"name": {
"description": "The name of the entity type.",
"type": "string"
},
"operations": {
"items": {
"enum": [
"OPERATION_UNSPECIFIED",
"LIST",
"GET",
"CREATE",
"UPDATE",
"DELETE"
],
"enumDescriptions": [
"Operation unspecified.",
"This operation means entity type supports LIST method.",
"This operation means entity type supports GET method.",
"This operation means entity type supports CREATE method.",
"This operation means entity type supports UPDATE method.",
"This operation means entity type supports DELETE method."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ExchangeAuthCodeRequest": {
"description": "ExchangeAuthCodeRequest currently includes no fields.",
"id": "ExchangeAuthCodeRequest",
"properties": {},
"type": "object"
},
"ExchangeAuthCodeResponse": {
"description": "ExchangeAuthCodeResponse includes the returned access token and its associated credentials.",
"id": "ExchangeAuthCodeResponse",
"properties": {
"accessCredentials": {
"$ref": "AccessCredentials"
}
},
"type": "object"
},
"ExecuteActionRequest": {
"description": "Request message for ActionService.ExecuteAction",
"id": "ExecuteActionRequest",
"properties": {
"parameters": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Parameters for executing the action. The parameters can be key/value pairs or nested structs.",
"type": "object"
}
},
"type": "object"
},
"ExecuteActionResponse": {
"description": "Response message for ActionService.ExecuteAction",
"id": "ExecuteActionResponse",
"properties": {
"results": {
"description": "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'}, ...] }",
"items": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"ExecuteSqlQueryRequest": {
"description": "An execute sql query request containing the query and the connection to execute it on.",
"id": "ExecuteSqlQueryRequest",
"properties": {
"query": {
"$ref": "Query",
"description": "Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems."
}
},
"type": "object"
},
"ExecuteSqlQueryResponse": {
"description": "A response returned by the connection after executing the sql query.",
"id": "ExecuteSqlQueryResponse",
"properties": {
"results": {
"description": "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.",
"items": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Field": {
"description": "Message contains EntityType's Field metadata.",
"id": "Field",
"properties": {
"additionalDetails": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.",
"type": "object"
},
"dataType": {
"description": "The data type of the Field.",
"enum": [
"DATA_TYPE_UNSPECIFIED",
"INT",
"SMALLINT",
"DOUBLE",
"DATE",
"DATETIME",
"TIME",
"STRING",
"LONG",
"BOOLEAN",
"DECIMAL",
"UUID",
"BLOB",
"BIT",
"TINYINT",
"INTEGER",
"BIGINT",
"FLOAT",