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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
|
<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.global_.html">global_</a> . <a href="connectors_v1.projects.locations.global_.customConnectors.html">customConnectors</a> . <a href="connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html">customConnectorVersions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, customConnectorVersionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new CustomConnectorVersion in a given project and location.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single CustomConnectorVersion.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List CustomConnectorVersions in a given project</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, customConnectorVersionId=None, x__xgafv=None)</code>
<pre>Creates a new CustomConnectorVersion in a given project and location.
Args:
parent: string, Required. Parent resource of the CreateCustomConnector, of the form: `projects/{project}/locations/{location}/customConnectors/{custom_connector}` (required)
body: object, The request body.
The object takes the form of:
{ # CustomConnectorVersion indicates a specific version of a connector.
"asyncOperationsSupport": True or False, # Optional. Indicates if Async Operations/Connector Job is supported. This is only available for SDK based custom connectors.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector service (facade). This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
"authType": "A String", # Optional. The type of authentication configured.
"oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Optional. Auth URL for Authorization Code Flow
"clientId": "A String", # Optional. Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
"clientId": "A String", # Optional. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing the client secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
"clientKey": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # Optional. JwtClaims providers fields to generate the token.
"audience": "A String", # Optional. Value for the "aud" claim.
"issuer": "A String", # Optional. Value for the "iss" claim.
"subject": "A String", # Optional. Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Optional. Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # Optional. SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Optional. Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Optional. The user account used to authenticate.
},
"userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
"password": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing the password.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Optional. Username.
},
},
"authConfigTemplates": [ # Optional. Auth Config Templates is only used when connector backend is enabled. This is used to specify the auth configs supported by the connector backend service to talk to the actual application backend.
{ # 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. # Optional. Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE for the auth code flow.
"omitQueryParams": True or False, # Optional. Omit query params from the redirect URI.
"scopes": [ # Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # Optional. The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Optional. Description.
"displayName": "A String", # Optional. Display name of the parameter.
"enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Optional. Display name of the option.
"id": "A String", # Optional. Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings
"key": "A String", # Optional. Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable.
"allowCustomValues": True or False, # Optional. Allow custom values.
"multipleSelectOptions": [ # Required. Multiple select options.
{ # MultiplSelecteOption represents the single option for a config variable.
"description": "A String", # Optional. Value of the option.
"displayName": "A String", # Required. Display name of the option.
"key": "A String", # Required. Key of the option.
"preselected": True or False, # Optional. Indicates if the option is preselected.
},
],
"valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
},
"required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # Optional. A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Optional. Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Optional. Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # Optional. A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # Optional. 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. # Optional. Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers.
"principal": "A String", # Optional. Principal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Optional. 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", # Optional. Different types of resource supported.
},
"roles": [ # Optional. List of roles that need to be granted.
"A String",
],
},
"state": "A String", # Output only. State of the config variable.
"validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Optional. 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.
"isDefault": True or False, # Whether the auth config is the default one.
},
],
"authOverrideSupport": True or False, # Optional. Auth override support.
"backendVariableTemplates": [ # Optional. Backend variable templates is only used when connector backend is enabled. This is used to specify the variables required by the connector backend service to talk to the actual application backend. This translates to additional variable templates in the connection config.
{ # 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. # Optional. Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE for the auth code flow.
"omitQueryParams": True or False, # Optional. Omit query params from the redirect URI.
"scopes": [ # Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # Optional. The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Optional. Description.
"displayName": "A String", # Optional. Display name of the parameter.
"enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Optional. Display name of the option.
"id": "A String", # Optional. Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings
"key": "A String", # Optional. Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable.
"allowCustomValues": True or False, # Optional. Allow custom values.
"multipleSelectOptions": [ # Required. Multiple select options.
{ # MultiplSelecteOption represents the single option for a config variable.
"description": "A String", # Optional. Value of the option.
"displayName": "A String", # Required. Display name of the option.
"key": "A String", # Required. Key of the option.
"preselected": True or False, # Optional. Indicates if the option is preselected.
},
],
"valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
},
"required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # Optional. A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Optional. Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Optional. Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # Optional. A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # Optional. 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. # Optional. Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers.
"principal": "A String", # Optional. Principal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Optional. 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", # Optional. Different types of resource supported.
},
"roles": [ # Optional. List of roles that need to be granted.
"A String",
],
},
"state": "A String", # Output only. State of the config variable.
"validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Optional. Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"createTime": "A String", # Output only. Created time.
"destinationConfigs": [ # Optional. Destination config(s) for accessing connector service (facade). This is used only when enable_backend_destination_config is true.
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"enableBackendDestinationConfig": True or False, # Optional. Indicates if an intermediatory connectorservice is used as backend. When this is enabled, the connector destination and connector auth config are required. For SDK based connectors, this is always enabled.
"labels": { # Optional. 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",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
"partnerMetadata": { # Partner metadata details. This will be populated when publishing the custom connector as a partner connector version. On publishing, parntner connector version will be created using the fields in PartnerMetadata. # Optional. Partner metadata details. This should be populated only when publishing the custom connector to partner connector.
"acceptGcpTos": True or False, # Required. Whether the user has accepted the Google Cloud Platform Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Marketplace Terms of Service (https://cloud.google.com/terms/marketplace/launcher?hl=en).
"additionalComments": "A String", # Optional. Additional comments for the submission.
"confirmPartnerRequirements": True or False, # Required. Confirmation that connector meets all applicable requirements mentioned in the Partner Connector Publishing requirements list and Partner onboardiong requirements list (https://cloud.google.com/marketplace/docs/partners/get-started#requirements).
"demoUri": "A String", # Required. Public URL for the demo video.
"hasDynamicSpecUri": True or False, # Output only. Has dynamic open api spec uri.
"integrationTemplates": "A String", # Required. Integration example templates for the custom connector.
"localSpecPath": "A String", # Output only. Local spec path. Required if has_dynamic_spec_uri is true.
"marketplaceProduct": "A String", # Optional. Marketplace product name.
"marketplaceProductId": "A String", # Required. Marketplace product ID.
"marketplaceProductProjectId": "A String", # Optional. Marketplace product project ID.
"marketplaceProductUri": "A String", # Optional. Marketplace product URL.
"partner": "A String", # Required. Partner name.
"partnerConnectorDisplayName": "A String", # Required. Partner connector display name.
"publishRequestTime": "A String", # Output only. Publish request time.
"targetApplication": "A String", # Required. Target application for which partner connector is built.
"targetCustomerSegment": "A String", # Required. Target customer segment for the partner connector.
"useCases": "A String", # Required. Details about partner connector use cases.
},
"publishStatus": { # Publish status of a custom connector. # Output only. Publish status of a custom connector.
"publishState": "A String", # Output only. Publish state of the custom connector.
"publishTime": "A String", # Output only. Publish time.
"publishedAs": "A String", # Output only. Partner connector name. Will be set on the custom connector. Format: providers/partner/connectors//versions/
"publishedSource": "A String", # Output only. Custom connector name. Will be set on the partner connector. Format: providers/customconnectors/connectors//versions/
},
"serviceAccount": "A String", # Optional. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec. This is only used for Open API based custom connectors. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`.
"specServerUrls": [ # Output only. Server URLs parsed from the Open API spec. This is only used for Open API based custom connectors.
"A String",
],
"state": "A String", # Output only. State of the custom connector version.
"updateTime": "A String", # Output only. Updated time.
}
customConnectorVersionId: string, Required. Identifier to assign to the CreateCustomConnectorVersion. Must be unique within scope of the parent resource.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single CustomConnectorVersion.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/{location}/customConnectors/*/customConnectorVersions/*` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # CustomConnectorVersion indicates a specific version of a connector.
"asyncOperationsSupport": True or False, # Optional. Indicates if Async Operations/Connector Job is supported. This is only available for SDK based custom connectors.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector service (facade). This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
"authType": "A String", # Optional. The type of authentication configured.
"oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Optional. Auth URL for Authorization Code Flow
"clientId": "A String", # Optional. Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
"clientId": "A String", # Optional. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing the client secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
"clientKey": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # Optional. JwtClaims providers fields to generate the token.
"audience": "A String", # Optional. Value for the "aud" claim.
"issuer": "A String", # Optional. Value for the "iss" claim.
"subject": "A String", # Optional. Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Optional. Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # Optional. SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Optional. Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Optional. The user account used to authenticate.
},
"userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
"password": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing the password.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Optional. Username.
},
},
"authConfigTemplates": [ # Optional. Auth Config Templates is only used when connector backend is enabled. This is used to specify the auth configs supported by the connector backend service to talk to the actual application backend.
{ # 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. # Optional. Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE for the auth code flow.
"omitQueryParams": True or False, # Optional. Omit query params from the redirect URI.
"scopes": [ # Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # Optional. The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Optional. Description.
"displayName": "A String", # Optional. Display name of the parameter.
"enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Optional. Display name of the option.
"id": "A String", # Optional. Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings
"key": "A String", # Optional. Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable.
"allowCustomValues": True or False, # Optional. Allow custom values.
"multipleSelectOptions": [ # Required. Multiple select options.
{ # MultiplSelecteOption represents the single option for a config variable.
"description": "A String", # Optional. Value of the option.
"displayName": "A String", # Required. Display name of the option.
"key": "A String", # Required. Key of the option.
"preselected": True or False, # Optional. Indicates if the option is preselected.
},
],
"valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
},
"required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # Optional. A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Optional. Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Optional. Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # Optional. A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # Optional. 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. # Optional. Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers.
"principal": "A String", # Optional. Principal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Optional. 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", # Optional. Different types of resource supported.
},
"roles": [ # Optional. List of roles that need to be granted.
"A String",
],
},
"state": "A String", # Output only. State of the config variable.
"validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Optional. 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.
"isDefault": True or False, # Whether the auth config is the default one.
},
],
"authOverrideSupport": True or False, # Optional. Auth override support.
"backendVariableTemplates": [ # Optional. Backend variable templates is only used when connector backend is enabled. This is used to specify the variables required by the connector backend service to talk to the actual application backend. This translates to additional variable templates in the connection config.
{ # 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. # Optional. Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE for the auth code flow.
"omitQueryParams": True or False, # Optional. Omit query params from the redirect URI.
"scopes": [ # Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # Optional. The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Optional. Description.
"displayName": "A String", # Optional. Display name of the parameter.
"enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Optional. Display name of the option.
"id": "A String", # Optional. Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings
"key": "A String", # Optional. Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable.
"allowCustomValues": True or False, # Optional. Allow custom values.
"multipleSelectOptions": [ # Required. Multiple select options.
{ # MultiplSelecteOption represents the single option for a config variable.
"description": "A String", # Optional. Value of the option.
"displayName": "A String", # Required. Display name of the option.
"key": "A String", # Required. Key of the option.
"preselected": True or False, # Optional. Indicates if the option is preselected.
},
],
"valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
},
"required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # Optional. A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Optional. Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Optional. Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # Optional. A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # Optional. 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. # Optional. Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers.
"principal": "A String", # Optional. Principal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Optional. 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", # Optional. Different types of resource supported.
},
"roles": [ # Optional. List of roles that need to be granted.
"A String",
],
},
"state": "A String", # Output only. State of the config variable.
"validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Optional. Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"createTime": "A String", # Output only. Created time.
"destinationConfigs": [ # Optional. Destination config(s) for accessing connector service (facade). This is used only when enable_backend_destination_config is true.
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"enableBackendDestinationConfig": True or False, # Optional. Indicates if an intermediatory connectorservice is used as backend. When this is enabled, the connector destination and connector auth config are required. For SDK based connectors, this is always enabled.
"labels": { # Optional. 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",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
"partnerMetadata": { # Partner metadata details. This will be populated when publishing the custom connector as a partner connector version. On publishing, parntner connector version will be created using the fields in PartnerMetadata. # Optional. Partner metadata details. This should be populated only when publishing the custom connector to partner connector.
"acceptGcpTos": True or False, # Required. Whether the user has accepted the Google Cloud Platform Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Marketplace Terms of Service (https://cloud.google.com/terms/marketplace/launcher?hl=en).
"additionalComments": "A String", # Optional. Additional comments for the submission.
"confirmPartnerRequirements": True or False, # Required. Confirmation that connector meets all applicable requirements mentioned in the Partner Connector Publishing requirements list and Partner onboardiong requirements list (https://cloud.google.com/marketplace/docs/partners/get-started#requirements).
"demoUri": "A String", # Required. Public URL for the demo video.
"hasDynamicSpecUri": True or False, # Output only. Has dynamic open api spec uri.
"integrationTemplates": "A String", # Required. Integration example templates for the custom connector.
"localSpecPath": "A String", # Output only. Local spec path. Required if has_dynamic_spec_uri is true.
"marketplaceProduct": "A String", # Optional. Marketplace product name.
"marketplaceProductId": "A String", # Required. Marketplace product ID.
"marketplaceProductProjectId": "A String", # Optional. Marketplace product project ID.
"marketplaceProductUri": "A String", # Optional. Marketplace product URL.
"partner": "A String", # Required. Partner name.
"partnerConnectorDisplayName": "A String", # Required. Partner connector display name.
"publishRequestTime": "A String", # Output only. Publish request time.
"targetApplication": "A String", # Required. Target application for which partner connector is built.
"targetCustomerSegment": "A String", # Required. Target customer segment for the partner connector.
"useCases": "A String", # Required. Details about partner connector use cases.
},
"publishStatus": { # Publish status of a custom connector. # Output only. Publish status of a custom connector.
"publishState": "A String", # Output only. Publish state of the custom connector.
"publishTime": "A String", # Output only. Publish time.
"publishedAs": "A String", # Output only. Partner connector name. Will be set on the custom connector. Format: providers/partner/connectors//versions/
"publishedSource": "A String", # Output only. Custom connector name. Will be set on the partner connector. Format: providers/customconnectors/connectors//versions/
},
"serviceAccount": "A String", # Optional. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec. This is only used for Open API based custom connectors. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`.
"specServerUrls": [ # Output only. Server URLs parsed from the Open API spec. This is only used for Open API based custom connectors.
"A String",
],
"state": "A String", # Output only. State of the custom connector version.
"updateTime": "A String", # Output only. Updated time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List CustomConnectorVersions in a given project
Args:
parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/{location}/customConnectors/*/customConnectorVersions/*` (required)
pageSize: integer, Page size.
pageToken: string, Page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Connectors.ListCustomConnectorVersions.
"customConnectorVersions": [ # A list of connector versions.
{ # CustomConnectorVersion indicates a specific version of a connector.
"asyncOperationsSupport": True or False, # Optional. Indicates if Async Operations/Connector Job is supported. This is only available for SDK based custom connectors.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector service (facade). This is used only when enable_backend_destination_config is true.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"intValue": "A String", # Value is an integer
"key": "A String", # Optional. Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
"authType": "A String", # Optional. The type of authentication configured.
"oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Optional. Auth URL for Authorization Code Flow
"clientId": "A String", # Optional. Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. Client secret for user-provided OAuth app.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # Optional. PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Optional. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2AuthCodeFlowGoogleManaged": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlowGoogleManaged.
"authCode": "A String", # Optional. Authorization code to be exchanged for access and refresh tokens.
"redirectUri": "A String", # Optional. Redirect URI to be provided during the auth code exchange.
"scopes": [ # Required. Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
"clientId": "A String", # Optional. The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing the client secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
"clientKey": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # Optional. JwtClaims providers fields to generate the token.
"audience": "A String", # Optional. Value for the "aud" claim.
"issuer": "A String", # Optional. Value for the "iss" claim.
"subject": "A String", # Optional. Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Optional. Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # Optional. SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Optional. Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Optional. The user account used to authenticate.
},
"userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
"password": { # Secret provides a reference to entries in Secret Manager. # Optional. Secret version reference containing the password.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Optional. Username.
},
},
"authConfigTemplates": [ # Optional. Auth Config Templates is only used when connector backend is enabled. This is used to specify the auth configs supported by the connector backend service to talk to the actual application backend.
{ # 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. # Optional. Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE for the auth code flow.
"omitQueryParams": True or False, # Optional. Omit query params from the redirect URI.
"scopes": [ # Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # Optional. The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Optional. Description.
"displayName": "A String", # Optional. Display name of the parameter.
"enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Optional. Display name of the option.
"id": "A String", # Optional. Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings
"key": "A String", # Optional. Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable.
"allowCustomValues": True or False, # Optional. Allow custom values.
"multipleSelectOptions": [ # Required. Multiple select options.
{ # MultiplSelecteOption represents the single option for a config variable.
"description": "A String", # Optional. Value of the option.
"displayName": "A String", # Required. Display name of the option.
"key": "A String", # Required. Key of the option.
"preselected": True or False, # Optional. Indicates if the option is preselected.
},
],
"valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
},
"required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # Optional. A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Optional. Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Optional. Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # Optional. A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # Optional. 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. # Optional. Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers.
"principal": "A String", # Optional. Principal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Optional. 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", # Optional. Different types of resource supported.
},
"roles": [ # Optional. List of roles that need to be granted.
"A String",
],
},
"state": "A String", # Output only. State of the config variable.
"validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Optional. 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.
"isDefault": True or False, # Whether the auth config is the default one.
},
],
"authOverrideSupport": True or False, # Optional. Auth override support.
"backendVariableTemplates": [ # Optional. Backend variable templates is only used when connector backend is enabled. This is used to specify the variables required by the connector backend service to talk to the actual application backend. This translates to additional variable templates in the connection config.
{ # 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. # Optional. Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # Optional. The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Optional. Whether to enable PKCE for the auth code flow.
"omitQueryParams": True or False, # Optional. Omit query params from the redirect URI.
"scopes": [ # Optional. The scopes for which the user will authorize Google Cloud Connectors on the connector data source.
"A String",
],
"uri": "A String", # Optional. The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Optional. Description.
"displayName": "A String", # Optional. Display name of the parameter.
"enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Optional. Display name of the option.
"id": "A String", # Optional. Id of the option.
},
],
"enumSource": "A String", # Optional. enum source denotes the source of api to fill the enum options
"isAdvanced": True or False, # Optional. Indicates if current template is part of advanced settings
"key": "A String", # Optional. Key of the config variable.
"locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections.
"multipleSelectConfig": { # MultipleSelectConfig represents the multiple options for a config variable. # Optional. MultipleSelectConfig represents the multiple options for a config variable.
"allowCustomValues": True or False, # Optional. Allow custom values.
"multipleSelectOptions": [ # Required. Multiple select options.
{ # MultiplSelecteOption represents the single option for a config variable.
"description": "A String", # Optional. Value of the option.
"displayName": "A String", # Required. Display name of the option.
"key": "A String", # Required. Key of the option.
"preselected": True or False, # Optional. Indicates if the option is preselected.
},
],
"valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field.
},
"required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a connection.
"requiredCondition": { # Struct for representing boolean expressions. # Optional. Condition under which a field would be required. The condition can be represented in the form of a logical expression.
"fieldComparisons": [ # Optional. A list of fields to be compared.
{ # Field that needs to be compared.
"boolValue": True or False, # Boolean value
"comparator": "A String", # Optional. Comparator to use for comparing the field value.
"intValue": "A String", # Integer value
"key": "A String", # Optional. Key of the field.
"stringValue": "A String", # String value
},
],
"logicalExpressions": [ # Optional. A list of nested conditions to be compared.
# Object with schema name: LogicalExpression
],
"logicalOperator": "A String", # Optional. 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. # Optional. Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Optional. Template that UI can use to provide helper text to customers.
"principal": "A String", # Optional. Principal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Optional. Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Optional. 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", # Optional. Different types of resource supported.
},
"roles": [ # Optional. List of roles that need to be granted.
"A String",
],
},
"state": "A String", # Output only. State of the config variable.
"validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Optional. Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"createTime": "A String", # Output only. Created time.
"destinationConfigs": [ # Optional. Destination config(s) for accessing connector service (facade). This is used only when enable_backend_destination_config is true.
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"enableBackendDestinationConfig": True or False, # Optional. Indicates if an intermediatory connectorservice is used as backend. When this is enabled, the connector destination and connector auth config are required. For SDK based connectors, this is always enabled.
"labels": { # Optional. 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",
},
"name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}
"partnerMetadata": { # Partner metadata details. This will be populated when publishing the custom connector as a partner connector version. On publishing, parntner connector version will be created using the fields in PartnerMetadata. # Optional. Partner metadata details. This should be populated only when publishing the custom connector to partner connector.
"acceptGcpTos": True or False, # Required. Whether the user has accepted the Google Cloud Platform Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Marketplace Terms of Service (https://cloud.google.com/terms/marketplace/launcher?hl=en).
"additionalComments": "A String", # Optional. Additional comments for the submission.
"confirmPartnerRequirements": True or False, # Required. Confirmation that connector meets all applicable requirements mentioned in the Partner Connector Publishing requirements list and Partner onboardiong requirements list (https://cloud.google.com/marketplace/docs/partners/get-started#requirements).
"demoUri": "A String", # Required. Public URL for the demo video.
"hasDynamicSpecUri": True or False, # Output only. Has dynamic open api spec uri.
"integrationTemplates": "A String", # Required. Integration example templates for the custom connector.
"localSpecPath": "A String", # Output only. Local spec path. Required if has_dynamic_spec_uri is true.
"marketplaceProduct": "A String", # Optional. Marketplace product name.
"marketplaceProductId": "A String", # Required. Marketplace product ID.
"marketplaceProductProjectId": "A String", # Optional. Marketplace product project ID.
"marketplaceProductUri": "A String", # Optional. Marketplace product URL.
"partner": "A String", # Required. Partner name.
"partnerConnectorDisplayName": "A String", # Required. Partner connector display name.
"publishRequestTime": "A String", # Output only. Publish request time.
"targetApplication": "A String", # Required. Target application for which partner connector is built.
"targetCustomerSegment": "A String", # Required. Target customer segment for the partner connector.
"useCases": "A String", # Required. Details about partner connector use cases.
},
"publishStatus": { # Publish status of a custom connector. # Output only. Publish status of a custom connector.
"publishState": "A String", # Output only. Publish state of the custom connector.
"publishTime": "A String", # Output only. Publish time.
"publishedAs": "A String", # Output only. Partner connector name. Will be set on the custom connector. Format: providers/partner/connectors//versions/
"publishedSource": "A String", # Output only. Custom connector name. Will be set on the partner connector. Format: providers/customconnectors/connectors//versions/
},
"serviceAccount": "A String", # Optional. Service account used by runtime plane to access auth config secrets.
"specLocation": "A String", # Optional. Location of the custom connector spec. This is only used for Open API based custom connectors. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`.
"specServerUrls": [ # Output only. Server URLs parsed from the Open API spec. This is only used for Open API based custom connectors.
"A String",
],
"state": "A String", # Output only. State of the custom connector version.
"updateTime": "A String", # Output only. Updated time.
},
],
"nextPageToken": "A String", # Next page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
