Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / genomics_v2alpha1.projects.operations.html
blob: ae50d9ab822af47971091ef3f2199bad4b7e2546 [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="genomics_v2alpha1.html">Genomics API</a> . <a href="genomics_v2alpha1.projects.html">projects</a> . <a href="genomics_v2alpha1.projects.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 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.</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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&amp;#58;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99
100* `genomics.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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]135Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&amp;#58;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136
137* `genomics.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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]151 &quot;response&quot;: { # An Empty object.
152 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]153 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]154 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. For example&amp;#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
155 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # different programming environments, including REST APIs and RPC APIs. It is
157 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
158 # three pieces of data: error code, error message, and error details.
159 #
160 # You can find out more about this error model and how to work with it in the
161 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]162 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
163 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 # user-facing error message should be localized and sent in the
165 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]166 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 # message types for APIs to use.
168 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]169 &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]170 },
171 ],
172 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]173 &quot;metadata&quot;: { # An OperationMetadata or Metadata object. This will always be returned with the Operation.
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 }</pre>
180</div>
181
182<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]183 <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]184 <pre>Lists operations that match the specified filter in the request.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]185Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission&amp;#58;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186
187* `genomics.operations.list`
188
189Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]190 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 filter: string, A string for filtering Operations.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]192In v2alpha1, the following filter fields are supported&amp;#58;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]194* createTime&amp;#58; The time this job was created
195* events&amp;#58; The set of event (names) that have occurred while running
196 the pipeline. The &amp;#58; operator can be used to determine if a
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 particular event has occurred.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]198* error&amp;#58; If the pipeline is running, this value is NULL. Once the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 pipeline finishes, the value is the standard Google error code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]200* labels.key or labels.&quot;key with space&quot; where key is a label key.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]201* done&amp;#58; If the pipeline is running, this value is false. Once the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 pipeline finishes, the value is true.
203
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]204In v1 and v1alpha2, the following filter fields are supported&amp;#58;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]206* projectId&amp;#58; Required. Corresponds to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 OperationMetadata.projectId.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]208* createTime&amp;#58; The time this job was created, in seconds from the
209 [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `&gt;=` and/or `&lt;=`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 operators.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]211* status&amp;#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 one status may be specified.
213* labels.key where key is a label key.
214
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]215Examples&amp;#58;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]217* `projectId = my-project AND createTime &gt;= 1432140000`
218* `projectId = my-project AND createTime &gt;= 1432140000 AND createTime &lt;= 1432150000 AND status = RUNNING`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219* `projectId = my-project AND labels.color = *`
220* `projectId = my-project AND labels.color = red`
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]221 pageToken: string, The standard list page token.
222 pageSize: integer, The maximum number of results to return. The maximum value is 256.
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227
228Returns:
229 An object of the form:
230
231 { # The response message for Operations.ListOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]232 &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]233 { # This resource represents a long-running operation that is the result of a
234 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]235 &quot;response&quot;: { # An Empty object.
236 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]237 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]238 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. For example&amp;#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
239 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 # different programming environments, including REST APIs and RPC APIs. It is
241 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
242 # three pieces of data: error code, error message, and error details.
243 #
244 # You can find out more about this error model and how to work with it in the
245 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]246 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
247 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 # user-facing error message should be localized and sent in the
249 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]250 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 # message types for APIs to use.
252 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]253 &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]254 },
255 ],
256 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]257 &quot;metadata&quot;: { # An OperationMetadata or Metadata object. This will always be returned with the Operation.
258 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
259 },
260 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
261 # If `true`, the operation is completed, and either `error` or `response` is
262 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 },
264 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]265 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]266 }</pre>
267</div>
268
269<div class="method">
270 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
271 <pre>Retrieves the next page of results.
272
273Args:
274 previous_request: The request for the previous page. (required)
275 previous_response: The response from the request for the previous page. (required)
276
277Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]278 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]279 page. Returns None if there are no more items in the collection.
280 </pre>
281</div>
282
283</body></html>