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
|
<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.githubEnterpriseConfigs.html">githubEnterpriseConfigs</a></h1>
<h2>Instance Methods</h2>
<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, gheConfigId=None, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create an association between a GCP project and a GitHub Enterprise server.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, configId=None, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete an association between a GCP project and a GitHub Enterprise server.</p>
<p class="toc_element">
<code><a href="#get">get(name, configId=None, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve a GitHubEnterpriseConfig.</p>
<p class="toc_element">
<code><a href="#list">list(parent, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all GitHubEnterpriseConfigs for a given project.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update an association between a GCP project and a GitHub Enterprise server.</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, gheConfigId=None, projectId=None, x__xgafv=None)</code>
<pre>Create an association between a GCP project and a GitHub Enterprise server.
Args:
parent: string, Name of the parent project. For example: projects/{$project_number} or projects/{$project_id} (required)
body: object, The request body.
The object takes the form of:
{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.
"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
"createTime": "A String", # Output only. Time when the installation was associated with the project.
"displayName": "A String", # Optional. Name to display for this config.
"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.
"name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
"peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project.
"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager.
"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.
"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.
"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.
"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.
"privateKeyName": "A String", # The resource name for the private key secret.
"privateKeyVersionName": "A String", # The resource name for the private key secret version.
"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.
"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.
},
"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
}
gheConfigId: string, Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig's resource name. ghe_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
projectId: string, ID of the project.
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, configId=None, projectId=None, x__xgafv=None)</code>
<pre>Delete an association between a GCP project and a GitHub Enterprise server.
Args:
name: string, This field should contain the name of the enterprise config resource. For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
configId: string, Unique identifier of the `GitHubEnterpriseConfig`
projectId: string, ID of the project
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, configId=None, projectId=None, x__xgafv=None)</code>
<pre>Retrieve a GitHubEnterpriseConfig.
Args:
name: string, This field should contain the name of the enterprise config resource. For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
configId: string, Unique identifier of the `GitHubEnterpriseConfig`
projectId: string, ID of the project
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.
"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
"createTime": "A String", # Output only. Time when the installation was associated with the project.
"displayName": "A String", # Optional. Name to display for this config.
"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.
"name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
"peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project.
"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager.
"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.
"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.
"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.
"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.
"privateKeyName": "A String", # The resource name for the private key secret.
"privateKeyVersionName": "A String", # The resource name for the private key secret version.
"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.
"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.
},
"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, projectId=None, x__xgafv=None)</code>
<pre>List all GitHubEnterpriseConfigs for a given project.
Args:
parent: string, Name of the parent project. For example: projects/{$project_number} or projects/{$project_id} (required)
projectId: string, ID of the project
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 ListGithubEnterpriseConfigs RPC method.
"configs": [ # A list of GitHubEnterpriseConfigs
{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.
"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
"createTime": "A String", # Output only. Time when the installation was associated with the project.
"displayName": "A String", # Optional. Name to display for this config.
"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.
"name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
"peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project.
"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager.
"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.
"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.
"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.
"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.
"privateKeyName": "A String", # The resource name for the private key secret.
"privateKeyVersionName": "A String", # The resource name for the private key secret version.
"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.
"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.
},
"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update an association between a GCP project and a GitHub Enterprise server.
Args:
name: string, The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
body: object, The request body.
The object takes the form of:
{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.
"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
"createTime": "A String", # Output only. Time when the installation was associated with the project.
"displayName": "A String", # Optional. Name to display for this config.
"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.
"name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
"peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project.
"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager.
"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.
"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.
"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.
"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.
"privateKeyName": "A String", # The resource name for the private key secret.
"privateKeyVersionName": "A String", # The resource name for the private key secret version.
"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.
"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.
},
"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.
"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
}
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>
</body></html>
|
