Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / cloudbuild_v1.operations.html
blob: 88d02631fc5cb615c13607ad98e07e54c551a482 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudbuild_v1.html">Google Cloud Container Builder API</a> . <a href="cloudbuild_v1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]78 <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
80<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
83<p class="toc_element">
84 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]91 <code class="details" id="cancel">cancel(name, body, x__xgafv=None)</code>
92 <pre>Starts asynchronous cancellation on a long-running operation. The server
93makes a best effort to cancel the operation, but success is not
94guaranteed. If the server doesn't support this method, it returns
95`google.rpc.Code.UNIMPLEMENTED`. Clients can use
96Operations.GetOperation or
97other methods to check whether the cancellation succeeded or whether the
98operation completed despite cancellation. On successful cancellation,
99the operation is not deleted; instead, it becomes an operation with
100an Operation.error value with a google.rpc.Status.code of 1,
101corresponding to `Code.CANCELLED`.
102
103Args:
104 name: string, The name of the operation resource to be cancelled. (required)
105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # The request message for Operations.CancelOperation.
109 }
110
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A generic empty message that you can re-use to avoid defining duplicated
120 # empty messages in your APIs. A typical example is to use it as the request
121 # or the response type of an API method. For instance:
122 #
123 # service Foo {
124 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
125 # }
126 #
127 # The JSON representation for `Empty` is empty JSON object `{}`.
128 }</pre>
129</div>
130
131<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]132 <code class="details" id="get">get(name, x__xgafv=None)</code>
133 <pre>Gets the latest state of a long-running operation. Clients can use this
134method to poll the operation result at intervals as recommended by the API
135service.
136
137Args:
138 name: string, The name of the operation resource. (required)
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # This resource represents a long-running operation that is the result of a
148 # network API call.
149 "metadata": { # Service-specific metadata associated with the operation. It typically
150 # contains progress information and common metadata such as create time.
151 # Some services might not provide such metadata. Any method that returns a
152 # long-running operation should document the metadata type, if any.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]153 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]154 },
155 "done": True or False, # If the value is `false`, it means the operation is still in progress.
156 # If true, the operation is completed, and either `error` or `response` is
157 # available.
158 "response": { # The normal response of the operation in case of success. If the original
159 # method returns no data on success, such as `Delete`, the response is
160 # `google.protobuf.Empty`. If the original method is standard
161 # `Get`/`Create`/`Update`, the response should be the resource. For other
162 # methods, the response should have the type `XxxResponse`, where `Xxx`
163 # is the original method name. For example, if the original method name
164 # is `TakeSnapshot()`, the inferred response type is
165 # `TakeSnapshotResponse`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]166 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]167 },
168 "name": "A String", # The server-assigned name, which is only unique within the same service that
169 # originally returns it. If you use the default HTTP mapping, the
170 # `name` should have the format of `operations/some/unique/name`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]171 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]172 # programming environments, including REST APIs and RPC APIs. It is used by
173 # [gRPC](https://github.com/grpc). The error model is designed to be:
174 #
175 # - Simple to use and understand for most users
176 # - Flexible enough to meet unexpected needs
177 #
178 # # Overview
179 #
180 # The `Status` message contains three pieces of data: error code, error message,
181 # and error details. The error code should be an enum value of
182 # google.rpc.Code, but it may accept additional error codes if needed. The
183 # error message should be a developer-facing English message that helps
184 # developers *understand* and *resolve* the error. If a localized user-facing
185 # error message is needed, put the localized message in the error details or
186 # localize it in the client. The optional error details may contain arbitrary
187 # information about the error. There is a predefined set of error detail types
188 # in the package `google.rpc` which can be used for common error conditions.
189 #
190 # # Language mapping
191 #
192 # The `Status` message is the logical representation of the error model, but it
193 # is not necessarily the actual wire format. When the `Status` message is
194 # exposed in different client libraries and different wire protocols, it can be
195 # mapped differently. For example, it will likely be mapped to some exceptions
196 # in Java, but more likely mapped to some error codes in C.
197 #
198 # # Other uses
199 #
200 # The error model and the `Status` message can be used in a variety of
201 # environments, either with or without APIs, to provide a
202 # consistent developer experience across different environments.
203 #
204 # Example uses of this error model include:
205 #
206 # - Partial errors. If a service needs to return partial errors to the client,
207 # it may embed the `Status` in the normal response to indicate the partial
208 # errors.
209 #
210 # - Workflow errors. A typical workflow has multiple steps. Each step may
211 # have a `Status` message for error reporting purpose.
212 #
213 # - Batch operations. If a client uses batch request and batch response, the
214 # `Status` message should be used directly inside batch response, one for
215 # each error sub-response.
216 #
217 # - Asynchronous operations. If an API call embeds asynchronous operation
218 # results in its response, the status of those operations should be
219 # represented directly using the `Status` message.
220 #
221 # - Logging. If some API errors are stored in logs, the message `Status` could
222 # be used directly after any stripping needed for security/privacy reasons.
223 "message": "A String", # A developer-facing error message, which should be in English. Any
224 # user-facing error message should be localized and sent in the
225 # google.rpc.Status.details field, or localized by the client.
226 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
227 "details": [ # A list of messages that carry the error details. There will be a
228 # common set of message types for APIs to use.
229 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]230 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]231 },
232 ],
233 },
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
239 <pre>Lists operations that match the specified filter in the request. If the
240server doesn't support this method, it returns `UNIMPLEMENTED`.
241
242NOTE: the `name` binding below allows API services to override the binding
243to use different resource name schemes, such as `users/*/operations`.
244
245Args:
246 name: string, The name of the operation collection. (required)
247 pageSize: integer, The standard list page size.
248 filter: string, The standard list filter.
249 pageToken: string, The standard list page token.
250 x__xgafv: string, V1 error format.
251 Allowed values
252 1 - v1 error format
253 2 - v2 error format
254
255Returns:
256 An object of the form:
257
258 { # The response message for Operations.ListOperations.
259 "nextPageToken": "A String", # The standard List next-page token.
260 "operations": [ # A list of operations that matches the specified filter in the request.
261 { # This resource represents a long-running operation that is the result of a
262 # network API call.
263 "metadata": { # Service-specific metadata associated with the operation. It typically
264 # contains progress information and common metadata such as create time.
265 # Some services might not provide such metadata. Any method that returns a
266 # long-running operation should document the metadata type, if any.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]267 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]268 },
269 "done": True or False, # If the value is `false`, it means the operation is still in progress.
270 # If true, the operation is completed, and either `error` or `response` is
271 # available.
272 "response": { # The normal response of the operation in case of success. If the original
273 # method returns no data on success, such as `Delete`, the response is
274 # `google.protobuf.Empty`. If the original method is standard
275 # `Get`/`Create`/`Update`, the response should be the resource. For other
276 # methods, the response should have the type `XxxResponse`, where `Xxx`
277 # is the original method name. For example, if the original method name
278 # is `TakeSnapshot()`, the inferred response type is
279 # `TakeSnapshotResponse`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]280 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]281 },
282 "name": "A String", # The server-assigned name, which is only unique within the same service that
283 # originally returns it. If you use the default HTTP mapping, the
284 # `name` should have the format of `operations/some/unique/name`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]285 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]286 # programming environments, including REST APIs and RPC APIs. It is used by
287 # [gRPC](https://github.com/grpc). The error model is designed to be:
288 #
289 # - Simple to use and understand for most users
290 # - Flexible enough to meet unexpected needs
291 #
292 # # Overview
293 #
294 # The `Status` message contains three pieces of data: error code, error message,
295 # and error details. The error code should be an enum value of
296 # google.rpc.Code, but it may accept additional error codes if needed. The
297 # error message should be a developer-facing English message that helps
298 # developers *understand* and *resolve* the error. If a localized user-facing
299 # error message is needed, put the localized message in the error details or
300 # localize it in the client. The optional error details may contain arbitrary
301 # information about the error. There is a predefined set of error detail types
302 # in the package `google.rpc` which can be used for common error conditions.
303 #
304 # # Language mapping
305 #
306 # The `Status` message is the logical representation of the error model, but it
307 # is not necessarily the actual wire format. When the `Status` message is
308 # exposed in different client libraries and different wire protocols, it can be
309 # mapped differently. For example, it will likely be mapped to some exceptions
310 # in Java, but more likely mapped to some error codes in C.
311 #
312 # # Other uses
313 #
314 # The error model and the `Status` message can be used in a variety of
315 # environments, either with or without APIs, to provide a
316 # consistent developer experience across different environments.
317 #
318 # Example uses of this error model include:
319 #
320 # - Partial errors. If a service needs to return partial errors to the client,
321 # it may embed the `Status` in the normal response to indicate the partial
322 # errors.
323 #
324 # - Workflow errors. A typical workflow has multiple steps. Each step may
325 # have a `Status` message for error reporting purpose.
326 #
327 # - Batch operations. If a client uses batch request and batch response, the
328 # `Status` message should be used directly inside batch response, one for
329 # each error sub-response.
330 #
331 # - Asynchronous operations. If an API call embeds asynchronous operation
332 # results in its response, the status of those operations should be
333 # represented directly using the `Status` message.
334 #
335 # - Logging. If some API errors are stored in logs, the message `Status` could
336 # be used directly after any stripping needed for security/privacy reasons.
337 "message": "A String", # A developer-facing error message, which should be in English. Any
338 # user-facing error message should be localized and sent in the
339 # google.rpc.Status.details field, or localized by the client.
340 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
341 "details": [ # A list of messages that carry the error details. There will be a
342 # common set of message types for APIs to use.
343 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]344 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]345 },
346 ],
347 },
348 },
349 ],
350 }</pre>
351</div>
352
353<div class="method">
354 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
355 <pre>Retrieves the next page of results.
356
357Args:
358 previous_request: The request for the previous page. (required)
359 previous_response: The response from the request for the previous page. (required)
360
361Returns:
362 A request object that you can call 'execute()' on to request the next
363 page. Returns None if there are no more items in the collection.
364 </pre>
365</div>
366
367</body></html>