Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / cloudbuild_v1.operations.html
blob: 2d2058c8757a8ad2d6848cd2bd5a9f25100ea3a2 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="cloudbuild_v1.html">Cloud Build API</a> . <a href="cloudbuild_v1.operations.html">operations</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]84 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]92 <pre>Starts asynchronous cancellation on a long-running operation. The server
93makes a best effort to cancel the operation, but success is not
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]94guaranteed. If the server doesn&#x27;t support this method, it returns
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 body: object, The request body.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]149 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 # If `true`, the operation is completed, and either `error` or `response` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]152 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 # method returns no data on success, such as `Delete`, the response is
154 # `google.protobuf.Empty`. If the original method is standard
155 # `Get`/`Create`/`Update`, the response should be the resource. For other
156 # methods, the response should have the type `XxxResponse`, where `Xxx`
157 # is the original method name. For example, if the original method name
158 # is `TakeSnapshot()`, the inferred response type is
159 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]161 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]162 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]163 # originally returns it. If you use the default HTTP mapping, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]165 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
166 # different programming environments, including REST APIs and RPC APIs. It is
167 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
168 # three pieces of data: error code, error message, and error details.
169 #
170 # You can find out more about this error model and how to work with it in the
171 # [API Design Guide](https://cloud.google.com/apis/design/errors).
172 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
173 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
174 # user-facing error message should be localized and sent in the
175 # google.rpc.Status.details field, or localized by the client.
176 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
177 # message types for APIs to use.
178 {
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 ],
182 },
183 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
184 # contains progress information and common metadata such as create time.
185 # Some services might not provide such metadata. Any method that returns a
186 # long-running operation should document the metadata type, if any.
187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]189 }</pre>
190</div>
191
192<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]193 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]194 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]195server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]196
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]197NOTE: the `name` binding allows API services to override the binding
198to use different resource name schemes, such as `users/*/operations`. To
199override the binding, API services can add a binding such as
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]200`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]201For backwards compatibility, the default name includes the operations
202collection id, however overriding users must ensure the name binding
203is the parent resource, without the operations collection id.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]204
205Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]206 name: string, The name of the operation&#x27;s parent resource. (required)
207 pageSize: integer, The standard list page size.
208 filter: string, The standard list filter.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]209 pageToken: string, The standard list page token.
210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215Returns:
216 An object of the form:
217
218 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]219 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]220 { # This resource represents a long-running operation that is the result of a
221 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]222 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 # If `true`, the operation is completed, and either `error` or `response` is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]224 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]225 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]226 # method returns no data on success, such as `Delete`, the response is
227 # `google.protobuf.Empty`. If the original method is standard
228 # `Get`/`Create`/`Update`, the response should be the resource. For other
229 # methods, the response should have the type `XxxResponse`, where `Xxx`
230 # is the original method name. For example, if the original method name
231 # is `TakeSnapshot()`, the inferred response type is
232 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]233 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]234 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]235 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]236 # originally returns it. If you use the default HTTP mapping, the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]238 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
239 # different programming environments, including REST APIs and RPC APIs. It is
240 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
241 # three pieces of data: error code, error message, and error details.
242 #
243 # You can find out more about this error model and how to work with it in the
244 # [API Design Guide](https://cloud.google.com/apis/design/errors).
245 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
246 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
247 # user-facing error message should be localized and sent in the
248 # google.rpc.Status.details field, or localized by the client.
249 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
250 # message types for APIs to use.
251 {
252 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
253 },
254 ],
255 },
256 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
257 # contains progress information and common metadata such as create time.
258 # Some services might not provide such metadata. Any method that returns a
259 # long-running operation should document the metadata type, if any.
260 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
261 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]262 },
263 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]264 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
270 <pre>Retrieves the next page of results.
271
272Args:
273 previous_request: The request for the previous page. (required)
274 previous_response: The response from the request for the previous page. (required)
275
276Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]277 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]278 page. Returns None if there are no more items in the collection.
279 </pre>
280</div>
281
282</body></html>