Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / servicemanagement_v1.operations.html
blob: 64fea41629f1b0cc84a749c3b3601930d82d079f [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="servicemanagement_v1.html">Service Management API</a> . <a href="servicemanagement_v1.operations.html">operations</a></h1>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]105 &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.
106 # different programming environments, including REST APIs and RPC APIs. It is
107 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
108 # three pieces of data: error code, error message, and error details.
109 #
110 # You can find out more about this error model and how to work with it in the
111 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]112 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
113 # message types for APIs to use.
114 {
115 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
116 },
117 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]118 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
119 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
120 # user-facing error message should be localized and sent in the
121 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]122 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]124 # contains progress information and common metadata such as create time.
125 # Some services might not provide such metadata. Any method that returns a
126 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]127 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]128 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]130 # If `true`, the operation is completed, and either `error` or `response` is
131 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]133 # method returns no data on success, such as `Delete`, the response is
134 # `google.protobuf.Empty`. If the original method is standard
135 # `Get`/`Create`/`Update`, the response should be the resource. For other
136 # methods, the response should have the type `XxxResponse`, where `Xxx`
137 # is the original method name. For example, if the original method name
138 # is `TakeSnapshot()`, the inferred response type is
139 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]141 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
143 # originally returns it. If you use the default HTTP mapping, the
144 # `name` should be a resource name ending with `operations/{unique_id}`.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]145 }</pre>
146</div>
147
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]148<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]149 <code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]150 <pre>Lists service operations that match the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]151
152Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]153 name: string, Not used.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]154 pageSize: integer, The maximum number of operations to return. If unspecified, defaults to
15550. The maximum value is 100.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]156 filter: string, A string for filtering Operations.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]157 The following filter fields are supported&amp;#58;
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]158
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]159 * serviceName&amp;#58; Required. Only `=` operator is allowed.
160 * startTime&amp;#58; The time this job was started, in ISO 8601 format.
161 Allowed operators are `&gt;=`, `&gt;`, `&lt;=`, and `&lt;`.
162 * status&amp;#58; Can be `done`, `in_progress`, or `failed`. Allowed
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]163 operators are `=`, and `!=`.
164
165 Filter expression supports conjunction (AND) and disjunction (OR)
166 logical operators. However, the serviceName restriction must be at the
167 top-level and can only be combined with other restrictions via the AND
168 logical operator.
169
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]170 Examples&amp;#58;
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]171
172 * `serviceName={some-service}.googleapis.com`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 * `serviceName={some-service}.googleapis.com AND startTime&gt;=&quot;2017-02-01&quot;`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]174 * `serviceName={some-service}.googleapis.com AND status=done`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 * `serviceName={some-service}.googleapis.com AND (status=done OR startTime&gt;=&quot;2017-02-01&quot;)`
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]176 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]181
182Returns:
183 An object of the form:
184
185 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]186 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187 { # This resource represents a long-running operation that is the result of a
188 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]189 &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.
190 # different programming environments, including REST APIs and RPC APIs. It is
191 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
192 # three pieces of data: error code, error message, and error details.
193 #
194 # You can find out more about this error model and how to work with it in the
195 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]196 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
197 # message types for APIs to use.
198 {
199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
201 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]202 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
203 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
204 # user-facing error message should be localized and sent in the
205 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]206 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]208 # contains progress information and common metadata such as create time.
209 # Some services might not provide such metadata. Any method that returns a
210 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]212 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]213 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]214 # If `true`, the operation is completed, and either `error` or `response` is
215 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217 # method returns no data on success, such as `Delete`, the response is
218 # `google.protobuf.Empty`. If the original method is standard
219 # `Get`/`Create`/`Update`, the response should be the resource. For other
220 # methods, the response should have the type `XxxResponse`, where `Xxx`
221 # is the original method name. For example, if the original method name
222 # is `TakeSnapshot()`, the inferred response type is
223 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]225 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]226 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
227 # originally returns it. If you use the default HTTP mapping, the
228 # `name` should be a resource name ending with `operations/{unique_id}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]229 },
230 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
237 <pre>Retrieves the next page of results.
238
239Args:
240 previous_request: The request for the previous page. (required)
241 previous_response: The response from the request for the previous page. (required)
242
243Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]244 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]249</body></html>