Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / remotebuildexecution_v1.operations.html
blob: acb704b28656d6e0693546e7227c1be6d0d0593d [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="remotebuildexecution_v1.html">Remote Build Execution API</a> . <a href="remotebuildexecution_v1.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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.</p>
80<p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]87 <code><a href="#list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]95 <pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96
97Args:
98 name: string, The name of the operation resource to be cancelled. (required)
99 body: object, The request body.
100 The object takes the form of:
101
102{ # The request message for Operations.CancelOperation.
103 }
104
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110Returns:
111 An object of the form:
112
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]113 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 }</pre>
115</div>
116
117<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 <code class="details" id="close">close()</code>
119 <pre>Close httplib2 connections.</pre>
120</div>
121
122<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 <pre>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125
126Args:
127 name: string, The name of the operation resource to be deleted. (required)
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]136 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 }</pre>
138</div>
139
140<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]141 <code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 <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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143
144Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 pageToken: string, The standard list page token.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]147 pageSize: integer, The standard list page size.
148 filter: string, The standard list filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153
154Returns:
155 An object of the form:
156
157 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]159 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]160 &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`.
161 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
162 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]163 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &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]165 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]166 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 &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.
168 &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.
169 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
170 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]171 {
172 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
173 },
174 ],
175 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]176 &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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 },
178 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]179 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 }</pre>
181</div>
182
183<div class="method">
184 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
185 <pre>Retrieves the next page of results.
186
187Args:
188 previous_request: The request for the previous page. (required)
189 previous_response: The response from the request for the previous page. (required)
190
191Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 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]193 page. Returns None if there are no more items in the collection.
194 </pre>
195</div>
196
197</body></html>