Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 673ec5cf1a654055c85c0d426b27d270a8ade262 / . / docs / dyn / appengine_v1alpha.apps.operations.html
blob: f9a49ee88563b1082eb62b35749d6385c3c08061 [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="appengine_v1alpha.html">App Engine Admin API</a> . <a href="appengine_v1alpha.apps.html">apps</a> . <a href="appengine_v1alpha.apps.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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]81 <code><a href="#get">get(appsId, operationsId, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
83<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]84 <code><a href="#list">list(appsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]85<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96 <code class="details" id="get">get(appsId, operationsId, x__xgafv=None)</code>
97 <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
98
99Args:
100 appsId: string, Part of `name`. The name of the operation resource. (required)
101 operationsId: string, Part of `name`. See documentation of `appsId`. (required)
102 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106
107Returns:
108 An object of the form:
109
110 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]111 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
112 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
113 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 &quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]115 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]118 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 },
121 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
123 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]124 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]125 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
126 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
127 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128 }</pre>
129</div>
130
131<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]132 <code class="details" id="list">list(appsId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 <pre>Lists operations that match the specified filter in the request. If the server doesn&#x27;t support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as &quot;/v1/{name=users/*}/operations&quot; to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]134
135Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 appsId: string, Part of `name`. The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]137 filter: string, The standard list filter.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 pageSize: integer, The standard list page size.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]139 pageToken: string, The standard list page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140 x__xgafv: string, V1 error format.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]144
145Returns:
146 An object of the form:
147
148 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &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]150 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
152 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
153 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 &quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]155 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]156 &quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]158 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]160 },
161 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
163 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]164 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame^]165 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
167 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]168 },
169 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]170 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 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]184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
188</body></html>