Debian Codegraph @

docs/dyn/developerconnect_v1.projects.locations.connections.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html">gitRepositoryLinks()</a></code>
79 </p>
80 <p class="firstline">Returns the gitRepositoryLinks Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#create">create(parent, body=None, connectionId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
87 <p class="firstline">Creates a new Connection in a given project and location.</p>
88 <p class="toc_element">
89 <code><a href="#delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Deletes a single Connection.</p>
91 <p class="toc_element">
92 <code><a href="#fetchGitHubInstallations">fetchGitHubInstallations(connection, x__xgafv=None)</a></code></p>
93 <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>
94 <p class="toc_element">
95 <code><a href="#fetchLinkableGitRepositories">fetchLinkableGitRepositories(connection, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96 <p class="firstline">FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.</p>
97 <p class="toc_element">
98 <code><a href="#fetchLinkableGitRepositories_next">fetchLinkableGitRepositories_next()</a></code></p>
99 <p class="firstline">Retrieves the next page of results.</p>
100 <p class="toc_element">
101 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
102 <p class="firstline">Gets details of a single Connection.</p>
103 <p class="toc_element">
104 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Lists Connections in a given project and location.</p>
106 <p class="toc_element">
107 <code><a href="#list_next">list_next()</a></code></p>
108 <p class="firstline">Retrieves the next page of results.</p>
109 <p class="toc_element">
110 <code><a href="#patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
111 <p class="firstline">Updates the parameters of a single Connection.</p>
112 <p class="toc_element">
113 <code><a href="#processGitHubEnterpriseWebhook">processGitHubEnterpriseWebhook(parent, body=None, x__xgafv=None)</a></code></p>
114 <p class="firstline">ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.</p>
115 <h3>Method Details</h3>
116 <div class="method">
117 <code class="details" id="close">close()</code>
118 <pre>Close httplib2 connections.</pre>
119 </div>
120
121 <div class="method">
122 <code class="details" id="create">create(parent, body=None, connectionId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
123 <pre>Creates a new Connection in a given project and location.
124
125 Args:
126 parent: string, Required. Value for parent. (required)
127 body: object, The request body.
128 The object takes the form of:
129
130 { # Message describing Connection object
131 &quot;annotations&quot;: { # Optional. Allows clients to store small amounts of arbitrary data.
132 &quot;a_key&quot;: &quot;A String&quot;,
133 },
134 &quot;bitbucketCloudConfig&quot;: { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
135 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
136 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
137 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
138 },
139 &quot;readAuthorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate the credentials.
140 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
141 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
142 },
143 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate and create webhooks.
144 &quot;workspace&quot;: &quot;A String&quot;, # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
145 },
146 &quot;bitbucketDataCenterConfig&quot;: { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
147 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
148 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
149 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
150 },
151 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the Bitbucket Data Center host this connection is for.
152 &quot;readAuthorizerCredential&quot;: { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It&#x27;s recommended to use a system account to generate the credentials.
153 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
154 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
155 },
156 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
157 &quot;serviceDirectoryConfig&quot;: { # 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.
158 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
159 },
160 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
161 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
162 },
163 &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create timestamp
164 &quot;cryptoKeyConfig&quot;: { # 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.
165 &quot;keyReference&quot;: &quot;A String&quot;, # 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/*`.
166 },
167 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. [Output only] Delete timestamp
168 &quot;disabled&quot;: 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.
169 &quot;etag&quot;: &quot;A String&quot;, # 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.
170 &quot;gitProxyConfig&quot;: { # 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. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy).
171 &quot;enabled&quot;: 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.
172 &quot;httpProxyBaseUri&quot;: &quot;A String&quot;, # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect.
173 },
174 &quot;githubConfig&quot;: { # Configuration for connections to github.com. # Configuration for connections to github.com.
175 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. GitHub App installation id.
176 &quot;authorizerCredential&quot;: { # 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.
177 &quot;oauthTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
178 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
179 },
180 &quot;githubApp&quot;: &quot;A String&quot;, # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
181 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
182 },
183 &quot;githubEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
184 &quot;appId&quot;: &quot;A String&quot;, # Optional. ID of the GitHub App created from the manifest.
185 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. ID of the installation of the GitHub App.
186 &quot;appSlug&quot;: &quot;A String&quot;, # Output only. The URL-friendly name of the GitHub App.
187 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitHub Enterprise host this connection is for.
188 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
189 &quot;organization&quot;: &quot;A String&quot;, # Optional. Immutable. GitHub Enterprise organization in which the GitHub App is created.
190 &quot;privateKeySecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
191 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. GitHub Enterprise version installed at the host_uri.
192 &quot;serviceDirectoryConfig&quot;: { # 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.
193 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
194 },
195 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate to use for requests to GitHub Enterprise.
196 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
197 },
198 &quot;gitlabConfig&quot;: { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
199 &quot;authorizerCredential&quot;: { # 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.
200 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
201 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
202 },
203 &quot;readAuthorizerCredential&quot;: { # 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.
204 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
205 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
206 },
207 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
208 },
209 &quot;gitlabEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
210 &quot;authorizerCredential&quot;: { # 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.
211 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
212 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
213 },
214 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitLab Enterprise host this connection is for.
215 &quot;readAuthorizerCredential&quot;: { # 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.
216 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
217 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
218 },
219 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
220 &quot;serviceDirectoryConfig&quot;: { # 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.
221 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
222 },
223 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
224 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
225 },
226 &quot;httpConfig&quot;: { # Defines the configuration for connections to an HTTP service provider. # Optional. Configuration for connections to an HTTP service provider.
227 &quot;basicAuthentication&quot;: { # Basic authentication with username and password. # Optional. Basic authentication with username and password.
228 &quot;passwordSecretVersion&quot;: &quot;A String&quot;, # The password SecretManager secret version to authenticate as.
229 &quot;username&quot;: &quot;A String&quot;, # Required. The username to authenticate as.
230 },
231 &quot;bearerTokenAuthentication&quot;: { # Bearer token authentication with a token. # Optional. Bearer token authentication with a token.
232 &quot;tokenSecretVersion&quot;: &quot;A String&quot;, # Optional. The token SecretManager secret version to authenticate as.
233 },
234 &quot;hostUri&quot;: &quot;A String&quot;, # Required. Immutable. The service provider&#x27;s https endpoint.
235 &quot;serviceDirectoryConfig&quot;: { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a HTTP service provider. This should only be set if the Http service provider is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the HTTP service provider will be made over the public internet.
236 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
237 },
238 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. The SSL certificate to use for requests to the HTTP service provider.
239 },
240 &quot;installationState&quot;: { # 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.
241 &quot;actionUri&quot;: &quot;A String&quot;, # Output only. Link to follow for next action. Empty string if the installation is already complete.
242 &quot;message&quot;: &quot;A String&quot;, # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
243 &quot;stage&quot;: &quot;A String&quot;, # Output only. Current step of the installation process.
244 },
245 &quot;labels&quot;: { # Optional. Labels as key value pairs
246 &quot;a_key&quot;: &quot;A String&quot;,
247 },
248 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
249 &quot;reconciling&quot;: True or False, # Output only. Set to true when the connection is being set up or updated in the background.
250 &quot;secureSourceManagerInstanceConfig&quot;: { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
251 &quot;instance&quot;: &quot;A String&quot;, # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
252 },
253 &quot;uid&quot;: &quot;A String&quot;, # Output only. A system-assigned unique identifier for the Connection.
254 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update timestamp
255 }
256
257 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
258 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).
259 validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
260 x__xgafv: string, V1 error format.
261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
264
265 Returns:
266 An object of the form:
267
268 { # This resource represents a long-running operation that is the result of a network API call.
269 &quot;done&quot;: 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.
270 &quot;error&quot;: { # 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.
271 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
272 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
273 {
274 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
275 },
276 ],
277 &quot;message&quot;: &quot;A String&quot;, # 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.
278 },
279 &quot;metadata&quot;: { # 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.
280 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
281 },
282 &quot;name&quot;: &quot;A String&quot;, # 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}`.
283 &quot;response&quot;: { # 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`.
284 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
285 },
286 }</pre>
287 </div>
288
289 <div class="method">
290 <code class="details" id="delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
291 <pre>Deletes a single Connection.
292
293 Args:
294 name: string, Required. Name of the resource (required)
295 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.
296 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).
297 validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
298 x__xgafv: string, V1 error format.
299 Allowed values
300 1 - v1 error format
301 2 - v2 error format
302
303 Returns:
304 An object of the form:
305
306 { # This resource represents a long-running operation that is the result of a network API call.
307 &quot;done&quot;: 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.
308 &quot;error&quot;: { # 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.
309 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
310 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
311 {
312 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
313 },
314 ],
315 &quot;message&quot;: &quot;A String&quot;, # 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.
316 },
317 &quot;metadata&quot;: { # 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.
318 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
319 },
320 &quot;name&quot;: &quot;A String&quot;, # 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}`.
321 &quot;response&quot;: { # 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`.
322 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
323 },
324 }</pre>
325 </div>
326
327 <div class="method">
328 <code class="details" id="fetchGitHubInstallations">fetchGitHubInstallations(connection, x__xgafv=None)</code>
329 <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.
330
331 Args:
332 connection: string, Required. The resource name of the connection in the format `projects/*/locations/*/connections/*`. (required)
333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338 Returns:
339 An object of the form:
340
341 { # Response of fetching github installations.
342 &quot;installations&quot;: [ # List of installations available to the OAuth user (for github.com) or all the installations (for GitHub enterprise).
343 { # Represents an installation of the GitHub App.
344 &quot;id&quot;: &quot;A String&quot;, # ID of the installation in GitHub.
345 &quot;name&quot;: &quot;A String&quot;, # Name of the GitHub user or organization that owns this installation.
346 &quot;type&quot;: &quot;A String&quot;, # Either &quot;user&quot; or &quot;organization&quot;.
347 },
348 ],
349 }</pre>
350 </div>
351
352 <div class="method">
353 <code class="details" id="fetchLinkableGitRepositories">fetchLinkableGitRepositories(connection, pageSize=None, pageToken=None, x__xgafv=None)</code>
354 <pre>FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.
355
356 Args:
357 connection: string, Required. The name of the Connection. Format: `projects/*/locations/*/connections/*`. (required)
358 pageSize: integer, Optional. Number of results to return in the list. Defaults to 20.
359 pageToken: string, Optional. Page start.
360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364
365 Returns:
366 An object of the form:
367
368 { # Response message for FetchLinkableGitRepositories.
369 &quot;linkableGitRepositories&quot;: [ # The git repositories that can be linked to the connection.
370 { # LinkableGitRepository represents a git repository that can be linked to a connection.
371 &quot;cloneUri&quot;: &quot;A String&quot;, # The clone uri of the repository.
372 },
373 ],
374 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
375 }</pre>
376 </div>
377
378 <div class="method">
379 <code class="details" id="fetchLinkableGitRepositories_next">fetchLinkableGitRepositories_next()</code>
380 <pre>Retrieves the next page of results.
381
382 Args:
383 previous_request: The request for the previous page. (required)
384 previous_response: The response from the request for the previous page. (required)
385
386 Returns:
387 A request object that you can call &#x27;execute()&#x27; on to request the next
388 page. Returns None if there are no more items in the collection.
389 </pre>
390 </div>
391
392 <div class="method">
393 <code class="details" id="get">get(name, x__xgafv=None)</code>
394 <pre>Gets details of a single Connection.
395
396 Args:
397 name: string, Required. Name of the resource (required)
398 x__xgafv: string, V1 error format.
399 Allowed values
400 1 - v1 error format
401 2 - v2 error format
402
403 Returns:
404 An object of the form:
405
406 { # Message describing Connection object
407 &quot;annotations&quot;: { # Optional. Allows clients to store small amounts of arbitrary data.
408 &quot;a_key&quot;: &quot;A String&quot;,
409 },
410 &quot;bitbucketCloudConfig&quot;: { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
411 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
412 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
413 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
414 },
415 &quot;readAuthorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate the credentials.
416 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
417 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
418 },
419 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate and create webhooks.
420 &quot;workspace&quot;: &quot;A String&quot;, # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
421 },
422 &quot;bitbucketDataCenterConfig&quot;: { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
423 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
424 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
425 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
426 },
427 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the Bitbucket Data Center host this connection is for.
428 &quot;readAuthorizerCredential&quot;: { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It&#x27;s recommended to use a system account to generate the credentials.
429 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
430 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
431 },
432 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
433 &quot;serviceDirectoryConfig&quot;: { # 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.
434 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
435 },
436 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
437 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
438 },
439 &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create timestamp
440 &quot;cryptoKeyConfig&quot;: { # 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.
441 &quot;keyReference&quot;: &quot;A String&quot;, # 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/*`.
442 },
443 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. [Output only] Delete timestamp
444 &quot;disabled&quot;: 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.
445 &quot;etag&quot;: &quot;A String&quot;, # 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.
446 &quot;gitProxyConfig&quot;: { # 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. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy).
447 &quot;enabled&quot;: 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.
448 &quot;httpProxyBaseUri&quot;: &quot;A String&quot;, # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect.
449 },
450 &quot;githubConfig&quot;: { # Configuration for connections to github.com. # Configuration for connections to github.com.
451 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. GitHub App installation id.
452 &quot;authorizerCredential&quot;: { # 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.
453 &quot;oauthTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
454 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
455 },
456 &quot;githubApp&quot;: &quot;A String&quot;, # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
457 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
458 },
459 &quot;githubEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
460 &quot;appId&quot;: &quot;A String&quot;, # Optional. ID of the GitHub App created from the manifest.
461 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. ID of the installation of the GitHub App.
462 &quot;appSlug&quot;: &quot;A String&quot;, # Output only. The URL-friendly name of the GitHub App.
463 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitHub Enterprise host this connection is for.
464 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
465 &quot;organization&quot;: &quot;A String&quot;, # Optional. Immutable. GitHub Enterprise organization in which the GitHub App is created.
466 &quot;privateKeySecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
467 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. GitHub Enterprise version installed at the host_uri.
468 &quot;serviceDirectoryConfig&quot;: { # 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.
469 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
470 },
471 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate to use for requests to GitHub Enterprise.
472 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
473 },
474 &quot;gitlabConfig&quot;: { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
475 &quot;authorizerCredential&quot;: { # 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.
476 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
477 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
478 },
479 &quot;readAuthorizerCredential&quot;: { # 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.
480 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
481 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
482 },
483 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
484 },
485 &quot;gitlabEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
486 &quot;authorizerCredential&quot;: { # 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.
487 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
488 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
489 },
490 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitLab Enterprise host this connection is for.
491 &quot;readAuthorizerCredential&quot;: { # 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.
492 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
493 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
494 },
495 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
496 &quot;serviceDirectoryConfig&quot;: { # 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.
497 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
498 },
499 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
500 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
501 },
502 &quot;httpConfig&quot;: { # Defines the configuration for connections to an HTTP service provider. # Optional. Configuration for connections to an HTTP service provider.
503 &quot;basicAuthentication&quot;: { # Basic authentication with username and password. # Optional. Basic authentication with username and password.
504 &quot;passwordSecretVersion&quot;: &quot;A String&quot;, # The password SecretManager secret version to authenticate as.
505 &quot;username&quot;: &quot;A String&quot;, # Required. The username to authenticate as.
506 },
507 &quot;bearerTokenAuthentication&quot;: { # Bearer token authentication with a token. # Optional. Bearer token authentication with a token.
508 &quot;tokenSecretVersion&quot;: &quot;A String&quot;, # Optional. The token SecretManager secret version to authenticate as.
509 },
510 &quot;hostUri&quot;: &quot;A String&quot;, # Required. Immutable. The service provider&#x27;s https endpoint.
511 &quot;serviceDirectoryConfig&quot;: { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a HTTP service provider. This should only be set if the Http service provider is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the HTTP service provider will be made over the public internet.
512 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
513 },
514 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. The SSL certificate to use for requests to the HTTP service provider.
515 },
516 &quot;installationState&quot;: { # 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.
517 &quot;actionUri&quot;: &quot;A String&quot;, # Output only. Link to follow for next action. Empty string if the installation is already complete.
518 &quot;message&quot;: &quot;A String&quot;, # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
519 &quot;stage&quot;: &quot;A String&quot;, # Output only. Current step of the installation process.
520 },
521 &quot;labels&quot;: { # Optional. Labels as key value pairs
522 &quot;a_key&quot;: &quot;A String&quot;,
523 },
524 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
525 &quot;reconciling&quot;: True or False, # Output only. Set to true when the connection is being set up or updated in the background.
526 &quot;secureSourceManagerInstanceConfig&quot;: { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
527 &quot;instance&quot;: &quot;A String&quot;, # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
528 },
529 &quot;uid&quot;: &quot;A String&quot;, # Output only. A system-assigned unique identifier for the Connection.
530 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update timestamp
531 }</pre>
532 </div>
533
534 <div class="method">
535 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
536 <pre>Lists Connections in a given project and location.
537
538 Args:
539 parent: string, Required. Parent value for ListConnectionsRequest (required)
540 filter: string, Optional. Filtering results
541 orderBy: string, Optional. Hint for how to order the results
542 pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
543 pageToken: string, Optional. A token identifying a page of results the server should return.
544 x__xgafv: string, V1 error format.
545 Allowed values
546 1 - v1 error format
547 2 - v2 error format
548
549 Returns:
550 An object of the form:
551
552 { # Message for response to listing Connections
553 &quot;connections&quot;: [ # The list of Connection
554 { # Message describing Connection object
555 &quot;annotations&quot;: { # Optional. Allows clients to store small amounts of arbitrary data.
556 &quot;a_key&quot;: &quot;A String&quot;,
557 },
558 &quot;bitbucketCloudConfig&quot;: { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
559 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
560 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
561 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
562 },
563 &quot;readAuthorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate the credentials.
564 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
565 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
566 },
567 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate and create webhooks.
568 &quot;workspace&quot;: &quot;A String&quot;, # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
569 },
570 &quot;bitbucketDataCenterConfig&quot;: { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
571 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
572 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
573 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
574 },
575 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the Bitbucket Data Center host this connection is for.
576 &quot;readAuthorizerCredential&quot;: { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It&#x27;s recommended to use a system account to generate the credentials.
577 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
578 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
579 },
580 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
581 &quot;serviceDirectoryConfig&quot;: { # 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.
582 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
583 },
584 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
585 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
586 },
587 &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create timestamp
588 &quot;cryptoKeyConfig&quot;: { # 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.
589 &quot;keyReference&quot;: &quot;A String&quot;, # 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/*`.
590 },
591 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. [Output only] Delete timestamp
592 &quot;disabled&quot;: 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.
593 &quot;etag&quot;: &quot;A String&quot;, # 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.
594 &quot;gitProxyConfig&quot;: { # 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. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy).
595 &quot;enabled&quot;: 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.
596 &quot;httpProxyBaseUri&quot;: &quot;A String&quot;, # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect.
597 },
598 &quot;githubConfig&quot;: { # Configuration for connections to github.com. # Configuration for connections to github.com.
599 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. GitHub App installation id.
600 &quot;authorizerCredential&quot;: { # 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.
601 &quot;oauthTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
602 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
603 },
604 &quot;githubApp&quot;: &quot;A String&quot;, # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
605 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
606 },
607 &quot;githubEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
608 &quot;appId&quot;: &quot;A String&quot;, # Optional. ID of the GitHub App created from the manifest.
609 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. ID of the installation of the GitHub App.
610 &quot;appSlug&quot;: &quot;A String&quot;, # Output only. The URL-friendly name of the GitHub App.
611 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitHub Enterprise host this connection is for.
612 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
613 &quot;organization&quot;: &quot;A String&quot;, # Optional. Immutable. GitHub Enterprise organization in which the GitHub App is created.
614 &quot;privateKeySecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
615 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. GitHub Enterprise version installed at the host_uri.
616 &quot;serviceDirectoryConfig&quot;: { # 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.
617 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
618 },
619 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate to use for requests to GitHub Enterprise.
620 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
621 },
622 &quot;gitlabConfig&quot;: { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
623 &quot;authorizerCredential&quot;: { # 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.
624 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
625 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
626 },
627 &quot;readAuthorizerCredential&quot;: { # 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.
628 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
629 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
630 },
631 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
632 },
633 &quot;gitlabEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
634 &quot;authorizerCredential&quot;: { # 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.
635 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
636 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
637 },
638 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitLab Enterprise host this connection is for.
639 &quot;readAuthorizerCredential&quot;: { # 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.
640 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
641 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
642 },
643 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
644 &quot;serviceDirectoryConfig&quot;: { # 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.
645 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
646 },
647 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
648 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
649 },
650 &quot;httpConfig&quot;: { # Defines the configuration for connections to an HTTP service provider. # Optional. Configuration for connections to an HTTP service provider.
651 &quot;basicAuthentication&quot;: { # Basic authentication with username and password. # Optional. Basic authentication with username and password.
652 &quot;passwordSecretVersion&quot;: &quot;A String&quot;, # The password SecretManager secret version to authenticate as.
653 &quot;username&quot;: &quot;A String&quot;, # Required. The username to authenticate as.
654 },
655 &quot;bearerTokenAuthentication&quot;: { # Bearer token authentication with a token. # Optional. Bearer token authentication with a token.
656 &quot;tokenSecretVersion&quot;: &quot;A String&quot;, # Optional. The token SecretManager secret version to authenticate as.
657 },
658 &quot;hostUri&quot;: &quot;A String&quot;, # Required. Immutable. The service provider&#x27;s https endpoint.
659 &quot;serviceDirectoryConfig&quot;: { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a HTTP service provider. This should only be set if the Http service provider is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the HTTP service provider will be made over the public internet.
660 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
661 },
662 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. The SSL certificate to use for requests to the HTTP service provider.
663 },
664 &quot;installationState&quot;: { # 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.
665 &quot;actionUri&quot;: &quot;A String&quot;, # Output only. Link to follow for next action. Empty string if the installation is already complete.
666 &quot;message&quot;: &quot;A String&quot;, # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
667 &quot;stage&quot;: &quot;A String&quot;, # Output only. Current step of the installation process.
668 },
669 &quot;labels&quot;: { # Optional. Labels as key value pairs
670 &quot;a_key&quot;: &quot;A String&quot;,
671 },
672 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
673 &quot;reconciling&quot;: True or False, # Output only. Set to true when the connection is being set up or updated in the background.
674 &quot;secureSourceManagerInstanceConfig&quot;: { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
675 &quot;instance&quot;: &quot;A String&quot;, # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
676 },
677 &quot;uid&quot;: &quot;A String&quot;, # Output only. A system-assigned unique identifier for the Connection.
678 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update timestamp
679 },
680 ],
681 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
682 &quot;unreachable&quot;: [ # Locations that could not be reached.
683 &quot;A String&quot;,
684 ],
685 }</pre>
686 </div>
687
688 <div class="method">
689 <code class="details" id="list_next">list_next()</code>
690 <pre>Retrieves the next page of results.
691
692 Args:
693 previous_request: The request for the previous page. (required)
694 previous_response: The response from the request for the previous page. (required)
695
696 Returns:
697 A request object that you can call &#x27;execute()&#x27; on to request the next
698 page. Returns None if there are no more items in the collection.
699 </pre>
700 </div>
701
702 <div class="method">
703 <code class="details" id="patch">patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
704 <pre>Updates the parameters of a single Connection.
705
706 Args:
707 name: string, Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`. (required)
708 body: object, The request body.
709 The object takes the form of:
710
711 { # Message describing Connection object
712 &quot;annotations&quot;: { # Optional. Allows clients to store small amounts of arbitrary data.
713 &quot;a_key&quot;: &quot;A String&quot;,
714 },
715 &quot;bitbucketCloudConfig&quot;: { # Configuration for connections to an instance of Bitbucket Cloud. # Configuration for connections to an instance of Bitbucket Clouds.
716 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
717 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
718 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
719 },
720 &quot;readAuthorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate the credentials.
721 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
722 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
723 },
724 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate and create webhooks.
725 &quot;workspace&quot;: &quot;A String&quot;, # Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
726 },
727 &quot;bitbucketDataCenterConfig&quot;: { # Configuration for connections to an instance of Bitbucket Data Center. # Configuration for connections to an instance of Bitbucket Data Center.
728 &quot;authorizerCredential&quot;: { # 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&#x27;s recommended to use a system account to generate these credentials.
729 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
730 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
731 },
732 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the Bitbucket Data Center host this connection is for.
733 &quot;readAuthorizerCredential&quot;: { # Represents a personal access token that authorized the Connection, and associated metadata. # Required. An http access token with the minimum `Repository read` access. It&#x27;s recommended to use a system account to generate the credentials.
734 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
735 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
736 },
737 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the Bitbucket Data Center server running on the `host_uri`.
738 &quot;serviceDirectoryConfig&quot;: { # 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.
739 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
740 },
741 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
742 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
743 },
744 &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create timestamp
745 &quot;cryptoKeyConfig&quot;: { # 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.
746 &quot;keyReference&quot;: &quot;A String&quot;, # 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/*`.
747 },
748 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. [Output only] Delete timestamp
749 &quot;disabled&quot;: 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.
750 &quot;etag&quot;: &quot;A String&quot;, # 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.
751 &quot;gitProxyConfig&quot;: { # 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. [Learn more](https://docs.cloud.google.com/developer-connect/docs/configure-git-proxy).
752 &quot;enabled&quot;: 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.
753 &quot;httpProxyBaseUri&quot;: &quot;A String&quot;, # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-c-h-{shortRegion}.developerconnect.dev` Populated only when enabled is set to true. This endpoint is used by other Google services that integrate with Developer Connect.
754 },
755 &quot;githubConfig&quot;: { # Configuration for connections to github.com. # Configuration for connections to github.com.
756 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. GitHub App installation id.
757 &quot;authorizerCredential&quot;: { # 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.
758 &quot;oauthTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
759 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
760 },
761 &quot;githubApp&quot;: &quot;A String&quot;, # Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
762 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.
763 },
764 &quot;githubEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitHub Enterprise. # Configuration for connections to an instance of GitHub Enterprise.
765 &quot;appId&quot;: &quot;A String&quot;, # Optional. ID of the GitHub App created from the manifest.
766 &quot;appInstallationId&quot;: &quot;A String&quot;, # Optional. ID of the installation of the GitHub App.
767 &quot;appSlug&quot;: &quot;A String&quot;, # Output only. The URL-friendly name of the GitHub App.
768 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitHub Enterprise host this connection is for.
769 &quot;installationUri&quot;: &quot;A String&quot;, # Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
770 &quot;organization&quot;: &quot;A String&quot;, # Optional. Immutable. GitHub Enterprise organization in which the GitHub App is created.
771 &quot;privateKeySecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
772 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. GitHub Enterprise version installed at the host_uri.
773 &quot;serviceDirectoryConfig&quot;: { # 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.
774 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
775 },
776 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL certificate to use for requests to GitHub Enterprise.
777 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
778 },
779 &quot;gitlabConfig&quot;: { # Configuration for connections to gitlab.com. # Configuration for connections to gitlab.com.
780 &quot;authorizerCredential&quot;: { # 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.
781 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
782 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
783 },
784 &quot;readAuthorizerCredential&quot;: { # 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.
785 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
786 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
787 },
788 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
789 },
790 &quot;gitlabEnterpriseConfig&quot;: { # Configuration for connections to an instance of GitLab Enterprise. # Configuration for connections to an instance of GitLab Enterprise.
791 &quot;authorizerCredential&quot;: { # 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.
792 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
793 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
794 },
795 &quot;hostUri&quot;: &quot;A String&quot;, # Required. The URI of the GitLab Enterprise host this connection is for.
796 &quot;readAuthorizerCredential&quot;: { # 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.
797 &quot;userTokenSecretVersion&quot;: &quot;A String&quot;, # Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).
798 &quot;username&quot;: &quot;A String&quot;, # Output only. The username associated with this token.
799 },
800 &quot;serverVersion&quot;: &quot;A String&quot;, # Output only. Version of the GitLab Enterprise server running on the `host_uri`.
801 &quot;serviceDirectoryConfig&quot;: { # 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.
802 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
803 },
804 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
805 &quot;webhookSecretSecretVersion&quot;: &quot;A String&quot;, # Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.
806 },
807 &quot;httpConfig&quot;: { # Defines the configuration for connections to an HTTP service provider. # Optional. Configuration for connections to an HTTP service provider.
808 &quot;basicAuthentication&quot;: { # Basic authentication with username and password. # Optional. Basic authentication with username and password.
809 &quot;passwordSecretVersion&quot;: &quot;A String&quot;, # The password SecretManager secret version to authenticate as.
810 &quot;username&quot;: &quot;A String&quot;, # Required. The username to authenticate as.
811 },
812 &quot;bearerTokenAuthentication&quot;: { # Bearer token authentication with a token. # Optional. Bearer token authentication with a token.
813 &quot;tokenSecretVersion&quot;: &quot;A String&quot;, # Optional. The token SecretManager secret version to authenticate as.
814 },
815 &quot;hostUri&quot;: &quot;A String&quot;, # Required. Immutable. The service provider&#x27;s https endpoint.
816 &quot;serviceDirectoryConfig&quot;: { # ServiceDirectoryConfig represents Service Directory configuration for a connection. # Optional. Configuration for using Service Directory to privately connect to a HTTP service provider. This should only be set if the Http service provider is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the HTTP service provider will be made over the public internet.
817 &quot;service&quot;: &quot;A String&quot;, # Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
818 },
819 &quot;sslCaCertificate&quot;: &quot;A String&quot;, # Optional. The SSL certificate to use for requests to the HTTP service provider.
820 },
821 &quot;installationState&quot;: { # 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.
822 &quot;actionUri&quot;: &quot;A String&quot;, # Output only. Link to follow for next action. Empty string if the installation is already complete.
823 &quot;message&quot;: &quot;A String&quot;, # Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
824 &quot;stage&quot;: &quot;A String&quot;, # Output only. Current step of the installation process.
825 },
826 &quot;labels&quot;: { # Optional. Labels as key value pairs
827 &quot;a_key&quot;: &quot;A String&quot;,
828 },
829 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
830 &quot;reconciling&quot;: True or False, # Output only. Set to true when the connection is being set up or updated in the background.
831 &quot;secureSourceManagerInstanceConfig&quot;: { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
832 &quot;instance&quot;: &quot;A String&quot;, # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
833 },
834 &quot;uid&quot;: &quot;A String&quot;, # Output only. A system-assigned unique identifier for the Connection.
835 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update timestamp
836 }
837
838 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).
839 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).
840 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.
841 validateOnly: boolean, Optional. If set, validate the request, but do not actually post it.
842 x__xgafv: string, V1 error format.
843 Allowed values
844 1 - v1 error format
845 2 - v2 error format
846
847 Returns:
848 An object of the form:
849
850 { # This resource represents a long-running operation that is the result of a network API call.
851 &quot;done&quot;: 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.
852 &quot;error&quot;: { # 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.
853 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
854 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
855 {
856 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
857 },
858 ],
859 &quot;message&quot;: &quot;A String&quot;, # 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.
860 },
861 &quot;metadata&quot;: { # 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.
862 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
863 },
864 &quot;name&quot;: &quot;A String&quot;, # 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}`.
865 &quot;response&quot;: { # 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`.
866 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
867 },
868 }</pre>
869 </div>
870
871 <div class="method">
872 <code class="details" id="processGitHubEnterpriseWebhook">processGitHubEnterpriseWebhook(parent, body=None, x__xgafv=None)</code>
873 <pre>ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.
874
875 Args:
876 parent: string, Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`. (required)
877 body: object, The request body.
878 The object takes the form of:
879
880 { # RPC request object accepted by the ProcessGitHubEnterpriseWebhook RPC method.
881 &quot;body&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;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.
882 &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
883 &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
884 &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
885 {
886 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
887 },
888 ],
889 },
890 }
891
892 x__xgafv: string, V1 error format.
893 Allowed values
894 1 - v1 error format
895 2 - v2 error format
896
897 Returns:
898 An object of the form:
899
900 { # 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); }
901 }</pre>
902 </div>
903
904 </body></html>