Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / cloudfunctions_v1.operations.html
blob: 7a915720688a138bea5779cdbe52b88b627696c9 [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="cloudfunctions_v1.html">Cloud Functions API</a> . <a href="cloudfunctions_v1.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 "metadata": { # Service-specific metadata associated with the operation. It typically
106 # contains progress information and common metadata such as create time.
107 # Some services might not provide such metadata. Any method that returns a
108 # long-running operation should document the metadata type, if any.
109 "a_key": "", # Properties of the object. Contains field @type with type URL.
110 },
111 "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.
112 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
114 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]116 # You can find out more about this error model and how to work with it in the
117 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 "message": "A String", # A developer-facing error message, which should be in English. Any
119 # user-facing error message should be localized and sent in the
120 # google.rpc.Status.details field, or localized by the client.
121 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
122 "details": [ # A list of messages that carry the error details. There is a common set of
123 # message types for APIs to use.
124 {
125 "a_key": "", # Properties of the object. Contains field @type with type URL.
126 },
127 ],
128 },
129 "done": True or False, # If the value is `false`, it means the operation is still in progress.
130 # If `true`, the operation is completed, and either `error` or `response` is
131 # available.
132 "response": { # The normal response of the operation in case of success. If the original
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`.
140 "a_key": "", # Properties of the object. Contains field @type with type URL.
141 },
142 "name": "A String", # 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}`.
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, Must not be set.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]163 pageToken: string, Token identifying which result to start with, which is returned by a previous list call.&lt;br&gt;&lt;br&gt; Pagination is only supported when querying for a specific function.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 x__xgafv: string, V1 error format.
165 Allowed values
166 1 - v1 error format
167 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]168 pageSize: integer, The maximum number of records that should be returned.&lt;br&gt; Requested page size cannot exceed 100. If not set, the default page size is 100.&lt;br&gt;&lt;br&gt; Pagination is only supported when querying for a specific function.
169 filter: string, Required. A filter for matching the requested operations.&lt;br&gt;&lt;br&gt; The supported formats of &lt;b&gt;filter&lt;/b&gt; are:&lt;br&gt; To query for a specific function: &lt;code&gt;project:*,location:*,function:*&lt;/code&gt;&lt;br&gt; To query for all of the latest operations for a project: &lt;code&gt;project:*,latest:true&lt;/code&gt;
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.
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 "metadata": { # Service-specific metadata associated with the operation. It typically
180 # contains progress information and common metadata such as create time.
181 # Some services might not provide such metadata. Any method that returns a
182 # long-running operation should document the metadata type, if any.
183 "a_key": "", # Properties of the object. Contains field @type with type URL.
184 },
185 "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.
186 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]187 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
188 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]190 # You can find out more about this error model and how to work with it in the
191 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "message": "A String", # A developer-facing error message, which should be in English. Any
193 # user-facing error message should be localized and sent in the
194 # google.rpc.Status.details field, or localized by the client.
195 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
196 "details": [ # A list of messages that carry the error details. There is a common set of
197 # message types for APIs to use.
198 {
199 "a_key": "", # Properties of the object. Contains field @type with type URL.
200 },
201 ],
202 },
203 "done": True or False, # If the value is `false`, it means the operation is still in progress.
204 # If `true`, the operation is completed, and either `error` or `response` is
205 # available.
206 "response": { # The normal response of the operation in case of success. If the original
207 # method returns no data on success, such as `Delete`, the response is
208 # `google.protobuf.Empty`. If the original method is standard
209 # `Get`/`Create`/`Update`, the response should be the resource. For other
210 # methods, the response should have the type `XxxResponse`, where `Xxx`
211 # is the original method name. For example, if the original method name
212 # is `TakeSnapshot()`, the inferred response type is
213 # `TakeSnapshotResponse`.
214 "a_key": "", # Properties of the object. Contains field @type with type URL.
215 },
216 "name": "A String", # The server-assigned name, which is only unique within the same service that
217 # originally returns it. If you use the default HTTP mapping, the
218 # `name` should be a resource name ending with `operations/{unique_id}`.
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>