blob: 990690daf877b6cbf8b0ae030f12d96d92b1487e [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001<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 -080078 <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 -070081 <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 -080091 <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 -0700132 <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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700149 "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 -0700150 # programming environments, including REST APIs and RPC APIs. It is used by
151 # [gRPC](https://github.com/grpc). The error model is designed to be:
152 #
153 # - Simple to use and understand for most users
154 # - Flexible enough to meet unexpected needs
155 #
156 # # Overview
157 #
158 # The `Status` message contains three pieces of data: error code, error message,
159 # and error details. The error code should be an enum value of
160 # google.rpc.Code, but it may accept additional error codes if needed. The
161 # error message should be a developer-facing English message that helps
162 # developers *understand* and *resolve* the error. If a localized user-facing
163 # error message is needed, put the localized message in the error details or
164 # localize it in the client. The optional error details may contain arbitrary
165 # information about the error. There is a predefined set of error detail types
166 # in the package `google.rpc` which can be used for common error conditions.
167 #
168 # # Language mapping
169 #
170 # The `Status` message is the logical representation of the error model, but it
171 # is not necessarily the actual wire format. When the `Status` message is
172 # exposed in different client libraries and different wire protocols, it can be
173 # mapped differently. For example, it will likely be mapped to some exceptions
174 # in Java, but more likely mapped to some error codes in C.
175 #
176 # # Other uses
177 #
178 # The error model and the `Status` message can be used in a variety of
179 # environments, either with or without APIs, to provide a
180 # consistent developer experience across different environments.
181 #
182 # Example uses of this error model include:
183 #
184 # - Partial errors. If a service needs to return partial errors to the client,
185 # it may embed the `Status` in the normal response to indicate the partial
186 # errors.
187 #
188 # - Workflow errors. A typical workflow has multiple steps. Each step may
189 # have a `Status` message for error reporting purpose.
190 #
191 # - Batch operations. If a client uses batch request and batch response, the
192 # `Status` message should be used directly inside batch response, one for
193 # each error sub-response.
194 #
195 # - Asynchronous operations. If an API call embeds asynchronous operation
196 # results in its response, the status of those operations should be
197 # represented directly using the `Status` message.
198 #
199 # - Logging. If some API errors are stored in logs, the message `Status` could
200 # be used directly after any stripping needed for security/privacy reasons.
201 "message": "A String", # A developer-facing error message, which should be in English. Any
202 # user-facing error message should be localized and sent in the
203 # google.rpc.Status.details field, or localized by the client.
204 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
205 "details": [ # A list of messages that carry the error details. There will be a
206 # common set of message types for APIs to use.
207 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700208 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700209 },
210 ],
211 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400212 "done": True or False, # If the value is `false`, it means the operation is still in progress.
213 # If true, the operation is completed, and either `error` or `response` is
214 # available.
215 "response": { # The normal response of the operation in case of success. If the original
216 # method returns no data on success, such as `Delete`, the response is
217 # `google.protobuf.Empty`. If the original method is standard
218 # `Get`/`Create`/`Update`, the response should be the resource. For other
219 # methods, the response should have the type `XxxResponse`, where `Xxx`
220 # is the original method name. For example, if the original method name
221 # is `TakeSnapshot()`, the inferred response type is
222 # `TakeSnapshotResponse`.
223 "a_key": "", # Properties of the object. Contains field @type with type URL.
224 },
225 "name": "A String", # The server-assigned name, which is only unique within the same service that
226 # originally returns it. If you use the default HTTP mapping, the
227 # `name` should have the format of `operations/some/unique/name`.
Thomas Coffee2f245372017-03-27 10:39:26 -0700228 "metadata": { # Service-specific metadata associated with the operation. It typically
229 # contains progress information and common metadata such as create time.
230 # Some services might not provide such metadata. Any method that returns a
231 # long-running operation should document the metadata type, if any.
232 "a_key": "", # Properties of the object. Contains field @type with type URL.
233 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700234 }</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.
Thomas Coffee2f245372017-03-27 10:39:26 -0700259 "nextPageToken": "A String", # The standard List next-page token.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700260 "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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700263 "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 -0700264 # programming environments, including REST APIs and RPC APIs. It is used by
265 # [gRPC](https://github.com/grpc). The error model is designed to be:
266 #
267 # - Simple to use and understand for most users
268 # - Flexible enough to meet unexpected needs
269 #
270 # # Overview
271 #
272 # The `Status` message contains three pieces of data: error code, error message,
273 # and error details. The error code should be an enum value of
274 # google.rpc.Code, but it may accept additional error codes if needed. The
275 # error message should be a developer-facing English message that helps
276 # developers *understand* and *resolve* the error. If a localized user-facing
277 # error message is needed, put the localized message in the error details or
278 # localize it in the client. The optional error details may contain arbitrary
279 # information about the error. There is a predefined set of error detail types
280 # in the package `google.rpc` which can be used for common error conditions.
281 #
282 # # Language mapping
283 #
284 # The `Status` message is the logical representation of the error model, but it
285 # is not necessarily the actual wire format. When the `Status` message is
286 # exposed in different client libraries and different wire protocols, it can be
287 # mapped differently. For example, it will likely be mapped to some exceptions
288 # in Java, but more likely mapped to some error codes in C.
289 #
290 # # Other uses
291 #
292 # The error model and the `Status` message can be used in a variety of
293 # environments, either with or without APIs, to provide a
294 # consistent developer experience across different environments.
295 #
296 # Example uses of this error model include:
297 #
298 # - Partial errors. If a service needs to return partial errors to the client,
299 # it may embed the `Status` in the normal response to indicate the partial
300 # errors.
301 #
302 # - Workflow errors. A typical workflow has multiple steps. Each step may
303 # have a `Status` message for error reporting purpose.
304 #
305 # - Batch operations. If a client uses batch request and batch response, the
306 # `Status` message should be used directly inside batch response, one for
307 # each error sub-response.
308 #
309 # - Asynchronous operations. If an API call embeds asynchronous operation
310 # results in its response, the status of those operations should be
311 # represented directly using the `Status` message.
312 #
313 # - Logging. If some API errors are stored in logs, the message `Status` could
314 # be used directly after any stripping needed for security/privacy reasons.
315 "message": "A String", # A developer-facing error message, which should be in English. Any
316 # user-facing error message should be localized and sent in the
317 # google.rpc.Status.details field, or localized by the client.
318 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
319 "details": [ # A list of messages that carry the error details. There will be a
320 # common set of message types for APIs to use.
321 {
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700322 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700323 },
324 ],
325 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400326 "done": True or False, # If the value is `false`, it means the operation is still in progress.
327 # If true, the operation is completed, and either `error` or `response` is
328 # available.
329 "response": { # The normal response of the operation in case of success. If the original
330 # method returns no data on success, such as `Delete`, the response is
331 # `google.protobuf.Empty`. If the original method is standard
332 # `Get`/`Create`/`Update`, the response should be the resource. For other
333 # methods, the response should have the type `XxxResponse`, where `Xxx`
334 # is the original method name. For example, if the original method name
335 # is `TakeSnapshot()`, the inferred response type is
336 # `TakeSnapshotResponse`.
337 "a_key": "", # Properties of the object. Contains field @type with type URL.
338 },
339 "name": "A String", # The server-assigned name, which is only unique within the same service that
340 # originally returns it. If you use the default HTTP mapping, the
341 # `name` should have the format of `operations/some/unique/name`.
Thomas Coffee2f245372017-03-27 10:39:26 -0700342 "metadata": { # Service-specific metadata associated with the operation. It typically
343 # contains progress information and common metadata such as create time.
344 # Some services might not provide such metadata. Any method that returns a
345 # long-running operation should document the metadata type, if any.
346 "a_key": "", # Properties of the object. Contains field @type with type URL.
347 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700348 },
349 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700350 }</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>