Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / lifesciences_v2beta.projects.locations.operations.html
blob: c1d40ad5ee569925b2492407db0ca147104dc9f8 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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="lifesciences_v2beta.html">Cloud Life Sciences API</a> . <a href="lifesciences_v2beta.projects.html">projects</a> . <a href="lifesciences_v2beta.projects.locations.html">locations</a> . <a href="lifesciences_v2beta.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.</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.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#list">list(name, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]85<p class="firstline">Lists operations that match the specified filter in the request.</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.
93The server makes a best effort to cancel the operation, but success is not
94guaranteed. Clients may use Operations.GetOperation
95or Operations.ListOperations
96to check whether the cancellation succeeded or the operation completed
97despite cancellation.
98Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&amp;#58;
99
100* `lifesciences.operations.cancel`
101
102Args:
103 name: string, The name of the operation resource to be cancelled. (required)
104 body: object, The request body.
105 The object takes the form of:
106
107{ # The request message for Operations.CancelOperation.
108 }
109
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # A generic empty message that you can re-use to avoid defining duplicated
119 # empty messages in your APIs. A typical example is to use it as the request
120 # or the response type of an API method. For instance:
121 #
122 # service Foo {
123 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
124 # }
125 #
126 # The JSON representation for `Empty` is empty JSON object `{}`.
127 }</pre>
128</div>
129
130<div class="method">
131 <code class="details" id="get">get(name, x__xgafv=None)</code>
132 <pre>Gets the latest state of a long-running operation.
133Clients can use this method to poll the operation result at intervals as
134recommended by the API service.
135Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&amp;#58;
136
137* `lifesciences.operations.get`
138
139Args:
140 name: string, The name of the operation resource. (required)
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # This resource represents a long-running operation that is the result of a
150 # network API call.
151 &quot;response&quot;: { # An Empty object.
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.
155 # If `true`, the operation is completed, and either `error` or `response` is
156 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 &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.
158 # different programming environments, including REST APIs and RPC APIs. It is
159 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
160 # three pieces of data: error code, error message, and error details.
161 #
162 # You can find out more about this error model and how to work with it in the
163 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
165 # message types for APIs to use.
166 {
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
168 },
169 ],
170 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
172 # user-facing error message should be localized and sent in the
173 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 },
175 &quot;metadata&quot;: { # An Metadata object. This will always be returned with the Operation.
176 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
177 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]178 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation&#x27;s status.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]179 }</pre>
180</div>
181
182<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]183 <code class="details" id="list">list(name, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]184 <pre>Lists operations that match the specified filter in the request.
185Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&amp;#58;
186
187* `lifesciences.operations.list`
188
189Args:
190 name: string, The name of the operation&#x27;s parent resource. (required)
191 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]192 filter: string, A string for filtering Operations.
193The following filter fields are supported&amp;#58;
194
195* createTime&amp;#58; The time this job was created
196* events&amp;#58; The set of event (names) that have occurred while running
197 the pipeline. The &amp;#58; operator can be used to determine if a
198 particular event has occurred.
199* error&amp;#58; If the pipeline is running, this value is NULL. Once the
200 pipeline finishes, the value is the standard Google error code.
201* labels.key or labels.&quot;key with space&quot; where key is a label key.
202* done&amp;#58; If the pipeline is running, this value is false. Once the
203 pipeline finishes, the value is true.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]204 pageSize: integer, The maximum number of results to return. The maximum value is 256.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210Returns:
211 An object of the form:
212
213 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
215 { # This resource represents a long-running operation that is the result of a
216 # network API call.
217 &quot;response&quot;: { # An Empty object.
218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
219 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]220 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
221 # If `true`, the operation is completed, and either `error` or `response` is
222 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 &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.
224 # different programming environments, including REST APIs and RPC APIs. It is
225 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
226 # three pieces of data: error code, error message, and error details.
227 #
228 # You can find out more about this error model and how to work with it in the
229 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]230 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
231 # message types for APIs to use.
232 {
233 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
234 },
235 ],
236 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]237 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
238 # user-facing error message should be localized and sent in the
239 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 },
241 &quot;metadata&quot;: { # An Metadata object. This will always be returned with the Operation.
242 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
243 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]244 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation&#x27;s status.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 },
246 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]247 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]248 }</pre>
249</div>
250
251<div class="method">
252 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
253 <pre>Retrieves the next page of results.
254
255Args:
256 previous_request: The request for the previous page. (required)
257 previous_response: The response from the request for the previous page. (required)
258
259Returns:
260 A request object that you can call &#x27;execute()&#x27; on to request the next
261 page. Returns None if there are no more items in the collection.
262 </pre>
263</div>
264
265</body></html>