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
|
<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="developerconnect_v1.html">Developer Connect API</a> . <a href="developerconnect_v1.projects.html">projects</a> . <a href="developerconnect_v1.projects.locations.html">locations</a> . <a href="developerconnect_v1.projects.locations.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html">gitRepositoryLinks()</a></code>
</p>
<p class="firstline">Returns the gitRepositoryLinks 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, requestId=None, validateOnly=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, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single Connection.</p>
<p class="toc_element">
<code><a href="#fetchGitHubInstallations">fetchGitHubInstallations(connection, x__xgafv=None)</a></code></p>
<p class="firstline">FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection. For github.com, only installations accessible to the authorizer token are returned. For GitHub Enterprise, all installations are returned.</p>
<p class="toc_element">
<code><a href="#fetchLinkableGitRepositories">fetchLinkableGitRepositories(connection, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.</p>
<p class="toc_element">
<code><a href="#fetchLinkableGitRepositories_next">fetchLinkableGitRepositories_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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 Connection.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=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="#patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=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="#processGitHubEnterpriseWebhook">processGitHubEnterpriseWebhook(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.</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, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a new Connection in a given project and location.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # Message describing Connection object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"bitbucketCloudConfig": { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository`, `pullrequest` and `webhook` scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate and create webhooks.
"workspace": "A String", # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
},
"bitbucketDataCenterConfig": { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository admin` scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the Bitbucket Data Center host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"createTime": "A String", # Output only. [Output only] Create timestamp
"cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
"keyReference": "A String", # Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
},
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection.
"enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.
},
"githubConfig": { # Configuration for connections to github.com. # Configuration for connections to github.com.
"appInstallationId": "A String", # Optional. GitHub App installation id.
"authorizerCredential": { # Represents an OAuth token of the account that authorized the Connection, and associated metadata. # Optional. OAuth credential of the account that authorized the GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the GitHub App of this config.
"oauthTokenSecretVersion": "A String", # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"githubApp": "A String", # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
},
"githubEnterpriseConfig": { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
"appId": "A String", # Optional. ID of the GitHub App created from the manifest.
"appInstallationId": "A String", # Optional. ID of the installation of the GitHub App.
"appSlug": "A String", # Output only. The URL-friendly name of the GitHub App.
"hostUri": "A String", # Required. The URI of the GitHub Enterprise host this connection is for.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
"privateKeySecretVersion": "A String", # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
"serverVersion": "A String", # Output only. GitHub Enterprise version installed at the host_uri.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookSecretSecretVersion": "A String", # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
},
"gitlabConfig": { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"gitlabEnterpriseConfig": { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the GitLab Enterprise host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"installationState": { # Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. # Output only. Installation state of the Connection.
"actionUri": "A String", # Output only. Link to follow for next action. Empty string if the installation is already complete.
"message": "A String", # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
"stage": "A String", # Output only. Current step of the installation process.
},
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
}
connectionId: string, Required. Id of the requesting object If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
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, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Deletes a single Connection.
Args:
name: string, Required. Name of the resource (required)
etag: string, Optional. The current etag of the Connection. If an etag is provided and does not match the current etag of the Connection, deletion will be blocked and an ABORTED error will be returned.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
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="fetchGitHubInstallations">fetchGitHubInstallations(connection, x__xgafv=None)</code>
<pre>FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection. For github.com, only installations accessible to the authorizer token are returned. For GitHub Enterprise, all installations are returned.
Args:
connection: string, Required. The resource name of the connection in the format `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:
{ # Response of fetching github installations.
"installations": [ # List of installations available to the OAuth user (for github.com) or all the installations (for GitHub enterprise).
{ # Represents an installation of the GitHub App.
"id": "A String", # ID of the installation in GitHub.
"name": "A String", # Name of the GitHub user or organization that owns this installation.
"type": "A String", # Either "user" or "organization".
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="fetchLinkableGitRepositories">fetchLinkableGitRepositories(connection, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.
Args:
connection: string, Required. The name of the Connection. Format: `projects/*/locations/*/connections/*`. (required)
pageSize: integer, Optional. Number of results to return in the list. Defaults to 20.
pageToken: string, Optional. Page start.
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 FetchLinkableGitRepositories.
"linkableGitRepositories": [ # The git repositories that can be linked to the connection.
{ # LinkableGitRepository represents a git repository that can be linked to a connection.
"cloneUri": "A String", # The clone uri of the repository.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
}</pre>
</div>
<div class="method">
<code class="details" id="fetchLinkableGitRepositories_next">fetchLinkableGitRepositories_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>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Connection.
Args:
name: string, Required. Name of the resource (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message describing Connection object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"bitbucketCloudConfig": { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository`, `pullrequest` and `webhook` scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate and create webhooks.
"workspace": "A String", # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
},
"bitbucketDataCenterConfig": { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository admin` scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the Bitbucket Data Center host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"createTime": "A String", # Output only. [Output only] Create timestamp
"cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
"keyReference": "A String", # Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
},
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection.
"enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.
},
"githubConfig": { # Configuration for connections to github.com. # Configuration for connections to github.com.
"appInstallationId": "A String", # Optional. GitHub App installation id.
"authorizerCredential": { # Represents an OAuth token of the account that authorized the Connection, and associated metadata. # Optional. OAuth credential of the account that authorized the GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the GitHub App of this config.
"oauthTokenSecretVersion": "A String", # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"githubApp": "A String", # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
},
"githubEnterpriseConfig": { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
"appId": "A String", # Optional. ID of the GitHub App created from the manifest.
"appInstallationId": "A String", # Optional. ID of the installation of the GitHub App.
"appSlug": "A String", # Output only. The URL-friendly name of the GitHub App.
"hostUri": "A String", # Required. The URI of the GitHub Enterprise host this connection is for.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
"privateKeySecretVersion": "A String", # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
"serverVersion": "A String", # Output only. GitHub Enterprise version installed at the host_uri.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookSecretSecretVersion": "A String", # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
},
"gitlabConfig": { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"gitlabEnterpriseConfig": { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the GitLab Enterprise host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"installationState": { # Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. # Output only. Installation state of the Connection.
"actionUri": "A String", # Output only. Link to follow for next action. Empty string if the installation is already complete.
"message": "A String", # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
"stage": "A String", # Output only. Current step of the installation process.
},
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Connections in a given project and location.
Args:
parent: string, Required. Parent value for ListConnectionsRequest (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Connections
"connections": [ # The list of Connection
{ # Message describing Connection object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"bitbucketCloudConfig": { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository`, `pullrequest` and `webhook` scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate and create webhooks.
"workspace": "A String", # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
},
"bitbucketDataCenterConfig": { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository admin` scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the Bitbucket Data Center host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"createTime": "A String", # Output only. [Output only] Create timestamp
"cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
"keyReference": "A String", # Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
},
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection.
"enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.
},
"githubConfig": { # Configuration for connections to github.com. # Configuration for connections to github.com.
"appInstallationId": "A String", # Optional. GitHub App installation id.
"authorizerCredential": { # Represents an OAuth token of the account that authorized the Connection, and associated metadata. # Optional. OAuth credential of the account that authorized the GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the GitHub App of this config.
"oauthTokenSecretVersion": "A String", # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"githubApp": "A String", # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
},
"githubEnterpriseConfig": { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
"appId": "A String", # Optional. ID of the GitHub App created from the manifest.
"appInstallationId": "A String", # Optional. ID of the installation of the GitHub App.
"appSlug": "A String", # Output only. The URL-friendly name of the GitHub App.
"hostUri": "A String", # Required. The URI of the GitHub Enterprise host this connection is for.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
"privateKeySecretVersion": "A String", # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
"serverVersion": "A String", # Output only. GitHub Enterprise version installed at the host_uri.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookSecretSecretVersion": "A String", # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
},
"gitlabConfig": { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"gitlabEnterpriseConfig": { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the GitLab Enterprise host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"installationState": { # Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. # Output only. Installation state of the Connection.
"actionUri": "A String", # Output only. Link to follow for next action. Empty string if the installation is already complete.
"message": "A String", # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
"stage": "A String", # Output only. Current step of the installation process.
},
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"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>
<div class="method">
<code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Updates the parameters of a single Connection.
Args:
name: string, Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Message describing Connection object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"bitbucketCloudConfig": { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository`, `pullrequest` and `webhook` scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate and create webhooks.
"workspace": "A String", # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
},
"bitbucketDataCenterConfig": { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository admin` scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the Bitbucket Data Center host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It's recommended to use a system account to generate the credentials.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"createTime": "A String", # Output only. [Output only] Create timestamp
"cryptoKeyConfig": { # The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. # Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
"keyReference": "A String", # Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
},
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"disabled": True or False, # Optional. If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyConfig": { # The git proxy configuration. # Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection.
"enabled": True or False, # Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.
},
"githubConfig": { # Configuration for connections to github.com. # Configuration for connections to github.com.
"appInstallationId": "A String", # Optional. GitHub App installation id.
"authorizerCredential": { # Represents an OAuth token of the account that authorized the Connection, and associated metadata. # Optional. OAuth credential of the account that authorized the GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the GitHub App of this config.
"oauthTokenSecretVersion": "A String", # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"githubApp": "A String", # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
},
"githubEnterpriseConfig": { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
"appId": "A String", # Optional. ID of the GitHub App created from the manifest.
"appInstallationId": "A String", # Optional. ID of the installation of the GitHub App.
"appSlug": "A String", # Output only. The URL-friendly name of the GitHub App.
"hostUri": "A String", # Required. The URI of the GitHub Enterprise host this connection is for.
"installationUri": "A String", # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
"privateKeySecretVersion": "A String", # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
"serverVersion": "A String", # Output only. GitHub Enterprise version installed at the host_uri.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookSecretSecretVersion": "A String", # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.
},
"gitlabConfig": { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"gitlabEnterpriseConfig": { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
"authorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"hostUri": "A String", # Required. The URI of the GitLab Enterprise host this connection is for.
"readAuthorizerCredential": { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
"userTokenSecretVersion": "A String", # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.
"username": "A String", # Output only. The username associated with this token.
},
"serverVersion": "A String", # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet.
"service": "A String", # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCaCertificate": "A String", # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
"webhookSecretSecretVersion": "A String", # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.
},
"installationState": { # Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections. # Output only. Installation state of the Connection.
"actionUri": "A String", # Output only. Link to follow for next action. Empty string if the installation is already complete.
"message": "A String", # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
"stage": "A String", # Output only. Current step of the installation process.
},
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
}
allowMissing: boolean, Optional. If set to true, and the connection is not found a new connection will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties).
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
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="processGitHubEnterpriseWebhook">processGitHubEnterpriseWebhook(parent, body=None, x__xgafv=None)</code>
<pre>ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.
Args:
parent: string, Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`. (required)
body: object, The request body.
The object takes the form of:
{ # RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC method.
"body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
</body></html>
|
