Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / runtimeconfig_v1.operations.html
blob: 0c12080f0e2711c405f73f29ce0a1ccbfcae5b1c [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -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="runtimeconfig_v1.html">Cloud Runtime Configuration API</a> . <a href="runtimeconfig_v1.operations.html">operations</a></h1>
Sai Cheemalapatidf613972016-10-21 13:59:49 -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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -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>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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">
132 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
133 <pre>Deletes a long-running operation. This method indicates that the client is
134no longer interested in the operation result. It does not cancel the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135operation. If the server doesn&#x27;t support this method, it returns
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]136`google.rpc.Code.UNIMPLEMENTED`.
137
138Args:
139 name: string, The name of the operation resource to be deleted. (required)
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # A generic empty message that you can re-use to avoid defining duplicated
149 # empty messages in your APIs. A typical example is to use it as the request
150 # or the response type of an API method. For instance:
151 #
152 # service Foo {
153 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
154 # }
155 #
156 # The JSON representation for `Empty` is empty JSON object `{}`.
157 }</pre>
158</div>
159
160<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]162 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]164
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]165NOTE: the `name` binding allows API services to override the binding
166to use different resource name schemes, such as `users/*/operations`. To
167override the binding, API services can add a binding such as
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]169For backwards compatibility, the default name includes the operations
170collection id, however overriding users must ensure the name binding
171is the parent resource, without the operations collection id.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]172
173Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 name: string, The name of the operation&#x27;s parent resource. (required)
175 filter: string, The standard list filter.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]176 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 pageSize: integer, The standard list page size.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183Returns:
184 An object of the form:
185
186 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
188 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]189 { # This resource represents a long-running operation that is the result of a
190 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
192 # originally returns it. If you use the default HTTP mapping, the
193 # `name` should be a resource name ending with `operations/{unique_id}`.
194 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 # different programming environments, including REST APIs and RPC APIs. It is
196 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
197 # three pieces of data: error code, error message, and error details.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]198 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 # You can find out more about this error model and how to work with it in the
200 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
202 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]203 # user-facing error message should be localized and sent in the
204 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 # message types for APIs to use.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]207 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]208 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]209 },
210 ],
211 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]212 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
213 # contains progress information and common metadata such as create time.
214 # Some services might not provide such metadata. Any method that returns a
215 # long-running operation should document the metadata type, if any.
216 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
217 },
218 &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]219 # If `true`, the operation is completed, and either `error` or `response` is
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]220 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]221 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]222 # method returns no data on success, such as `Delete`, the response is
223 # `google.protobuf.Empty`. If the original method is standard
224 # `Get`/`Create`/`Update`, the response should be the resource. For other
225 # methods, the response should have the type `XxxResponse`, where `Xxx`
226 # is the original method name. For example, if the original method name
227 # is `TakeSnapshot()`, the inferred response type is
228 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]230 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]231 },
232 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]233 }</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
238 <pre>Retrieves the next page of results.
239
240Args:
241 previous_request: The request for the previous page. (required)
242 previous_response: The response from the request for the previous page. (required)
243
244Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]246 page. Returns None if there are no more items in the collection.
247 </pre>
248</div>
249
250</body></html>