Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / composer_v1beta1.projects.locations.operations.html
blob: d4e21e6f1e4a75d6bac1e37aa7f0721ccdd0d38c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="composer_v1beta1.html">Cloud Composer API</a> . <a href="composer_v1beta1.projects.html">projects</a> . <a href="composer_v1beta1.projects.locations.html">locations</a> . <a href="composer_v1beta1.projects.locations.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
80<p class="toc_element">
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, pageToken=None, x__xgafv=None, pageSize=None, filter=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">
91 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
92 <pre>Deletes a long-running operation. This method indicates that the client is
93no longer interested in the operation result. It does not cancel the
94operation. If the server doesn't support this method, it returns
95`google.rpc.Code.UNIMPLEMENTED`.
96
97Args:
98 name: string, The name of the operation resource to be deleted. (required)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # A generic empty message that you can re-use to avoid defining duplicated
108 # empty messages in your APIs. A typical example is to use it as the request
109 # or the response type of an API method. For instance:
110 #
111 # service Foo {
112 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
113 # }
114 #
115 # The JSON representation for `Empty` is empty JSON object `{}`.
116 }</pre>
117</div>
118
119<div class="method">
120 <code class="details" id="get">get(name, x__xgafv=None)</code>
121 <pre>Gets the latest state of a long-running operation. Clients can use this
122method to poll the operation result at intervals as recommended by the API
123service.
124
125Args:
126 name: string, The name of the operation resource. (required)
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # This resource represents a long-running operation that is the result of a
136 # network API call.
137 "metadata": { # Service-specific metadata associated with the operation. It typically
138 # contains progress information and common metadata such as create time.
139 # Some services might not provide such metadata. Any method that returns a
140 # long-running operation should document the metadata type, if any.
141 "a_key": "", # Properties of the object. Contains field @type with type URL.
142 },
143 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
144 # different programming environments, including REST APIs and RPC APIs. It is
145 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
146 #
147 # - Simple to use and understand for most users
148 # - Flexible enough to meet unexpected needs
149 #
150 # # Overview
151 #
152 # The `Status` message contains three pieces of data: error code, error
153 # message, and error details. The error code should be an enum value of
154 # google.rpc.Code, but it may accept additional error codes if needed. The
155 # error message should be a developer-facing English message that helps
156 # developers *understand* and *resolve* the error. If a localized user-facing
157 # error message is needed, put the localized message in the error details or
158 # localize it in the client. The optional error details may contain arbitrary
159 # information about the error. There is a predefined set of error detail types
160 # in the package `google.rpc` that can be used for common error conditions.
161 #
162 # # Language mapping
163 #
164 # The `Status` message is the logical representation of the error model, but it
165 # is not necessarily the actual wire format. When the `Status` message is
166 # exposed in different client libraries and different wire protocols, it can be
167 # mapped differently. For example, it will likely be mapped to some exceptions
168 # in Java, but more likely mapped to some error codes in C.
169 #
170 # # Other uses
171 #
172 # The error model and the `Status` message can be used in a variety of
173 # environments, either with or without APIs, to provide a
174 # consistent developer experience across different environments.
175 #
176 # Example uses of this error model include:
177 #
178 # - Partial errors. If a service needs to return partial errors to the client,
179 # it may embed the `Status` in the normal response to indicate the partial
180 # errors.
181 #
182 # - Workflow errors. A typical workflow has multiple steps. Each step may
183 # have a `Status` message for error reporting.
184 #
185 # - Batch operations. If a client uses batch request and batch response, the
186 # `Status` message should be used directly inside batch response, one for
187 # each error sub-response.
188 #
189 # - Asynchronous operations. If an API call embeds asynchronous operation
190 # results in its response, the status of those operations should be
191 # represented directly using the `Status` message.
192 #
193 # - Logging. If some API errors are stored in logs, the message `Status` could
194 # be used directly after any stripping needed for security/privacy reasons.
195 "message": "A String", # A developer-facing error message, which should be in English. Any
196 # user-facing error message should be localized and sent in the
197 # google.rpc.Status.details field, or localized by the client.
198 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
199 "details": [ # A list of messages that carry the error details. There is a common set of
200 # message types for APIs to use.
201 {
202 "a_key": "", # Properties of the object. Contains field @type with type URL.
203 },
204 ],
205 },
206 "done": True or False, # If the value is `false`, it means the operation is still in progress.
207 # If `true`, the operation is completed, and either `error` or `response` is
208 # available.
209 "response": { # The normal response of the operation in case of success. If the original
210 # method returns no data on success, such as `Delete`, the response is
211 # `google.protobuf.Empty`. If the original method is standard
212 # `Get`/`Create`/`Update`, the response should be the resource. For other
213 # methods, the response should have the type `XxxResponse`, where `Xxx`
214 # is the original method name. For example, if the original method name
215 # is `TakeSnapshot()`, the inferred response type is
216 # `TakeSnapshotResponse`.
217 "a_key": "", # Properties of the object. Contains field @type with type URL.
218 },
219 "name": "A String", # The server-assigned name, which is only unique within the same service that
220 # originally returns it. If you use the default HTTP mapping, the
221 # `name` should be a resource name ending with `operations/{unique_id}`.
222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
227 <pre>Lists operations that match the specified filter in the request. If the
228server doesn't support this method, it returns `UNIMPLEMENTED`.
229
230NOTE: the `name` binding allows API services to override the binding
231to use different resource name schemes, such as `users/*/operations`. To
232override the binding, API services can add a binding such as
233`"/v1/{name=users/*}/operations"` to their service configuration.
234For backwards compatibility, the default name includes the operations
235collection id, however overriding users must ensure the name binding
236is the parent resource, without the operations collection id.
237
238Args:
239 name: string, The name of the operation's parent resource. (required)
240 pageToken: string, The standard list page token.
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245 pageSize: integer, The standard list page size.
246 filter: string, The standard list filter.
247
248Returns:
249 An object of the form:
250
251 { # The response message for Operations.ListOperations.
252 "nextPageToken": "A String", # The standard List next-page token.
253 "operations": [ # A list of operations that matches the specified filter in the request.
254 { # This resource represents a long-running operation that is the result of a
255 # network API call.
256 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL.
261 },
262 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
263 # different programming environments, including REST APIs and RPC APIs. It is
264 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
265 #
266 # - Simple to use and understand for most users
267 # - Flexible enough to meet unexpected needs
268 #
269 # # Overview
270 #
271 # The `Status` message contains three pieces of data: error code, error
272 # message, and error details. The error code should be an enum value of
273 # google.rpc.Code, but it may accept additional error codes if needed. The
274 # error message should be a developer-facing English message that helps
275 # developers *understand* and *resolve* the error. If a localized user-facing
276 # error message is needed, put the localized message in the error details or
277 # localize it in the client. The optional error details may contain arbitrary
278 # information about the error. There is a predefined set of error detail types
279 # in the package `google.rpc` that can be used for common error conditions.
280 #
281 # # Language mapping
282 #
283 # The `Status` message is the logical representation of the error model, but it
284 # is not necessarily the actual wire format. When the `Status` message is
285 # exposed in different client libraries and different wire protocols, it can be
286 # mapped differently. For example, it will likely be mapped to some exceptions
287 # in Java, but more likely mapped to some error codes in C.
288 #
289 # # Other uses
290 #
291 # The error model and the `Status` message can be used in a variety of
292 # environments, either with or without APIs, to provide a
293 # consistent developer experience across different environments.
294 #
295 # Example uses of this error model include:
296 #
297 # - Partial errors. If a service needs to return partial errors to the client,
298 # it may embed the `Status` in the normal response to indicate the partial
299 # errors.
300 #
301 # - Workflow errors. A typical workflow has multiple steps. Each step may
302 # have a `Status` message for error reporting.
303 #
304 # - Batch operations. If a client uses batch request and batch response, the
305 # `Status` message should be used directly inside batch response, one for
306 # each error sub-response.
307 #
308 # - Asynchronous operations. If an API call embeds asynchronous operation
309 # results in its response, the status of those operations should be
310 # represented directly using the `Status` message.
311 #
312 # - Logging. If some API errors are stored in logs, the message `Status` could
313 # be used directly after any stripping needed for security/privacy reasons.
314 "message": "A String", # A developer-facing error message, which should be in English. Any
315 # user-facing error message should be localized and sent in the
316 # google.rpc.Status.details field, or localized by the client.
317 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
318 "details": [ # A list of messages that carry the error details. There is a common set of
319 # message types for APIs to use.
320 {
321 "a_key": "", # Properties of the object. Contains field @type with type URL.
322 },
323 ],
324 },
325 "done": True or False, # If the value is `false`, it means the operation is still in progress.
326 # If `true`, the operation is completed, and either `error` or `response` is
327 # available.
328 "response": { # The normal response of the operation in case of success. If the original
329 # method returns no data on success, such as `Delete`, the response is
330 # `google.protobuf.Empty`. If the original method is standard
331 # `Get`/`Create`/`Update`, the response should be the resource. For other
332 # methods, the response should have the type `XxxResponse`, where `Xxx`
333 # is the original method name. For example, if the original method name
334 # is `TakeSnapshot()`, the inferred response type is
335 # `TakeSnapshotResponse`.
336 "a_key": "", # Properties of the object. Contains field @type with type URL.
337 },
338 "name": "A String", # The server-assigned name, which is only unique within the same service that
339 # originally returns it. If you use the default HTTP mapping, the
340 # `name` should be a resource name ending with `operations/{unique_id}`.
341 },
342 ],
343 }</pre>
344</div>
345
346<div class="method">
347 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
348 <pre>Retrieves the next page of results.
349
350Args:
351 previous_request: The request for the previous page. (required)
352 previous_response: The response from the request for the previous page. (required)
353
354Returns:
355 A request object that you can call 'execute()' on to request the next
356 page. Returns None if there are no more items in the collection.
357 </pre>
358</div>
359
360</body></html>