Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / composer_v1beta1.projects.locations.operations.html
blob: 80ecc8f7931602a10f27129d08b7c09cdc62a777 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]84 <code><a href="#list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]94operation. If the server doesn&#x27;t support this method, it returns
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]137 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
138 # contains progress information and common metadata such as create time.
139 # Some services might not provide such metadata. Any method that returns a
140 # long-running operation should document the metadata type, if any.
141 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]143 &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]144 # If `true`, the operation is completed, and either `error` or `response` is
145 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]146 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 # method returns no data on success, such as `Delete`, the response is
148 # `google.protobuf.Empty`. If the original method is standard
149 # `Get`/`Create`/`Update`, the response should be the resource. For other
150 # methods, the response should have the type `XxxResponse`, where `Xxx`
151 # is the original method name. For example, if the original method name
152 # is `TakeSnapshot()`, the inferred response type is
153 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]154 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]156 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 # originally returns it. If you use the default HTTP mapping, the
158 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]159 &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.
160 # different programming environments, including REST APIs and RPC APIs. It is
161 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
162 # three pieces of data: error code, error message, and error details.
163 #
164 # You can find out more about this error model and how to work with it in the
165 # [API Design Guide](https://cloud.google.com/apis/design/errors).
166 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
167 # message types for APIs to use.
168 {
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
171 ],
172 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
173 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
174 # user-facing error message should be localized and sent in the
175 # google.rpc.Status.details field, or localized by the client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 }</pre>
178</div>
179
180<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]181 <code class="details" id="list">list(name, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]182 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]183server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]188`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]194 name: string, The name of the operation&#x27;s parent resource. (required)
195 filter: string, The standard list filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]197 pageSize: integer, The standard list page size.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202
203Returns:
204 An object of the form:
205
206 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]207 &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]208 { # This resource represents a long-running operation that is the result of a
209 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]210 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
211 # contains progress information and common metadata such as create time.
212 # Some services might not provide such metadata. Any method that returns a
213 # long-running operation should document the metadata type, if any.
214 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]216 &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]217 # If `true`, the operation is completed, and either `error` or `response` is
218 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]219 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 # method returns no data on success, such as `Delete`, the response is
221 # `google.protobuf.Empty`. If the original method is standard
222 # `Get`/`Create`/`Update`, the response should be the resource. For other
223 # methods, the response should have the type `XxxResponse`, where `Xxx`
224 # is the original method name. For example, if the original method name
225 # is `TakeSnapshot()`, the inferred response type is
226 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]227 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]229 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 # originally returns it. If you use the default HTTP mapping, the
231 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]232 &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.
233 # different programming environments, including REST APIs and RPC APIs. It is
234 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
235 # three pieces of data: error code, error message, and error details.
236 #
237 # You can find out more about this error model and how to work with it in the
238 # [API Design Guide](https://cloud.google.com/apis/design/errors).
239 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
240 # message types for APIs to use.
241 {
242 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
243 },
244 ],
245 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
246 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
247 # user-facing error message should be localized and sent in the
248 # google.rpc.Status.details field, or localized by the client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]249 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 },
251 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]252 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]265 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]266 page. Returns None if there are no more items in the collection.
267 </pre>
268</div>
269
270</body></html>