Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / serviceusage_v1beta1.operations.html
blob: 14c4ccb0cc5ba4f5f2783ae7d3201427b049a3b9 [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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]81 <code><a href="#list">list(pageSize=None, pageToken=None, filter=None, name=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
106 # If `true`, the operation is completed, and either `error` or `response` is
107 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
109 # originally returns it. If you use the default HTTP mapping, the
110 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]111 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
112 # contains progress information and common metadata such as create time.
113 # Some services might not provide such metadata. Any method that returns a
114 # long-running operation should document the metadata type, if any.
115 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
116 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &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]118 # method returns no data on success, such as `Delete`, the response is
119 # `google.protobuf.Empty`. If the original method is standard
120 # `Get`/`Create`/`Update`, the response should be the resource. For other
121 # methods, the response should have the type `XxxResponse`, where `Xxx`
122 # is the original method name. For example, if the original method name
123 # is `TakeSnapshot()`, the inferred response type is
124 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125 &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]126 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]127 &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.
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 &quot;message&quot;: &quot;A String&quot;, # 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 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
138 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
139 # message types for APIs to use.
140 {
141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
142 },
143 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]144 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 }</pre>
146</div>
147
148<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]149 <code class="details" id="list">list(pageSize=None, pageToken=None, filter=None, name=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 pageSize: integer, The standard list page size.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 pageToken: string, The standard list page token.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]164 filter: string, The standard list filter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 name: string, The name of the operation&#x27;s parent resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170
171Returns:
172 An object of the form:
173
174 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 { # This resource represents a long-running operation that is the result of a
177 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
179 # If `true`, the operation is completed, and either `error` or `response` is
180 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
182 # originally returns it. If you use the default HTTP mapping, the
183 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]184 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
185 # contains progress information and common metadata such as create time.
186 # Some services might not provide such metadata. Any method that returns a
187 # long-running operation should document the metadata type, if any.
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 &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]191 # method returns no data on success, such as `Delete`, the response is
192 # `google.protobuf.Empty`. If the original method is standard
193 # `Get`/`Create`/`Update`, the response should be the resource. For other
194 # methods, the response should have the type `XxxResponse`, where `Xxx`
195 # is the original method name. For example, if the original method name
196 # is `TakeSnapshot()`, the inferred response type is
197 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &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]199 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]200 &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.
201 # different programming environments, including REST APIs and RPC APIs. It is
202 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
203 # three pieces of data: error code, error message, and error details.
204 #
205 # You can find out more about this error model and how to work with it in the
206 # [API Design Guide](https://cloud.google.com/apis/design/errors).
207 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
208 # user-facing error message should be localized and sent in the
209 # google.rpc.Status.details field, or localized by the client.
210 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
211 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
212 # message types for APIs to use.
213 {
214 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
215 },
216 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 },
219 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]220 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]233 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 page. Returns None if there are no more items in the collection.
235 </pre>
236</div>
237
238</body></html>