Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / serviceusage_v1beta1.operations.html
blob: bba2ca8e4a918207ce27678279be537e17a4c0fd [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="serviceusage_v1beta1.html">Service Usage API</a> . <a href="serviceusage_v1beta1.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>
80<p class="toc_element">
81 <code><a href="#list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
82<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
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>
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 "response": { # The normal response of the operation in case of success. If the original
106 # method returns no data on success, such as `Delete`, the response is
107 # `google.protobuf.Empty`. If the original method is standard
108 # `Get`/`Create`/`Update`, the response should be the resource. For other
109 # methods, the response should have the type `XxxResponse`, where `Xxx`
110 # is the original method name. For example, if the original method name
111 # is `TakeSnapshot()`, the inferred response type is
112 # `TakeSnapshotResponse`.
113 "a_key": "", # Properties of the object. Contains field @type with type URL.
114 },
115 "metadata": { # Service-specific metadata associated with the operation. It typically
116 # contains progress information and common metadata such as create time.
117 # Some services might not provide such metadata. Any method that returns a
118 # long-running operation should document the metadata type, if any.
119 "a_key": "", # Properties of the object. Contains field @type with type URL.
120 },
121 "done": True or False, # If the value is `false`, it means the operation is still in progress.
122 # If `true`, the operation is completed, and either `error` or `response` is
123 # available.
124 "name": "A String", # The server-assigned name, which is only unique within the same service that
125 # originally returns it. If you use the default HTTP mapping, the
126 # `name` should be a resource name ending with `operations/{unique_id}`.
127 "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.
128 # different programming environments, including REST APIs and RPC APIs. It is
129 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
130 # three pieces of data: error code, error message, and error details.
131 #
132 # You can find out more about this error model and how to work with it in the
133 # [API Design Guide](https://cloud.google.com/apis/design/errors).
134 "message": "A String", # A developer-facing error message, which should be in English. Any
135 # user-facing error message should be localized and sent in the
136 # google.rpc.Status.details field, or localized by the client.
137 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
138 "details": [ # A list of messages that carry the error details. There is a common set of
139 # message types for APIs to use.
140 {
141 "a_key": "", # Properties of the object. Contains field @type with type URL.
142 },
143 ],
144 },
145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
150 <pre>Lists operations that match the specified filter in the request. If the
151server doesn't support this method, it returns `UNIMPLEMENTED`.
152
153NOTE: the `name` binding allows API services to override the binding
154to use different resource name schemes, such as `users/*/operations`. To
155override the binding, API services can add a binding such as
156`"/v1/{name=users/*}/operations"` to their service configuration.
157For backwards compatibility, the default name includes the operations
158collection id, however overriding users must ensure the name binding
159is the parent resource, without the operations collection id.
160
161Args:
162 name: string, The name of the operation's parent resource.
163 pageToken: string, The standard list page token.
164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
168 pageSize: integer, The standard list page size.
169 filter: string, The standard list filter.
170
171Returns:
172 An object of the form:
173
174 { # The response message for Operations.ListOperations.
175 "nextPageToken": "A String", # The standard List next-page token.
176 "operations": [ # A list of operations that matches the specified filter in the request.
177 { # This resource represents a long-running operation that is the result of a
178 # network API call.
179 "response": { # The normal response of the operation in case of success. If the original
180 # method returns no data on success, such as `Delete`, the response is
181 # `google.protobuf.Empty`. If the original method is standard
182 # `Get`/`Create`/`Update`, the response should be the resource. For other
183 # methods, the response should have the type `XxxResponse`, where `Xxx`
184 # is the original method name. For example, if the original method name
185 # is `TakeSnapshot()`, the inferred response type is
186 # `TakeSnapshotResponse`.
187 "a_key": "", # Properties of the object. Contains field @type with type URL.
188 },
189 "metadata": { # Service-specific metadata associated with the operation. It typically
190 # contains progress information and common metadata such as create time.
191 # Some services might not provide such metadata. Any method that returns a
192 # long-running operation should document the metadata type, if any.
193 "a_key": "", # Properties of the object. Contains field @type with type URL.
194 },
195 "done": True or False, # If the value is `false`, it means the operation is still in progress.
196 # If `true`, the operation is completed, and either `error` or `response` is
197 # available.
198 "name": "A String", # The server-assigned name, which is only unique within the same service that
199 # originally returns it. If you use the default HTTP mapping, the
200 # `name` should be a resource name ending with `operations/{unique_id}`.
201 "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.
202 # different programming environments, including REST APIs and RPC APIs. It is
203 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
204 # three pieces of data: error code, error message, and error details.
205 #
206 # You can find out more about this error model and how to work with it in the
207 # [API Design Guide](https://cloud.google.com/apis/design/errors).
208 "message": "A String", # A developer-facing error message, which should be in English. Any
209 # user-facing error message should be localized and sent in the
210 # google.rpc.Status.details field, or localized by the client.
211 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
212 "details": [ # A list of messages that carry the error details. There is a common set of
213 # message types for APIs to use.
214 {
215 "a_key": "", # Properties of the object. Contains field @type with type URL.
216 },
217 ],
218 },
219 },
220 ],
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
226 <pre>Retrieves the next page of results.
227
228Args:
229 previous_request: The request for the previous page. (required)
230 previous_response: The response from the request for the previous page. (required)
231
232Returns:
233 A request object that you can call 'execute()' on to request the next
234 page. Returns None if there are no more items in the collection.
235 </pre>
236</div>
237
238</body></html>