Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / composer_v1beta1.projects.locations.operations.html
blob: fbd300a7836737815b12ae18fbd04314278d4480 [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="composer_v1beta1.html">Cloud Composer API</a> . <a href="composer_v1beta1.projects.html">projects</a> . <a href="composer_v1beta1.projects.locations.html">locations</a> . <a href="composer_v1beta1.projects.locations.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
83<p class="toc_element">
84 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
85<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
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">
91 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
92 <pre>Deletes a long-running operation. This method indicates that the client is
93no longer interested in the operation result. It does not cancel the
94operation. If the server doesn't support this method, it returns
95`google.rpc.Code.UNIMPLEMENTED`.
96
97Args:
98 name: string, The name of the operation resource to be deleted. (required)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # A generic empty message that you can re-use to avoid defining duplicated
108 # empty messages in your APIs. A typical example is to use it as the request
109 # or the response type of an API method. For instance:
110 #
111 # service Foo {
112 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
113 # }
114 #
115 # The JSON representation for `Empty` is empty JSON object `{}`.
116 }</pre>
117</div>
118
119<div class="method">
120 <code class="details" id="get">get(name, x__xgafv=None)</code>
121 <pre>Gets the latest state of a long-running operation. Clients can use this
122method to poll the operation result at intervals as recommended by the API
123service.
124
125Args:
126 name: string, The name of the operation resource. (required)
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # This resource represents a long-running operation that is the result of a
136 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 "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.
138 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
140 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]142 # You can find out more about this error model and how to work with it in the
143 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "message": "A String", # A developer-facing error message, which should be in English. Any
145 # user-facing error message should be localized and sent in the
146 # google.rpc.Status.details field, or localized by the client.
147 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
148 "details": [ # A list of messages that carry the error details. There is a common set of
149 # message types for APIs to use.
150 {
151 "a_key": "", # Properties of the object. Contains field @type with type URL.
152 },
153 ],
154 },
155 "done": True or False, # If the value is `false`, it means the operation is still in progress.
156 # If `true`, the operation is completed, and either `error` or `response` is
157 # available.
158 "response": { # The normal response of the operation in case of success. If the original
159 # method returns no data on success, such as `Delete`, the response is
160 # `google.protobuf.Empty`. If the original method is standard
161 # `Get`/`Create`/`Update`, the response should be the resource. For other
162 # methods, the response should have the type `XxxResponse`, where `Xxx`
163 # is the original method name. For example, if the original method name
164 # is `TakeSnapshot()`, the inferred response type is
165 # `TakeSnapshotResponse`.
166 "a_key": "", # Properties of the object. Contains field @type with type URL.
167 },
168 "name": "A String", # The server-assigned name, which is only unique within the same service that
169 # originally returns it. If you use the default HTTP mapping, the
170 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]171 "metadata": { # Service-specific metadata associated with the operation. It typically
172 # contains progress information and common metadata such as create time.
173 # Some services might not provide such metadata. Any method that returns a
174 # long-running operation should document the metadata type, if any.
175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
182 <pre>Lists operations that match the specified filter in the request. If the
183server doesn't support this method, it returns `UNIMPLEMENTED`.
184
185NOTE: the `name` binding allows API services to override the binding
186to use different resource name schemes, such as `users/*/operations`. To
187override the binding, API services can add a binding such as
188`"/v1/{name=users/*}/operations"` to their service configuration.
189For backwards compatibility, the default name includes the operations
190collection id, however overriding users must ensure the name binding
191is the parent resource, without the operations collection id.
192
193Args:
194 name: string, The name of the operation's parent resource. (required)
195 pageToken: string, The standard list page token.
196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200 pageSize: integer, The standard list page size.
201 filter: string, The standard list filter.
202
203Returns:
204 An object of the form:
205
206 { # The response message for Operations.ListOperations.
207 "nextPageToken": "A String", # The standard List next-page token.
208 "operations": [ # A list of operations that matches the specified filter in the request.
209 { # This resource represents a long-running operation that is the result of a
210 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 "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.
212 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]213 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
214 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]216 # You can find out more about this error model and how to work with it in the
217 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 "message": "A String", # A developer-facing error message, which should be in English. Any
219 # user-facing error message should be localized and sent in the
220 # google.rpc.Status.details field, or localized by the client.
221 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
222 "details": [ # A list of messages that carry the error details. There is a common set of
223 # message types for APIs to use.
224 {
225 "a_key": "", # Properties of the object. Contains field @type with type URL.
226 },
227 ],
228 },
229 "done": True or False, # If the value is `false`, it means the operation is still in progress.
230 # If `true`, the operation is completed, and either `error` or `response` is
231 # available.
232 "response": { # The normal response of the operation in case of success. If the original
233 # method returns no data on success, such as `Delete`, the response is
234 # `google.protobuf.Empty`. If the original method is standard
235 # `Get`/`Create`/`Update`, the response should be the resource. For other
236 # methods, the response should have the type `XxxResponse`, where `Xxx`
237 # is the original method name. For example, if the original method name
238 # is `TakeSnapshot()`, the inferred response type is
239 # `TakeSnapshotResponse`.
240 "a_key": "", # Properties of the object. Contains field @type with type URL.
241 },
242 "name": "A String", # The server-assigned name, which is only unique within the same service that
243 # originally returns it. If you use the default HTTP mapping, the
244 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]245 "metadata": { # Service-specific metadata associated with the operation. It typically
246 # contains progress information and common metadata such as create time.
247 # Some services might not provide such metadata. Any method that returns a
248 # long-running operation should document the metadata type, if any.
249 "a_key": "", # Properties of the object. Contains field @type with type URL.
250 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 },
252 ],
253 }</pre>
254</div>
255
256<div class="method">
257 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
258 <pre>Retrieves the next page of results.
259
260Args:
261 previous_request: The request for the previous page. (required)
262 previous_response: The response from the request for the previous page. (required)
263
264Returns:
265 A request object that you can call 'execute()' on to request the next
266 page. Returns None if there are no more items in the collection.
267 </pre>
268</div>
269
270</body></html>