-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
connectors_v1.projects.locations.providers.connectors.versions.html
1358 lines (1330 loc) 路 112 KB
/
connectors_v1.projects.locations.providers.connectors.versions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.providers.html">providers</a> . <a href="connectors_v1.projects.locations.providers.connectors.html">connectors</a> . <a href="connectors_v1.projects.locations.providers.connectors.versions.html">versions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html">eventtypes()</a></code>
</p>
<p class="firstline">Returns the eventtypes Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single connector version.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Connector Versions in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets details of a single connector version.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for ConnectorVersion resource. (required)
view: string, Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view.
Allowed values
CONNECTOR_VERSION_VIEW_UNSPECIFIED - CONNECTOR_VERSION_VIEW_UNSPECIFIED.
CONNECTOR_VERSION_VIEW_BASIC - Do not include role grant configs.
CONNECTOR_VERSION_VIEW_FULL - Include role grant configs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ConnectorVersion indicates a specific version of a connector.
"authConfigTemplates": [ # Output only. List of auth configs supported by the Connector Version.
{ # AuthConfigTemplate defines required field over an authentication type.
"authKey": "A String", # Identifier key for auth config
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"description": "A String", # Connector specific description for an authentication template.
"displayName": "A String", # Display name for authentication template.
},
],
"authOverrideEnabled": True or False, # Output only. Flag to mark the dynamic auth override.
"configVariableTemplates": [ # Output only. List of config variables needed to create a connection.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector.
"connectionRatelimitWindowSeconds": "A String", # The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Indicate whether connector is deployed on GKE/CloudRun
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd.
"ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # The name of shared connector deployment.
},
"createTime": "A String", # Output only. Created time.
"destinationConfigTemplates": [ # Output only. List of destination configs needed to create a connection.
{ # DestinationConfigTemplate defines required destinations supported by the Connector.
"autocompleteSuggestions": [ # Autocomplete suggestions for destination URL field.
"A String",
],
"defaultPort": 42, # The default port.
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings
"key": "A String", # Key of the destination.
"max": 42, # The maximum number of destinations supported for this key.
"min": 42, # The minimum number of destinations supported for this key.
"portFieldType": "A String", # Whether port number should be provided by customers.
"regexPattern": "A String", # Regex pattern for host.
},
],
"displayName": "A String", # Output only. Display name.
"egressControlConfig": { # Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource. # Output only. Configuration for Egress Control.
"backends": "A String", # Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).
"extractionRules": { # Extraction Rules to identity the backends from customer provided configuration in Connection resource. # Extractions Rules to extract the backends from customer provided configuration.
"extractionRule": [ # Collection of Extraction Rule.
{ # Extraction Rule.
"extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used.
"source": { # Source to extract the backend from. # Source on which the rule is applied.
"fieldId": "A String", # Field identifier. For example config vaiable name.
"sourceType": "A String", # Type of the source.
},
},
],
},
},
"eventingConfigTemplate": { # Eventing Config details of a connector version. # Output only. Eventing configuration supported by the Connector.
"additionalVariables": [ # Additional fields that need to be rendered.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"authConfigTemplates": [ # AuthConfigTemplates represents the auth values for the webhook adapter.
{ # AuthConfigTemplate defines required field over an authentication type.
"authKey": "A String", # Identifier key for auth config
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"description": "A String", # Connector specific description for an authentication template.
"displayName": "A String", # Display name for authentication template.
},
],
"autoRefresh": True or False, # Auto refresh to extend webhook life.
"autoRegistrationSupported": True or False, # Auto Registration supported.
"encryptionKeyTemplate": { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. # Encryption key (can be either Google managed or CMEK).
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
"enrichmentSupported": True or False, # Enrichment Supported.
"eventListenerType": "A String", # The type of the event listener for a specific connector.
"isEventingSupported": True or False, # Is Eventing Supported.
"listenerAuthConfigTemplates": [ # ListenerAuthConfigTemplates represents the auth values for the event listener.
{ # AuthConfigTemplate defines required field over an authentication type.
"authKey": "A String", # Identifier key for auth config
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"description": "A String", # Connector specific description for an authentication template.
"displayName": "A String", # Display name for authentication template.
},
],
"proxyDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Proxy destination config template.
"autocompleteSuggestions": [ # Autocomplete suggestions for destination URL field.
"A String",
],
"defaultPort": 42, # The default port.
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings
"key": "A String", # Key of the destination.
"max": 42, # The maximum number of destinations supported for this key.
"min": 42, # The minimum number of destinations supported for this key.
"portFieldType": "A String", # Whether port number should be provided by customers.
"regexPattern": "A String", # Regex pattern for host.
},
"registrationDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template.
"autocompleteSuggestions": [ # Autocomplete suggestions for destination URL field.
"A String",
],
"defaultPort": 42, # The default port.
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings
"key": "A String", # Key of the destination.
"max": 42, # The maximum number of destinations supported for this key.
"min": 42, # The minimum number of destinations supported for this key.
"portFieldType": "A String", # Whether port number should be provided by customers.
"regexPattern": "A String", # Regex pattern for host.
},
"triggerConfigVariables": [ # Trigger Config fields that needs to be rendered
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
},
"labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"launchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"name": "A String", # Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} Only global location is supported for Connector resource.
"releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha".
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"roleGrants": [ # Output only. Role grant configurations for this connector version.
{ # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
],
"schemaRefreshConfig": { # Config for connection schema refresh # Connection Schema Refresh Config
"useActionDisplayNames": True or False, # Whether to use displayName for actions in UI.
"useSynchronousSchemaRefresh": True or False, # Whether to use synchronous schema refresh.
},
"sslConfigTemplate": { # Ssl config details of a connector version # Output only. Ssl configuration supported by the Connector.
"additionalVariables": [ # Any additional fields that need to be rendered
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"clientCertType": [ # List of supported Client Cert Types
"A String",
],
"isTlsMandatory": True or False, # Boolean for determining if the connector version mandates TLS.
"serverCertType": [ # List of supported Server Cert Types
"A String",
],
"sslType": "A String", # Controls the ssl type for the given connector version
},
"supportedRuntimeFeatures": { # Supported runtime features of a connector version. # Output only. Information about the runtime features supported by the Connector.
"actionApis": True or False, # Specifies if the connector supports action apis like 'executeAction'.
"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'.
"sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation.
},
"unsupportedConnectionTypes": [ # Output only. Unsupported connection types.
"A String",
],
"updateTime": "A String", # Output only. Updated time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists Connector Versions in a given project and location.
Args:
parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*` Only global location is supported for ConnectorVersion resource. (required)
pageSize: integer, Page size.
pageToken: string, Page token.
view: string, Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `BASIC` view.
Allowed values
CONNECTOR_VERSION_VIEW_UNSPECIFIED - CONNECTOR_VERSION_VIEW_UNSPECIFIED.
CONNECTOR_VERSION_VIEW_BASIC - Do not include role grant configs.
CONNECTOR_VERSION_VIEW_FULL - Include role grant configs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Connectors.ListConnectorVersions.
"connectorVersions": [ # A list of connector versions.
{ # ConnectorVersion indicates a specific version of a connector.
"authConfigTemplates": [ # Output only. List of auth configs supported by the Connector Version.
{ # AuthConfigTemplate defines required field over an authentication type.
"authKey": "A String", # Identifier key for auth config
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"description": "A String", # Connector specific description for an authentication template.
"displayName": "A String", # Display name for authentication template.
},
],
"authOverrideEnabled": True or False, # Output only. Flag to mark the dynamic auth override.
"configVariableTemplates": [ # Output only. List of config variables needed to create a connection.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector.
"connectionRatelimitWindowSeconds": "A String", # The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Indicate whether connector is deployed on GKE/CloudRun
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd.
"ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits.
"cpu": "A String", # Output only. CPU limit.
"memory": "A String", # Output only. Memory limit.
},
"resourceRequests": { # Resource requests defined for connection pods of a given connector type. # System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # The name of shared connector deployment.
},
"createTime": "A String", # Output only. Created time.
"destinationConfigTemplates": [ # Output only. List of destination configs needed to create a connection.
{ # DestinationConfigTemplate defines required destinations supported by the Connector.
"autocompleteSuggestions": [ # Autocomplete suggestions for destination URL field.
"A String",
],
"defaultPort": 42, # The default port.
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings
"key": "A String", # Key of the destination.
"max": 42, # The maximum number of destinations supported for this key.
"min": 42, # The minimum number of destinations supported for this key.
"portFieldType": "A String", # Whether port number should be provided by customers.
"regexPattern": "A String", # Regex pattern for host.
},
],
"displayName": "A String", # Output only. Display name.
"egressControlConfig": { # Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource. # Output only. Configuration for Egress Control.
"backends": "A String", # Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).
"extractionRules": { # Extraction Rules to identity the backends from customer provided configuration in Connection resource. # Extractions Rules to extract the backends from customer provided configuration.
"extractionRule": [ # Collection of Extraction Rule.
{ # Extraction Rule.
"extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used.
"source": { # Source to extract the backend from. # Source on which the rule is applied.
"fieldId": "A String", # Field identifier. For example config vaiable name.
"sourceType": "A String", # Type of the source.
},
},
],
},
},
"eventingConfigTemplate": { # Eventing Config details of a connector version. # Output only. Eventing configuration supported by the Connector.
"additionalVariables": [ # Additional fields that need to be rendered.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # The logical operator to use between the fields and conditions.
},
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a Google Cloud resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"authConfigTemplates": [ # AuthConfigTemplates represents the auth values for the webhook adapter.
{ # AuthConfigTemplate defines required field over an authentication type.
"authKey": "A String", # Identifier key for auth config
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Indicates if current template is part of advanced settings
"key": "A String", # Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Key of the field.
"stringValue": "A String", # String value
},
],