1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
<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_v2.html">Cloud Build API</a> . <a href="cloudbuild_v2.projects.html">projects</a> . <a href="cloudbuild_v2.projects.locations.html">locations</a> . <a href="cloudbuild_v2.projects.locations.connections.html">connections</a> . <a href="cloudbuild_v2.projects.locations.connections.repositories.html">repositories</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#accessReadToken">accessReadToken(repository, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches read token of a given repository.</p>
<p class="toc_element">
<code><a href="#accessReadWriteToken">accessReadWriteToken(repository, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches read/write token of a given repository.</p>
<p class="toc_element">
<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates multiple repositories inside a connection.</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, repositoryId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Repository.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single repository.</p>
<p class="toc_element">
<code><a href="#fetchGitRefs">fetchGitRefs(repository, pageSize=None, pageToken=None, refType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetch the list of branches or tags for a given repository.</p>
<p class="toc_element">
<code><a href="#fetchGitRefs_next">fetchGitRefs_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single repository.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Repositories in a given connection.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="accessReadToken">accessReadToken(repository, body=None, x__xgafv=None)</code>
<pre>Fetches read token of a given repository.
Args:
repository: string, Required. The resource name of the repository in the format `projects/*/locations/*/connections/*/repositories/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Message for fetching SCM read token.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for responding to get read token.
"expirationTime": "A String", # Expiration timestamp. Can be empty if unknown or non-expiring.
"token": "A String", # The token content.
}</pre>
</div>
<div class="method">
<code class="details" id="accessReadWriteToken">accessReadWriteToken(repository, body=None, x__xgafv=None)</code>
<pre>Fetches read/write token of a given repository.
Args:
repository: string, Required. The resource name of the repository in the format `projects/*/locations/*/connections/*/repositories/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Message for fetching SCM read/write token.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for responding to get read/write token.
"expirationTime": "A String", # Expiration timestamp. Can be empty if unknown or non-expiring.
"token": "A String", # The token content.
}</pre>
</div>
<div class="method">
<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
<pre>Creates multiple repositories inside a connection.
Args:
parent: string, Required. The connection to contain all the repositories being created. Format: projects/*/locations/*/connections/* The parent field in the CreateRepositoryRequest messages must either be empty or match this field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for creating repositoritories in batch.
"requests": [ # Required. The request messages specifying the repositories to create.
{ # Message for creating a Repository.
"parent": "A String", # Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there.
"repository": { # A repository associated to a parent connection. # Required. The repository to create.
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
"etag": "A String", # 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.
"name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
"remoteUri": "A String", # Required. Git Clone HTTPS URI.
"updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
"webhookId": "A String", # Output only. External ID of the webhook created for the repository.
},
"repositoryId": "A String", # Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.
},
],
}
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="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, repositoryId=None, x__xgafv=None)</code>
<pre>Creates a Repository.
Args:
parent: string, Required. The connection to contain the repository. If the request is part of a BatchCreateRepositoriesRequest, this field should be empty or match the parent specified there. (required)
body: object, The request body.
The object takes the form of:
{ # A repository associated to a parent connection.
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
"etag": "A String", # 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.
"name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
"remoteUri": "A String", # Required. Git Clone HTTPS URI.
"updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
"webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}
repositoryId: string, Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, etag=None, validateOnly=None, x__xgafv=None)</code>
<pre>Deletes a single repository.
Args:
name: string, Required. The name of the Repository to delete. Format: `projects/*/locations/*/connections/*/repositories/*`. (required)
etag: string, The current etag of the repository. If an etag is provided and does not match the current etag of the repository, deletion will be blocked and an ABORTED error will be returned.
validateOnly: boolean, If set, validate the request, but do not actually post it.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="fetchGitRefs">fetchGitRefs(repository, pageSize=None, pageToken=None, refType=None, x__xgafv=None)</code>
<pre>Fetch the list of branches or tags for a given repository.
Args:
repository: string, Required. The resource name of the repository in the format `projects/*/locations/*/connections/*/repositories/*`. (required)
pageSize: integer, Optional. Number of results to return in the list. Default to 20.
pageToken: string, Optional. Page start.
refType: string, Type of refs to fetch
Allowed values
REF_TYPE_UNSPECIFIED - No type specified.
TAG - To fetch tags.
BRANCH - To fetch branches.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for fetching git refs
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"refNames": [ # Name of the refs fetched.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="fetchGitRefs_next">fetchGitRefs_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single repository.
Args:
name: string, Required. The name of the Repository to retrieve. Format: `projects/*/locations/*/connections/*/repositories/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A repository associated to a parent connection.
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
"etag": "A String", # 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.
"name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
"remoteUri": "A String", # Required. Git Clone HTTPS URI.
"updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
"webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
<pre>Lists Repositories in a given connection.
Args:
parent: string, Required. The parent, which owns this collection of Repositories. Format: `projects/*/locations/*/connections/*`. (required)
filter: string, A filter expression that filters resources listed in the response. Expressions must follow API improvement proposal [AIP-160](https://google.aip.dev/160). e.g. `remote_uri:"https://github.com*"`.
pageSize: integer, Number of results to return in the list.
pageToken: string, Page start.
returnPartialSuccess: boolean, Optional. If set to true, the response will return partial results when some regions are unreachable. If set to false, the response will fail if any region is unreachable.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Repositories.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"repositories": [ # The list of Repositories.
{ # A repository associated to a parent connection.
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"createTime": "A String", # Output only. Server assigned timestamp for when the connection was created.
"etag": "A String", # 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.
"name": "A String", # Immutable. Resource name of the repository, in the format `projects/*/locations/*/connections/*/repositories/*`.
"remoteUri": "A String", # Required. Git Clone HTTPS URI.
"updateTime": "A String", # Output only. Server assigned timestamp for when the connection was updated.
"webhookId": "A String", # Output only. External ID of the webhook created for the repository.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
