Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / genomics_v1.operations.html
blob: 57eff73e1f1372bdb38d2e1bd78ec0d9dd2703f1 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -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_v1.html">Genomics API</a> . <a href="genomics_v1.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[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.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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 method to poll the operation result at intervals as recommended by the API service.</p>
83<p class="toc_element">
84 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
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, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]92 <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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93
94Args:
95 name: string, The name of the operation resource to be cancelled. (required)
96 body: object, The request body. (required)
97 The object takes the form of:
98
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]99{ # The request message for Operations.CancelOperation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100 }
101
102 x__xgafv: string, V1 error format.
103
104Returns:
105 An object of the form:
106
107 { # 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 `{}`.
108 }</pre>
109</div>
110
111<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 <code class="details" id="get">get(name, x__xgafv=None)</code>
113 <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.
114
115Args:
116 name: string, The name of the operation resource. (required)
117 x__xgafv: string, V1 error format.
118
119Returns:
120 An object of the form:
121
122 { # This resource represents a long-running operation that is the result of a network API call.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]123 "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]124 "a_key": "", # Properties of the object. Contains field @ype with type URL.
125 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]126 "error": { # 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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
127 "message": "A String", # 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.
128 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]129 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
130 {
131 "a_key": "", # Properties of the object. Contains field @ype with type URL.
132 },
133 ],
134 },
135 "done": 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.
136 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]137 "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]138 "a_key": "", # Properties of the object. Contains field @ype with type URL.
139 },
140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
145 <pre>Lists operations that match the specified filter in the request.
146
147Args:
148 name: string, The name of the operation collection. (required)
149 pageSize: integer, The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]150 filter: string, A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]151 pageToken: string, The standard list page token.
152 x__xgafv: string, V1 error format.
153
154Returns:
155 An object of the form:
156
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]157 { # The response message for Operations.ListOperations.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]158 "operations": [ # A list of operations that matches the specified filter in the request.
159 { # This resource represents a long-running operation that is the result of a network API call.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]160 "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]161 "a_key": "", # Properties of the object. Contains field @ype with type URL.
162 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]163 "error": { # 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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
164 "message": "A String", # 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.
165 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]166 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
167 {
168 "a_key": "", # Properties of the object. Contains field @ype with type URL.
169 },
170 ],
171 },
172 "done": 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.
173 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]174 "metadata": { # An OperationMetadata object. This will always be returned with the Operation.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 "a_key": "", # Properties of the object. Contains field @ype with type URL.
176 },
177 },
178 ],
179 "nextPageToken": "A String", # The standard List next-page token.
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:
192 A request object that you can call 'execute()' on to request the next
193 page. Returns None if there are no more items in the collection.
194 </pre>
195</div>
196
197</body></html>