-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
connectors_v1.projects.locations.connections.html
2729 lines (2643 loc) 路 260 KB
/
connectors_v1.projects.locations.connections.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.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="connectors_v1.projects.locations.connections.connectionSchemaMetadata.html">connectionSchemaMetadata()</a></code>
</p>
<p class="firstline">Returns the connectionSchemaMetadata Resource.</p>
<p class="toc_element">
<code><a href="connectors_v1.projects.locations.connections.eventSubscriptions.html">eventSubscriptions()</a></code>
</p>
<p class="firstline">Returns the eventSubscriptions Resource.</p>
<p class="toc_element">
<code><a href="connectors_v1.projects.locations.connections.runtimeActionSchemas.html">runtimeActionSchemas()</a></code>
</p>
<p class="firstline">Returns the runtimeActionSchemas Resource.</p>
<p class="toc_element">
<code><a href="connectors_v1.projects.locations.connections.runtimeEntitySchemas.html">runtimeEntitySchemas()</a></code>
</p>
<p class="firstline">Returns the runtimeEntitySchemas 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="#create">create(parent, body=None, connectionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Connection in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Connection.</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 Connection.</p>
<p class="toc_element">
<code><a href="#getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Connections 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>
<p class="toc_element">
<code><a href="#listenEvent">listenEvent(resourcePath, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ListenEvent listens to the event.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the parameters of a single Connection.</p>
<p class="toc_element">
<code><a href="#repairEventing">repairEventing(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">RepaiEventing tries to repair eventing related event subscriptions.</p>
<p class="toc_element">
<code><a href="#search">search(name, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns Top matching Connections for a given query.</p>
<p class="toc_element">
<code><a href="#search_next">search_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</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, connectionId=None, x__xgafv=None)</code>
<pre>Creates a new Connection in a given project and location.
Args:
parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required)
body: object, The request body.
The object takes the form of:
{ # Connection represents an instance of connector.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # 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", # Identifier key for auth config
"authType": "A String", # 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", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # 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", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # 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. # 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", # 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. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # 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. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # 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. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
"connectorVersionInfraConfig": { # 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 Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. 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", # Output only. Max QPS supported for internal requests originating from Connd.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. 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. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # 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.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"additionalVariables": [ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # 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", # Identifier key for auth config
"authType": "A String", # 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", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # 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", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # 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. # 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", # 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. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # 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. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # 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. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"enrichmentEnabled": True or False, # Enrichment Enabled.
"eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
"listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener.
"additionalVariables": [ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # 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", # Identifier key for auth config
"authType": "A String", # 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", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # 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", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # 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. # 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", # 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. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # 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. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # 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. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"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.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"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.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
},
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"updateTime": "A String", # Output only. Updated time.
}
connectionId: string, Required. Identifier to assign to the Connection. 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="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a single Connection.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
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, view=None, x__xgafv=None)</code>
<pre>Gets details of a single Connection.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
view: string, Specifies which fields of the Connection are returned in the response. Defaults to `BASIC` view.
Allowed values
CONNECTION_VIEW_UNSPECIFIED - CONNECTION_UNSPECIFIED.
BASIC - Do not include runtime required configs.
FULL - Include runtime required configs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Connection represents an instance of connector.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # 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", # Identifier key for auth config
"authType": "A String", # 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", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # 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", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # 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. # 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", # 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. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # 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. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # 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. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"billingConfig": { # Billing config for the connection. # Output only. Billing config for the connection.
"billingCategory": "A String", # Output only. Billing category for the connector.
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
"connectorVersionInfraConfig": { # 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 Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. 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", # Output only. Max QPS supported for internal requests originating from Connd.
"ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. 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. # Output only. System resource requests.
"cpu": "A String", # Output only. CPU request.
"memory": "A String", # Output only. Memory request.
},
"sharedDeployment": "A String", # Output only. The name of shared connector deployment.
},
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # 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.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection
"additionalVariables": [ # Additional eventing related field values
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter.
"additionalVariables": [ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # 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", # Identifier key for auth config
"authType": "A String", # 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", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # 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", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # 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. # 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", # 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. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # 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. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # 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. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"deadLetterConfig": { # Dead Letter configuration details provided by the user. # Optional. Dead letter configuration for eventing of a connection.
"projectId": "A String", # Optional. Project which has the topic given.
"topic": "A String", # Optional. Topic to push events which couldn't be processed.
},
"enrichmentEnabled": True or False, # Enrichment Enabled.
"eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
"listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener.
"additionalVariables": [ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # 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", # Identifier key for auth config
"authType": "A String", # 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", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # 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", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # 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. # 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", # 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. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # 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. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # 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. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
"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.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto registration.
"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.
},
},
"eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled.
"eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data.
"eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener.
"eventsListenerPscSa": "A String", # Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.
"status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing.
"description": "A String", # Output only. Description of error if State is set to "ERROR".
"state": "A String", # Output only. State.
},
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
"id": "A String", # Output only. ID to uniquely identify webhook.
"name": "A String", # Output only. Name of the Webhook
"nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported.
"updateTime": "A String", # Output only. Timestamp when the webhook was last updated.
},
},
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project.
"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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access Google Cloud resources.
"serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # 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", # 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", # Key of the config variable.
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},