File: securesourcemanager_v1.projects.locations.repositories.pullRequests.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (479 lines) | stat: -rw-r--r-- 30,873 bytes parent folder | download
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
<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="securesourcemanager_v1.html">Secure Source Manager API</a> . <a href="securesourcemanager_v1.projects.html">projects</a> . <a href="securesourcemanager_v1.projects.locations.html">locations</a> . <a href="securesourcemanager_v1.projects.locations.repositories.html">repositories</a> . <a href="securesourcemanager_v1.projects.locations.repositories.pullRequests.html">pullRequests</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="securesourcemanager_v1.projects.locations.repositories.pullRequests.pullRequestComments.html">pullRequestComments()</a></code>
</p>
<p class="firstline">Returns the pullRequestComments Resource.</p>

<p class="toc_element">
  <code><a href="#close">close(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Closes a pull request without merging.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a pull request.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a pull request.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists pull requests in a repository.</p>
<p class="toc_element">
  <code><a href="#listFileDiffs">listFileDiffs(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a pull request's file diffs.</p>
<p class="toc_element">
  <code><a href="#listFileDiffs_next">listFileDiffs_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</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="#merge">merge(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Merges a pull request.</p>
<p class="toc_element">
  <code><a href="#open">open(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Opens a pull request.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a pull request.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close(name, body=None, x__xgafv=None)</code>
  <pre>Closes a pull request without merging.

Args:
  name: string, Required. The pull request to close. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # ClosePullRequestRequest is the request to close a pull request.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a pull request.

Args:
  parent: string, Required. The repository that the pull request is created from. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
  &quot;base&quot;: { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
    &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
    &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
  },
  &quot;body&quot;: &quot;A String&quot;, # Optional. The pull request body. Provides a detailed description of the changes.
  &quot;closeTime&quot;: &quot;A String&quot;, # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp.
  &quot;head&quot;: { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
    &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
    &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the pull request (open, closed or merged).
  &quot;title&quot;: &quot;A String&quot;, # Required. The pull request title.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets a pull request.

Args:
  name: string, Required. Name of the pull request to retrieve. The format is `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
  &quot;base&quot;: { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
    &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
    &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
  },
  &quot;body&quot;: &quot;A String&quot;, # Optional. The pull request body. Provides a detailed description of the changes.
  &quot;closeTime&quot;: &quot;A String&quot;, # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp.
  &quot;head&quot;: { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
    &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
    &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the pull request (open, closed or merged).
  &quot;title&quot;: &quot;A String&quot;, # Required. The pull request title.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists pull requests in a repository.

Args:
  parent: string, Required. The repository in which to list pull requests. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}` (required)
  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:

    { # ListPullRequestsResponse is the response to list pull requests.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
  &quot;pullRequests&quot;: [ # The list of pull requests.
    { # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
      &quot;base&quot;: { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
        &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
        &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
      },
      &quot;body&quot;: &quot;A String&quot;, # Optional. The pull request body. Provides a detailed description of the changes.
      &quot;closeTime&quot;: &quot;A String&quot;, # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp.
      &quot;head&quot;: { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
        &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
        &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
      },
      &quot;name&quot;: &quot;A String&quot;, # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
      &quot;state&quot;: &quot;A String&quot;, # Output only. State of the pull request (open, closed or merged).
      &quot;title&quot;: &quot;A String&quot;, # Required. The pull request title.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="listFileDiffs">listFileDiffs(name, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists a pull request&#x27;s file diffs.

Args:
  name: string, Required. The pull request to list file diffs for. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
  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:

    { # ListPullRequestFileDiffsResponse is the response containing file diffs returned from ListPullRequestFileDiffs.
  &quot;fileDiffs&quot;: [ # The list of pull request file diffs.
    { # Metadata of a FileDiff. FileDiff represents a single file diff in a pull request.
      &quot;action&quot;: &quot;A String&quot;, # Output only. The action taken on the file (eg. added, modified, deleted).
      &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the file.
      &quot;patch&quot;: &quot;A String&quot;, # Output only. The git patch containing the file changes.
      &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit pointing to the file changes.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
}</pre>
</div>

<div class="method">
    <code class="details" id="listFileDiffs_next">listFileDiffs_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 &#x27;execute()&#x27; 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="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 &#x27;execute()&#x27; 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="merge">merge(name, body=None, x__xgafv=None)</code>
  <pre>Merges a pull request.

Args:
  name: string, Required. The pull request to merge. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # MergePullRequestRequest is the request to merge a pull request.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="open">open(name, body=None, x__xgafv=None)</code>
  <pre>Opens a pull request.

Args:
  name: string, Required. The pull request to open. Format: `projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # OpenPullRequestRequest is the request to open a pull request.
}

  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a pull request.

Args:
  name: string, Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Metadata of a PullRequest. PullRequest is the request from a user to merge a branch (head) into another branch (base).
  &quot;base&quot;: { # Branch represents a branch involved in a pull request. # Required. The branch to merge changes in.
    &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
    &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
  },
  &quot;body&quot;: &quot;A String&quot;, # Optional. The pull request body. Provides a detailed description of the changes.
  &quot;closeTime&quot;: &quot;A String&quot;, # Output only. Close timestamp (if closed or merged). Cleared when pull request is re-opened.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Creation timestamp.
  &quot;head&quot;: { # Branch represents a branch involved in a pull request. # Immutable. The branch containing the changes to be merged.
    &quot;ref&quot;: &quot;A String&quot;, # Required. Name of the branch.
    &quot;sha&quot;: &quot;A String&quot;, # Output only. The commit at the tip of the branch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Output only. A unique identifier for a PullRequest. The number appended at the end is generated by the server. Format: `projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request_id}`
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the pull request (open, closed or merged).
  &quot;title&quot;: &quot;A String&quot;, # Required. The pull request title.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last updated timestamp.
}

  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the pull request resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The special value &quot;*&quot; means full replacement.
  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.
  &quot;done&quot;: 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.
  &quot;error&quot;: { # 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.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # 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.
  },
  &quot;metadata&quot;: { # 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.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # 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}`.
  &quot;response&quot;: { # 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`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>