Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ed7d3f9b61ac35e08a22b4995076a95451cf7c8 / . / docs / dyn / healthcare_v1beta1.projects.locations.datasets.operations.html
blob: f8c049dd37b39748187d7c7702438020f5ba0558 [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="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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. The server</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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</p>
83<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -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. If the</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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
92 <pre>Starts asynchronous cancellation on a long-running operation. The server
93makes a best effort to cancel the operation, but success is not
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94guaranteed. If the server doesn&#x27;t support this method, it returns
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95`google.rpc.Code.UNIMPLEMENTED`. Clients can use
96Operations.GetOperation or
97other methods to check whether the cancellation succeeded or whether the
98operation completed despite cancellation. On successful cancellation,
99the operation is not deleted; instead, it becomes an operation with
100an Operation.error value with a google.rpc.Status.code of 1,
101corresponding to `Code.CANCELLED`.
102
103Args:
104 name: string, The name of the operation resource to be cancelled. (required)
105 body: object, The request body.
106 The object takes the form of:
107
108{ # The request message for Operations.CancelOperation.
109 }
110
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # A generic empty message that you can re-use to avoid defining duplicated
120 # empty messages in your APIs. A typical example is to use it as the request
121 # or the response type of an API method. For instance:
122 #
123 # service Foo {
124 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
125 # }
126 #
127 # The JSON representation for `Empty` is empty JSON object `{}`.
128 }</pre>
129</div>
130
131<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 <code class="details" id="get">get(name, x__xgafv=None)</code>
133 <pre>Gets the latest state of a long-running operation. Clients can use this
134method to poll the operation result at intervals as recommended by the API
135service.
136
137Args:
138 name: string, The name of the operation resource. (required)
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # This resource represents a long-running operation that is the result of a
148 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]150 # contains progress information and common metadata such as create time.
151 # Some services might not provide such metadata. Any method that returns a
152 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &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]154 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]155 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # If `true`, the operation is completed, and either `error` or `response` is
157 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 # method returns no data on success, such as `Delete`, the response is
160 # `google.protobuf.Empty`. If the original method is standard
161 # `Get`/`Create`/`Update`, the response should be the resource. For other
162 # methods, the response should have the type `XxxResponse`, where `Xxx`
163 # is the original method name. For example, if the original method name
164 # is `TakeSnapshot()`, the inferred response type is
165 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]166 &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]167 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]168 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
169 # originally returns it. If you use the default HTTP mapping, the
170 # `name` should be a resource name ending with `operations/{unique_id}`.
171 &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.
172 # different programming environments, including REST APIs and RPC APIs. It is
173 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
174 # three pieces of data: error code, error message, and error details.
175 #
176 # You can find out more about this error model and how to work with it in the
177 # [API Design Guide](https://cloud.google.com/apis/design/errors).
178 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
179 # message types for APIs to use.
180 {
181 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
182 },
183 ],
184 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
185 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
186 # user-facing error message should be localized and sent in the
187 # google.rpc.Status.details field, or localized by the client.
188 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 }</pre>
190</div>
191
192<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]193 <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]194 <pre>Lists operations that match the specified filter in the request. If the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196
197NOTE: the `name` binding allows API services to override the binding
198to use different resource name schemes, such as `users/*/operations`. To
199override the binding, API services can add a binding such as
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]200`&quot;/v1/{name=users/*}/operations&quot;` to their service configuration.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201For backwards compatibility, the default name includes the operations
202collection id, however overriding users must ensure the name binding
203is the parent resource, without the operations collection id.
204
205Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]206 name: string, The name of the operation&#x27;s parent resource. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]207 filter: string, The standard list filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 pageToken: string, The standard list page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]209 pageSize: integer, The standard list page size.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214
215Returns:
216 An object of the form:
217
218 { # The response message for Operations.ListOperations.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]219 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 &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]221 { # This resource represents a long-running operation that is the result of a
222 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]223 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]224 # contains progress information and common metadata such as create time.
225 # Some services might not provide such metadata. Any method that returns a
226 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]227 &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]228 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]229 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]230 # If `true`, the operation is completed, and either `error` or `response` is
231 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]232 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]233 # method returns no data on success, such as `Delete`, the response is
234 # `google.protobuf.Empty`. If the original method is standard
235 # `Get`/`Create`/`Update`, the response should be the resource. For other
236 # methods, the response should have the type `XxxResponse`, where `Xxx`
237 # is the original method name. For example, if the original method name
238 # is `TakeSnapshot()`, the inferred response type is
239 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 &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]241 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame^]242 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
243 # originally returns it. If you use the default HTTP mapping, the
244 # `name` should be a resource name ending with `operations/{unique_id}`.
245 &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.
246 # different programming environments, including REST APIs and RPC APIs. It is
247 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
248 # three pieces of data: error code, error message, and error details.
249 #
250 # You can find out more about this error model and how to work with it in the
251 # [API Design Guide](https://cloud.google.com/apis/design/errors).
252 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
253 # message types for APIs to use.
254 {
255 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
256 },
257 ],
258 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
259 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
260 # user-facing error message should be localized and sent in the
261 # google.rpc.Status.details field, or localized by the client.
262 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 },
264 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
270 <pre>Retrieves the next page of results.
271
272Args:
273 previous_request: The request for the previous page. (required)
274 previous_response: The response from the request for the previous page. (required)
275
276Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]277 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]278 page. Returns None if there are no more items in the collection.
279 </pre>
280</div>
281
282</body></html>