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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
|
<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="developerconnect_v1.html">Developer Connect API</a> . <a href="developerconnect_v1.projects.html">projects</a> . <a href="developerconnect_v1.projects.locations.html">locations</a> . <a href="developerconnect_v1.projects.locations.connections.html">connections</a> . <a href="developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html">gitRepositoryLinks</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, gitRepositoryLinkId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a GitRepositoryLink. Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single GitRepositoryLink.</p>
<p class="toc_element">
<code><a href="#fetchGitRefs">fetchGitRefs(gitRepositoryLink, 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="#fetchReadToken">fetchReadToken(gitRepositoryLink, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches read token of a given gitRepositoryLink.</p>
<p class="toc_element">
<code><a href="#fetchReadWriteToken">fetchReadWriteToken(gitRepositoryLink, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Fetches read/write token of a given gitRepositoryLink.</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 GitRepositoryLink.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists GitRepositoryLinks in a given project, location, and 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>
<p class="toc_element">
<code><a href="#processBitbucketCloudWebhook">processBitbucketCloudWebhook(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ProcessBitbucketCloudWebhook is called by the external Bitbucket Cloud instances for notifying events.</p>
<p class="toc_element">
<code><a href="#processBitbucketDataCenterWebhook">processBitbucketDataCenterWebhook(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ProcessBitbucketDataCenterWebhook is called by the external Bitbucket Data Center instances for notifying events.</p>
<p class="toc_element">
<code><a href="#processGitLabEnterpriseWebhook">processGitLabEnterpriseWebhook(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.</p>
<p class="toc_element">
<code><a href="#processGitLabWebhook">processGitLabWebhook(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">ProcessGitLabWebhook is called by the GitLab.com for notifying events.</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, gitRepositoryLinkId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Creates a GitRepositoryLink. Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.
Args:
parent: string, Required. Value for parent. (required)
body: object, The request body.
The object takes the form of:
{ # Message describing the GitRepositoryLink object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"cloneUri": "A String", # Required. Git Clone URI.
"createTime": "A String", # Output only. [Output only] Create timestamp
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyUri": "A String", # Output only. URI to access the linked repository through the Git Proxy. This field is only populated if the git proxy is enabled for the connection.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. Resource name of the repository, in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the GitRepositoryLink.
"updateTime": "A String", # Output only. [Output only] Update timestamp
"webhookId": "A String", # Output only. External ID of the webhook created for the repository.
}
gitRepositoryLinkId: 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 -._~%!$&'()*+,;=@.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. 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="delete">delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
<pre>Deletes a single GitRepositoryLink.
Args:
name: string, Required. Name of the resource (required)
etag: string, Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. 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(gitRepositoryLink, pageSize=None, pageToken=None, refType=None, x__xgafv=None)</code>
<pre>Fetch the list of branches or tags for a given repository.
Args:
gitRepositoryLink: string, Required. The resource name of GitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
pageSize: integer, Optional. Number of results to return in the list. Default to 20.
pageToken: string, Optional. Page start.
refType: string, Required. 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="fetchReadToken">fetchReadToken(gitRepositoryLink, body=None, x__xgafv=None)</code>
<pre>Fetches read token of a given gitRepositoryLink.
Args:
gitRepositoryLink: string, Required. The resource name of the gitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (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.
"gitUsername": "A String", # The git_username to specify when making a git clone with the token. For example, for GitHub GitRepositoryLinks, this would be "x-access-token"
"token": "A String", # The token content.
}</pre>
</div>
<div class="method">
<code class="details" id="fetchReadWriteToken">fetchReadWriteToken(gitRepositoryLink, body=None, x__xgafv=None)</code>
<pre>Fetches read/write token of a given gitRepositoryLink.
Args:
gitRepositoryLink: string, Required. The resource name of the gitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (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.
"gitUsername": "A String", # The git_username to specify when making a git clone with the token. For example, for GitHub GitRepositoryLinks, this would be "x-access-token"
"token": "A String", # The token content.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single GitRepositoryLink.
Args:
name: string, Required. Name of the resource (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message describing the GitRepositoryLink object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"cloneUri": "A String", # Required. Git Clone URI.
"createTime": "A String", # Output only. [Output only] Create timestamp
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyUri": "A String", # Output only. URI to access the linked repository through the Git Proxy. This field is only populated if the git proxy is enabled for the connection.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. Resource name of the repository, in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the GitRepositoryLink.
"updateTime": "A String", # Output only. [Output only] Update timestamp
"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, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists GitRepositoryLinks in a given project, location, and connection.
Args:
parent: string, Required. Parent value for ListGitRepositoryLinksRequest (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
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 GitRepositoryLinks
"gitRepositoryLinks": [ # The list of GitRepositoryLinks
{ # Message describing the GitRepositoryLink object
"annotations": { # Optional. Allows clients to store small amounts of arbitrary data.
"a_key": "A String",
},
"cloneUri": "A String", # Required. Git Clone URI.
"createTime": "A String", # Output only. [Output only] Create timestamp
"deleteTime": "A String", # Output only. [Output only] Delete timestamp
"etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
"gitProxyUri": "A String", # Output only. URI to access the linked repository through the Git Proxy. This field is only populated if the git proxy is enabled for the connection.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. Resource name of the repository, in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
"uid": "A String", # Output only. A system-assigned unique identifier for the GitRepositoryLink.
"updateTime": "A String", # Output only. [Output only] Update timestamp
"webhookId": "A String", # Output only. External ID of the webhook created for the repository.
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"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>
<div class="method">
<code class="details" id="processBitbucketCloudWebhook">processBitbucketCloudWebhook(name, body=None, x__xgafv=None)</code>
<pre>ProcessBitbucketCloudWebhook is called by the external Bitbucket Cloud instances for notifying events.
Args:
name: string, Required. The GitRepositoryLink where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
body: object, The request body.
The object takes the form of:
{ # RPC request object accepted by the ProcessBitbucketCloudWebhook RPC method.
"body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
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>
<div class="method">
<code class="details" id="processBitbucketDataCenterWebhook">processBitbucketDataCenterWebhook(name, body=None, x__xgafv=None)</code>
<pre>ProcessBitbucketDataCenterWebhook is called by the external Bitbucket Data Center instances for notifying events.
Args:
name: string, Required. The GitRepositoryLink where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
body: object, The request body.
The object takes the form of:
{ # RPC request object accepted by the ProcessBitbucketDataCenterWebhook RPC method.
"body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
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>
<div class="method">
<code class="details" id="processGitLabEnterpriseWebhook">processGitLabEnterpriseWebhook(name, body=None, x__xgafv=None)</code>
<pre>ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.
Args:
name: string, Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
body: object, The request body.
The object takes the form of:
{ # RPC request object accepted by the ProcessGitLabEnterpriseWebhook RPC method.
"body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
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>
<div class="method">
<code class="details" id="processGitLabWebhook">processGitLabWebhook(name, body=None, x__xgafv=None)</code>
<pre>ProcessGitLabWebhook is called by the GitLab.com for notifying events.
Args:
name: string, Required. The GitRepositoryLink resource where the webhook will be received. Format: `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
body: object, The request body.
The object takes the form of:
{ # RPC request object accepted by the ProcessGitLabWebhook RPC method.
"body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. HTTP request body.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
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>
|