Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / redis_v1.projects.locations.operations.html
blob: 45dff55ae1b8ed8ab10ff0cc4cde5fe1449eb15b [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="redis_v1.html">Google Cloud Memorystore for Redis API</a> . <a href="redis_v1.projects.html">projects</a> . <a href="redis_v1.projects.locations.html">locations</a> . <a href="redis_v1.projects.locations.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
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">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
86<p class="toc_element">
87 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
88<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
95 <pre>Starts asynchronous cancellation on a long-running operation. The server
96makes a best effort to cancel the operation, but success is not
97guaranteed. If the server doesn't support this method, it returns
98`google.rpc.Code.UNIMPLEMENTED`. Clients can use
99Operations.GetOperation or
100other methods to check whether the cancellation succeeded or whether the
101operation completed despite cancellation. On successful cancellation,
102the operation is not deleted; instead, it becomes an operation with
103an Operation.error value with a google.rpc.Status.code of 1,
104corresponding to `Code.CANCELLED`.
105
106Args:
107 name: string, The name of the operation resource to be cancelled. (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # A generic empty message that you can re-use to avoid defining duplicated
117 # empty messages in your APIs. A typical example is to use it as the request
118 # or the response type of an API method. For instance:
119 #
120 # service Foo {
121 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
122 # }
123 #
124 # The JSON representation for `Empty` is empty JSON object `{}`.
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
130 <pre>Deletes a long-running operation. This method indicates that the client is
131no longer interested in the operation result. It does not cancel the
132operation. If the server doesn't support this method, it returns
133`google.rpc.Code.UNIMPLEMENTED`.
134
135Args:
136 name: string, The name of the operation resource to be deleted. (required)
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142Returns:
143 An object of the form:
144
145 { # A generic empty message that you can re-use to avoid defining duplicated
146 # empty messages in your APIs. A typical example is to use it as the request
147 # or the response type of an API method. For instance:
148 #
149 # service Foo {
150 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
151 # }
152 #
153 # The JSON representation for `Empty` is empty JSON object `{}`.
154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(name, x__xgafv=None)</code>
159 <pre>Gets the latest state of a long-running operation. Clients can use this
160method to poll the operation result at intervals as recommended by the API
161service.
162
163Args:
164 name: string, The name of the operation resource. (required)
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
173 { # This resource represents a long-running operation that is the result of a
174 # network API call.
175 "metadata": { # {
176 #
177 # `createTime`: The time the operation was created.
178 #
179 # `endTime`: The time the operation finished running.
180 #
181 # `target`: Server-defined resource path for the target of the operation.
182 #
183 # `verb`: Name of the verb executed by the operation.
184 #
185 # `statusDetail`: Human-readable status of the operation, if any.
186 #
187 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
188 #
189 # `apiVersion`: API version used to start the operation.
190 #
191 # }
192 "a_key": "", # Properties of the object. Contains field @type with type URL.
193 },
194 "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.
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.
198 #
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).
201 "message": "A String", # A developer-facing error message, which should be in English. Any
202 # user-facing error message should be localized and sent in the
203 # google.rpc.Status.details field, or localized by the client.
204 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
205 "details": [ # A list of messages that carry the error details. There is a common set of
206 # message types for APIs to use.
207 {
208 "a_key": "", # Properties of the object. Contains field @type with type URL.
209 },
210 ],
211 },
212 "done": True or False, # If the value is `false`, it means the operation is still in progress.
213 # If `true`, the operation is completed, and either `error` or `response` is
214 # available.
215 "response": { # The normal response of the operation in case of success. If the original
216 # method returns no data on success, such as `Delete`, the response is
217 # `google.protobuf.Empty`. If the original method is standard
218 # `Get`/`Create`/`Update`, the response should be the resource. For other
219 # methods, the response should have the type `XxxResponse`, where `Xxx`
220 # is the original method name. For example, if the original method name
221 # is `TakeSnapshot()`, the inferred response type is
222 # `TakeSnapshotResponse`.
223 "a_key": "", # Properties of the object. Contains field @type with type URL.
224 },
225 "name": "A String", # The server-assigned name, which is only unique within the same service that
226 # originally returns it. If you use the default HTTP mapping, the
227 # `name` should be a resource name ending with `operations/{unique_id}`.
228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
233 <pre>Lists operations that match the specified filter in the request. If the
234server doesn't support this method, it returns `UNIMPLEMENTED`.
235
236NOTE: the `name` binding allows API services to override the binding
237to use different resource name schemes, such as `users/*/operations`. To
238override the binding, API services can add a binding such as
239`"/v1/{name=users/*}/operations"` to their service configuration.
240For backwards compatibility, the default name includes the operations
241collection id, however overriding users must ensure the name binding
242is the parent resource, without the operations collection id.
243
244Args:
245 name: string, The name of the operation's parent resource. (required)
246 pageToken: string, The standard list page token.
247 x__xgafv: string, V1 error format.
248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
251 pageSize: integer, The standard list page size.
252 filter: string, The standard list filter.
253
254Returns:
255 An object of the form:
256
257 { # The response message for Operations.ListOperations.
258 "nextPageToken": "A String", # The standard List next-page token.
259 "operations": [ # A list of operations that matches the specified filter in the request.
260 { # This resource represents a long-running operation that is the result of a
261 # network API call.
262 "metadata": { # {
263 #
264 # `createTime`: The time the operation was created.
265 #
266 # `endTime`: The time the operation finished running.
267 #
268 # `target`: Server-defined resource path for the target of the operation.
269 #
270 # `verb`: Name of the verb executed by the operation.
271 #
272 # `statusDetail`: Human-readable status of the operation, if any.
273 #
274 # `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
275 #
276 # `apiVersion`: API version used to start the operation.
277 #
278 # }
279 "a_key": "", # Properties of the object. Contains field @type with type URL.
280 },
281 "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.
282 # different programming environments, including REST APIs and RPC APIs. It is
283 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
284 # three pieces of data: error code, error message, and error details.
285 #
286 # You can find out more about this error model and how to work with it in the
287 # [API Design Guide](https://cloud.google.com/apis/design/errors).
288 "message": "A String", # A developer-facing error message, which should be in English. Any
289 # user-facing error message should be localized and sent in the
290 # google.rpc.Status.details field, or localized by the client.
291 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
292 "details": [ # A list of messages that carry the error details. There is a common set of
293 # message types for APIs to use.
294 {
295 "a_key": "", # Properties of the object. Contains field @type with type URL.
296 },
297 ],
298 },
299 "done": True or False, # If the value is `false`, it means the operation is still in progress.
300 # If `true`, the operation is completed, and either `error` or `response` is
301 # available.
302 "response": { # The normal response of the operation in case of success. If the original
303 # method returns no data on success, such as `Delete`, the response is
304 # `google.protobuf.Empty`. If the original method is standard
305 # `Get`/`Create`/`Update`, the response should be the resource. For other
306 # methods, the response should have the type `XxxResponse`, where `Xxx`
307 # is the original method name. For example, if the original method name
308 # is `TakeSnapshot()`, the inferred response type is
309 # `TakeSnapshotResponse`.
310 "a_key": "", # Properties of the object. Contains field @type with type URL.
311 },
312 "name": "A String", # The server-assigned name, which is only unique within the same service that
313 # originally returns it. If you use the default HTTP mapping, the
314 # `name` should be a resource name ending with `operations/{unique_id}`.
315 },
316 ],
317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
322 <pre>Retrieves the next page of results.
323
324Args:
325 previous_request: The request for the previous page. (required)
326 previous_response: The response from the request for the previous page. (required)
327
328Returns:
329 A request object that you can call 'execute()' on to request the next
330 page. Returns None if there are no more items in the collection.
331 </pre>
332</div>
333
334</body></html>