1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudbuild_v1.html">Cloud Build API</a> . <a href="cloudbuild_v1.projects.html">projects</a> . <a href="cloudbuild_v1.projects.locations.html">locations</a> . <a href="cloudbuild_v1.projects.locations.gitLabConfigs.html">gitLabConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudbuild_v1.projects.locations.gitLabConfigs.connectedRepositories.html">connectedRepositories()</a></code>
</p>
<p class="firstline">Returns the connectedRepositories Resource.</p>
<p class="toc_element">
<code><a href="cloudbuild_v1.projects.locations.gitLabConfigs.repos.html">repos()</a></code>
</p>
<p class="firstline">Returns the repos Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, gitlabConfigId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new `GitLabConfig`. This API is experimental</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a `GitLabConfig`. This API is experimental</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a `GitLabConfig`. This API is experimental</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all `GitLabConfigs` for a given project. This API is experimental</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing `GitLabConfig`. This API is experimental</p>
<p class="toc_element">
<code><a href="#removeGitLabConnectedRepository">removeGitLabConnectedRepository(config, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, gitlabConfigId=None, x__xgafv=None)</code>
<pre>Creates a new `GitLabConfig`. This API is experimental
Args:
parent: string, Required. Name of the parent resource. (required)
body: object, The request body.
The object takes the form of:
{ # GitLabConfig represents the configuration for a GitLab integration.
"connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
{ # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
"id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
"webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
},
],
"createTime": "A String", # Output only. Time when the config was created.
"enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
"hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
"service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
},
"name": "A String", # The resource name for the config.
"secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
"apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
"apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
"readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
"webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
},
"username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
"webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
}
gitlabConfigId: string, Optional. The ID to use for the GitLabConfig, which will become the final component of the GitLabConfig’s resource name. gitlab_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a `GitLabConfig`. This API is experimental
Args:
name: string, Required. The config resource name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves a `GitLabConfig`. This API is experimental
Args:
name: string, Required. The config resource name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # GitLabConfig represents the configuration for a GitLab integration.
"connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
{ # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
"id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
"webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
},
],
"createTime": "A String", # Output only. Time when the config was created.
"enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
"hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
"service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
},
"name": "A String", # The resource name for the config.
"secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
"apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
"apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
"readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
"webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
},
"username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
"webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List all `GitLabConfigs` for a given project. This API is experimental
Args:
parent: string, Required. Name of the parent resource (required)
pageSize: integer, The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 50 configs will be returned. The maximum value is 1000;, values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous ‘ListGitlabConfigsRequest’ call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ‘ListGitlabConfigsRequest’ must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # RPC response object returned by ListGitLabConfigs RPC method.
"gitlabConfigs": [ # A list of GitLabConfigs
{ # GitLabConfig represents the configuration for a GitLab integration.
"connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
{ # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
"id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
"webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
},
],
"createTime": "A String", # Output only. Time when the config was created.
"enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
"hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
"service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
},
"name": "A String", # The resource name for the config.
"secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
"apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
"apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
"readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
"webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
},
"username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
"webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
},
],
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing `GitLabConfig`. This API is experimental
Args:
name: string, The resource name for the config. (required)
body: object, The request body.
The object takes the form of:
{ # GitLabConfig represents the configuration for a GitLab integration.
"connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
{ # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
"id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
"webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
},
],
"createTime": "A String", # Output only. Time when the config was created.
"enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config.
"hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host.
"serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance.
"service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.
},
"sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances.
},
"name": "A String", # The resource name for the config.
"secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config.
"apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version
"apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build.
"readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version
"webhookSecretVersion": "A String", # Required. Immutable. The resource name for the webhook secret’s secret version. Once this field has been set, it cannot be changed. If you need to change it, please create another GitLabConfig.
},
"username": "A String", # Username of the GitLab.com or GitLab Enterprise account Cloud Build will use.
"webhookKey": "A String", # Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config.
}
updateMask: string, Update mask for the resource. If this is set, the server will only update the fields specified in the field mask. Otherwise, a full update of the mutable resource fields will be performed.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="removeGitLabConnectedRepository">removeGitLabConnectedRepository(config, body=None, x__xgafv=None)</code>
<pre>Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.
Args:
config: string, Required. The name of the `GitLabConfig` to remove a connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}` (required)
body: object, The request body.
The object takes the form of:
{ # RPC request object accepted by RemoveGitLabConnectedRepository RPC method.
"connectedRepository": { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise # The connected repository to remove.
"id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
"webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
</body></html>
|
