Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / servicemanagement_v1.operations.html
blob: 0e222d062ef932703ee9aaee9e34c69257ce60b3 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -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="servicemanagement_v1.html">Google Service Management API</a> . <a href="servicemanagement_v1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]80<p class="toc_element">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]81 <code><a href="#list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists service operations that match the specified filter in the request.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(name, x__xgafv=None)</code>
89 <pre>Gets the latest state of a long-running operation. Clients can use this
90method to poll the operation result at intervals as recommended by the API
91service.
92
93Args:
94 name: string, The name of the operation resource. (required)
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100Returns:
101 An object of the form:
102
103 { # This resource represents a long-running operation that is the result of a
104 # network API call.
105 "metadata": { # Service-specific metadata associated with the operation. It typically
106 # contains progress information and common metadata such as create time.
107 # Some services might not provide such metadata. Any method that returns a
108 # long-running operation should document the metadata type, if any.
109 "a_key": "", # Properties of the object. Contains field @type with type URL.
110 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]111 "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 Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]112 # programming environments, including REST APIs and RPC APIs. It is used by
113 # [gRPC](https://github.com/grpc). The error model is designed to be:
114 #
115 # - Simple to use and understand for most users
116 # - Flexible enough to meet unexpected needs
117 #
118 # # Overview
119 #
120 # The `Status` message contains three pieces of data: error code, error message,
121 # and error details. The error code should be an enum value of
122 # google.rpc.Code, but it may accept additional error codes if needed. The
123 # error message should be a developer-facing English message that helps
124 # developers *understand* and *resolve* the error. If a localized user-facing
125 # error message is needed, put the localized message in the error details or
126 # localize it in the client. The optional error details may contain arbitrary
127 # information about the error. There is a predefined set of error detail types
128 # in the package `google.rpc` which can be used for common error conditions.
129 #
130 # # Language mapping
131 #
132 # The `Status` message is the logical representation of the error model, but it
133 # is not necessarily the actual wire format. When the `Status` message is
134 # exposed in different client libraries and different wire protocols, it can be
135 # mapped differently. For example, it will likely be mapped to some exceptions
136 # in Java, but more likely mapped to some error codes in C.
137 #
138 # # Other uses
139 #
140 # The error model and the `Status` message can be used in a variety of
141 # environments, either with or without APIs, to provide a
142 # consistent developer experience across different environments.
143 #
144 # Example uses of this error model include:
145 #
146 # - Partial errors. If a service needs to return partial errors to the client,
147 # it may embed the `Status` in the normal response to indicate the partial
148 # errors.
149 #
150 # - Workflow errors. A typical workflow has multiple steps. Each step may
151 # have a `Status` message for error reporting purpose.
152 #
153 # - Batch operations. If a client uses batch request and batch response, the
154 # `Status` message should be used directly inside batch response, one for
155 # each error sub-response.
156 #
157 # - Asynchronous operations. If an API call embeds asynchronous operation
158 # results in its response, the status of those operations should be
159 # represented directly using the `Status` message.
160 #
161 # - Logging. If some API errors are stored in logs, the message `Status` could
162 # be used directly after any stripping needed for security/privacy reasons.
163 "message": "A String", # A developer-facing error message, which should be in English. Any
164 # user-facing error message should be localized and sent in the
165 # google.rpc.Status.details field, or localized by the client.
166 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
167 "details": [ # A list of messages that carry the error details. There will be a
168 # common set of message types for APIs to use.
169 {
170 "a_key": "", # Properties of the object. Contains field @type with type URL.
171 },
172 ],
173 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]174 "done": True or False, # If the value is `false`, it means the operation is still in progress.
175 # If true, the operation is completed, and either `error` or `response` is
176 # available.
177 "response": { # The normal response of the operation in case of success. If the original
178 # method returns no data on success, such as `Delete`, the response is
179 # `google.protobuf.Empty`. If the original method is standard
180 # `Get`/`Create`/`Update`, the response should be the resource. For other
181 # methods, the response should have the type `XxxResponse`, where `Xxx`
182 # is the original method name. For example, if the original method name
183 # is `TakeSnapshot()`, the inferred response type is
184 # `TakeSnapshotResponse`.
185 "a_key": "", # Properties of the object. Contains field @type with type URL.
186 },
187 "name": "A String", # The server-assigned name, which is only unique within the same service that
188 # originally returns it. If you use the default HTTP mapping, the
189 # `name` should have the format of `operations/some/unique/name`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]190 }</pre>
191</div>
192
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]193<div class="method">
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]194 <code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
195 <pre>Lists service operations that match the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]196
197Args:
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]198 name: string, Not used.
199 pageSize: integer, The maximum number of operations to return. If unspecified, defaults to
20050. The maximum value is 100.
201 filter: string, A string for filtering Operations.
202 The following filter fields are supported&#58;
203
204 * serviceName&#58; Required. Only `=` operator is allowed.
205 * startTime&#58; The time this job was started, in ISO 8601 format.
206 Allowed operators are `>=`, `>`, `<=`, and `<`.
207 * status&#58; Can be `done`, `in_progress`, or `failed`. Allowed
208 operators are `=`, and `!=`.
209
210 Filter expression supports conjunction (AND) and disjunction (OR)
211 logical operators. However, the serviceName restriction must be at the
212 top-level and can only be combined with other restrictions via the AND
213 logical operator.
214
215 Examples&#58;
216
217 * `serviceName={some-service}.googleapis.com`
218 * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"`
219 * `serviceName={some-service}.googleapis.com AND status=done`
220 * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]221 pageToken: string, The standard list page token.
222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
230 { # The response message for Operations.ListOperations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]231 "operations": [ # A list of operations that matches the specified filter in the request.
232 { # This resource represents a long-running operation that is the result of a
233 # network API call.
234 "metadata": { # Service-specific metadata associated with the operation. It typically
235 # contains progress information and common metadata such as create time.
236 # Some services might not provide such metadata. Any method that returns a
237 # long-running operation should document the metadata type, if any.
238 "a_key": "", # Properties of the object. Contains field @type with type URL.
239 },
240 "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.
241 # programming environments, including REST APIs and RPC APIs. It is used by
242 # [gRPC](https://github.com/grpc). The error model is designed to be:
243 #
244 # - Simple to use and understand for most users
245 # - Flexible enough to meet unexpected needs
246 #
247 # # Overview
248 #
249 # The `Status` message contains three pieces of data: error code, error message,
250 # and error details. The error code should be an enum value of
251 # google.rpc.Code, but it may accept additional error codes if needed. The
252 # error message should be a developer-facing English message that helps
253 # developers *understand* and *resolve* the error. If a localized user-facing
254 # error message is needed, put the localized message in the error details or
255 # localize it in the client. The optional error details may contain arbitrary
256 # information about the error. There is a predefined set of error detail types
257 # in the package `google.rpc` which can be used for common error conditions.
258 #
259 # # Language mapping
260 #
261 # The `Status` message is the logical representation of the error model, but it
262 # is not necessarily the actual wire format. When the `Status` message is
263 # exposed in different client libraries and different wire protocols, it can be
264 # mapped differently. For example, it will likely be mapped to some exceptions
265 # in Java, but more likely mapped to some error codes in C.
266 #
267 # # Other uses
268 #
269 # The error model and the `Status` message can be used in a variety of
270 # environments, either with or without APIs, to provide a
271 # consistent developer experience across different environments.
272 #
273 # Example uses of this error model include:
274 #
275 # - Partial errors. If a service needs to return partial errors to the client,
276 # it may embed the `Status` in the normal response to indicate the partial
277 # errors.
278 #
279 # - Workflow errors. A typical workflow has multiple steps. Each step may
280 # have a `Status` message for error reporting purpose.
281 #
282 # - Batch operations. If a client uses batch request and batch response, the
283 # `Status` message should be used directly inside batch response, one for
284 # each error sub-response.
285 #
286 # - Asynchronous operations. If an API call embeds asynchronous operation
287 # results in its response, the status of those operations should be
288 # represented directly using the `Status` message.
289 #
290 # - Logging. If some API errors are stored in logs, the message `Status` could
291 # be used directly after any stripping needed for security/privacy reasons.
292 "message": "A String", # A developer-facing error message, which should be in English. Any
293 # user-facing error message should be localized and sent in the
294 # google.rpc.Status.details field, or localized by the client.
295 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
296 "details": [ # A list of messages that carry the error details. There will be a
297 # common set of message types for APIs to use.
298 {
299 "a_key": "", # Properties of the object. Contains field @type with type URL.
300 },
301 ],
302 },
303 "done": True or False, # If the value is `false`, it means the operation is still in progress.
304 # If true, the operation is completed, and either `error` or `response` is
305 # available.
306 "response": { # The normal response of the operation in case of success. If the original
307 # method returns no data on success, such as `Delete`, the response is
308 # `google.protobuf.Empty`. If the original method is standard
309 # `Get`/`Create`/`Update`, the response should be the resource. For other
310 # methods, the response should have the type `XxxResponse`, where `Xxx`
311 # is the original method name. For example, if the original method name
312 # is `TakeSnapshot()`, the inferred response type is
313 # `TakeSnapshotResponse`.
314 "a_key": "", # Properties of the object. Contains field @type with type URL.
315 },
316 "name": "A String", # The server-assigned name, which is only unique within the same service that
317 # originally returns it. If you use the default HTTP mapping, the
318 # `name` should have the format of `operations/some/unique/name`.
319 },
320 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]321 "nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]322 }</pre>
323</div>
324
325<div class="method">
326 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
327 <pre>Retrieves the next page of results.
328
329Args:
330 previous_request: The request for the previous page. (required)
331 previous_response: The response from the request for the previous page. (required)
332
333Returns:
334 A request object that you can call 'execute()' on to request the next
335 page. Returns None if there are no more items in the collection.
336 </pre>
337</div>
338
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]339</body></html>