Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / af918e8ef422438aaca0c468de8b3b2c184d884e / . / docs / dyn / lifesciences_v2beta.projects.locations.operations.html
blob: ca1309a800f7bda0da91a621100dbbfc8d517509 [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>
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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.cancel`</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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.get`</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]87 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.list`</p>
Bu Sun Kim65020912020-05-20 12:08:20 -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. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.cancel`
Bu Sun Kim65020912020-05-20 12:08:20 -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 Kim65020912020-05-20 12:08:20 -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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]122<div class="method">
123 <code class="details" id="get">get(name, x__xgafv=None)</code>
124 <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.get`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]125
126Args:
127 name: string, The name of the operation resource. (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 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 &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]138 &quot;response&quot;: { # An Empty object.
139 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
140 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]141 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]142 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 &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]144 {
145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
146 },
147 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]148 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]150 &quot;metadata&quot;: { # An Metadata object. This will always be returned with the Operation.
151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
153 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]158 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]159 <pre>Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.list`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160
161Args:
162 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 pageSize: integer, The maximum number of results to return. The maximum value is 256.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]164 filter: string, A string for filtering Operations. The following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels.&quot;key with space&quot; where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]165 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171Returns:
172 An object of the form:
173
174 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 &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]176 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]177 &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]178 &quot;response&quot;: { # An Empty object.
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]181 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]182 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]183 &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]184 {
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]188 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]190 &quot;metadata&quot;: { # An Metadata object. This will always be returned with the Operation.
191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
192 },
193 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 },
195 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]196 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 }</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
202 <pre>Retrieves the next page of results.
203
204Args:
205 previous_request: The request for the previous page. (required)
206 previous_response: The response from the request for the previous page. (required)
207
208Returns:
209 A request object that you can call &#x27;execute()&#x27; on to request the next
210 page. Returns None if there are no more items in the collection.
211 </pre>
212</div>
213
214</body></html>