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