Blame - docs/dyn/cloudbuild_v1.projects.githubEnterpriseConfigs.html - platform/external/python/google-api-python-client

<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>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#create">create(parent, body=None, projectId=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Create an association between a GCP project and a GitHub Enterprise server. This API is experimental.</p>

83

84

<code><a href="#delete">delete(name, configId=None, projectId=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Delete an association between a GCP project and a GitHub Enterprise server. This API is experimental.</p>

86

87

<code><a href="#get">get(name, configId=None, projectId=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Retrieve a GitHubEnterpriseConfig. This API is experimental.</p>

89

90

<code><a href="#list">list(parent, projectId=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">List all GitHubEnterpriseConfigs for a given project. This API is experimental.</p>

92

93

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Update an association between a GCP project and a GitHub Enterprise server. This API is experimental.</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="close">close()</code>

98

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, projectId=None, x__xgafv=None)</code>

103

<pre>Create an association between a GCP project and a GitHub Enterprise server. This API is experimental.

104

105

Args:

106

parent: string, Name of the parent project. For example: projects/{$project_number} or projects/{$project_id} (required)

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

111

"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.

112

"createTime": "A String", # Output only. Time when the installation was associated with the project.

113

"displayName": "A String", # Name to display for this config.

114

"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.

115

"name": "A String", # Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}"

116

"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.

117

"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Names of secrets in Secret Manager.

118

"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.

119

"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.

120

"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.

121

"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.

122

"privateKeyName": "A String", # The resource name for the private key secret.

123

"privateKeyVersionName": "A String", # The resource name for the private key secret version.

124

"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.

125

"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.

126

},

127

"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.

128

"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

129

}

130

131

projectId: string, ID of the project.

132

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

139

140

{ # This resource represents a long-running operation that is the result of a network API call.

141

"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.

142

"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.

143

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

144

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

145

{

146

"a_key": "", # Properties of the object. Contains field @type with type URL.

147

},

148

],

149

"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.

150

},

151

"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.

152

"a_key": "", # Properties of the object. Contains field @type with type URL.

153

},

154

"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}`.

155

"response": { # The normal response of the operation in case of success. 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`.

156

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="delete">delete(name, configId=None, projectId=None, x__xgafv=None)</code>

163

<pre>Delete an association between a GCP project and a GitHub Enterprise server. This API is experimental.

164

165

Args:

166

name: string, This field should contain the name of the enterprise config resource. For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}" (required)

167

configId: string, Unique identifier of the `GitHubEnterpriseConfig`

168

projectId: string, ID of the project

169

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

176

177

{ # This resource represents a long-running operation that is the result of a network API call.

178

"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.

179

"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.

180

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

181

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

182

{

183

"a_key": "", # Properties of the object. Contains field @type with type URL.

184

},

185

],

186

"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.

187

},

188

"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.

189

"a_key": "", # Properties of the object. Contains field @type with type URL.

190

},

191

"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}`.

192

"response": { # The normal response of the operation in case of success. 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`.

193

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="get">get(name, configId=None, projectId=None, x__xgafv=None)</code>

200

<pre>Retrieve a GitHubEnterpriseConfig. This API is experimental.

201

202

Args:

203

name: string, This field should contain the name of the enterprise config resource. For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}" (required)

204

configId: string, Unique identifier of the `GitHubEnterpriseConfig`

205

projectId: string, ID of the project

206

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

213

214

{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

215

"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.

216

"createTime": "A String", # Output only. Time when the installation was associated with the project.

217

"displayName": "A String", # Name to display for this config.

218

"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.

219

"name": "A String", # Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}"

220

"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.

221

"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Names of secrets in Secret Manager.

222

"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.

223

"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.

224

"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.

225

"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.

226

"privateKeyName": "A String", # The resource name for the private key secret.

227

"privateKeyVersionName": "A String", # The resource name for the private key secret version.

228

"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.

229

"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.

230

},

231

"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.

232

"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

}</pre>

</div>

<code class="details" id="list">list(parent, projectId=None, x__xgafv=None)</code>

238

<pre>List all GitHubEnterpriseConfigs for a given project. This API is experimental.

239

240

Args:

241

parent: string, Name of the parent project. For example: projects/{$project_number} or projects/{$project_id} (required)

242

projectId: string, ID of the project

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

251

{ # RPC response object returned by ListGithubEnterpriseConfigs RPC method.

252

"configs": [ # A list of GitHubEnterpriseConfigs

253

{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

254

"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.

255

"createTime": "A String", # Output only. Time when the installation was associated with the project.

256

"displayName": "A String", # Name to display for this config.

257

"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.

258

"name": "A String", # Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}"

259

"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.

260

"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Names of secrets in Secret Manager.

261

"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.

262

"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.

263

"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.

264

"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.

265

"privateKeyName": "A String", # The resource name for the private key secret.

266

"privateKeyVersionName": "A String", # The resource name for the private key secret version.

267

"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.

268

"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.

269

},

270

"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.

271

"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

},

],

}</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

279

<pre>Update an association between a GCP project and a GitHub Enterprise server. This API is experimental.

280

281

Args:

282

name: string, Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}" (required)

283

body: object, The request body.

284

The object takes the form of:

285

286

{ # GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

287

"appId": "A String", # Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.

288

"createTime": "A String", # Output only. Time when the installation was associated with the project.

289

"displayName": "A String", # Name to display for this config.

290

"hostUrl": "A String", # The URL of the github enterprise host the configuration is for.

291

"name": "A String", # Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/githubEnterpriseConfig/{$config_id}"

292

"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.

293

"secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Names of secrets in Secret Manager.

294

"oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager.

295

"oauthClientIdVersionName": "A String", # The resource name for the OAuth client ID secret version in Secret Manager.

296

"oauthSecretName": "A String", # The resource name for the OAuth secret in Secret Manager.

297

"oauthSecretVersionName": "A String", # The resource name for the OAuth secret secret version in Secret Manager.

298

"privateKeyName": "A String", # The resource name for the private key secret.

299

"privateKeyVersionName": "A String", # The resource name for the private key secret version.

300

"webhookSecretName": "A String", # The resource name for the webhook secret in Secret Manager.

301

"webhookSecretVersionName": "A String", # The resource name for the webhook secret secret version in Secret Manager.

302

},

303

"sslCa": "A String", # Optional. SSL certificate to use for requests to GitHub Enterprise.

304

"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

305

}

306

307

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.

308

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

315

316

{ # This resource represents a long-running operation that is the result of a network API call.

317

"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.

318

"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.

319

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

320

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

321

{

322

"a_key": "", # Properties of the object. Contains field @type with type URL.

323

},

324

],

325

"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.

326

},

327

"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.

328

"a_key": "", # Properties of the object. Contains field @type with type URL.

329

},

330

"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}`.

331

"response": { # The normal response of the operation in case of success. 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`.

332

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

</body></html>