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