google-apis-healthcare_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,3490 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module HealthcareV1
23
+ # Cloud Healthcare API
24
+ #
25
+ # Manage, store, and access healthcare data in Google Cloud Platform.
26
+ #
27
+ # @example
28
+ # require 'google/apis/healthcare_v1'
29
+ #
30
+ # Healthcare = Google::Apis::HealthcareV1 # Alias the module
31
+ # service = Healthcare::CloudHealthcareService.new
32
+ #
33
+ # @see https://cloud.google.com/healthcare
34
+ class CloudHealthcareService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://healthcare.googleapis.com/', '',
47
+ client_name: 'google-apis-healthcare_v1',
48
+ client_version: Google::Apis::HealthcareV1::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Gets information about a location.
53
+ # @param [String] name
54
+ # Resource name for the location.
55
+ # @param [String] fields
56
+ # Selector specifying which fields to include in a partial response.
57
+ # @param [String] quota_user
58
+ # Available to use for quota purposes for server-side applications. Can be any
59
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
60
+ # @param [Google::Apis::RequestOptions] options
61
+ # Request-specific options
62
+ #
63
+ # @yield [result, err] Result & error if block supplied
64
+ # @yieldparam result [Google::Apis::HealthcareV1::Location] parsed result object
65
+ # @yieldparam err [StandardError] error object if request failed
66
+ #
67
+ # @return [Google::Apis::HealthcareV1::Location]
68
+ #
69
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
70
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
71
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
72
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
73
+ command = make_simple_command(:get, 'v1/{+name}', options)
74
+ command.response_representation = Google::Apis::HealthcareV1::Location::Representation
75
+ command.response_class = Google::Apis::HealthcareV1::Location
76
+ command.params['name'] = name unless name.nil?
77
+ command.query['fields'] = fields unless fields.nil?
78
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
79
+ execute_or_queue_command(command, &block)
80
+ end
81
+
82
+ # Lists information about the supported locations for this service.
83
+ # @param [String] name
84
+ # The resource that owns the locations collection, if applicable.
85
+ # @param [String] filter
86
+ # The standard list filter.
87
+ # @param [Fixnum] page_size
88
+ # The standard list page size.
89
+ # @param [String] page_token
90
+ # The standard list page token.
91
+ # @param [String] fields
92
+ # Selector specifying which fields to include in a partial response.
93
+ # @param [String] quota_user
94
+ # Available to use for quota purposes for server-side applications. Can be any
95
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
96
+ # @param [Google::Apis::RequestOptions] options
97
+ # Request-specific options
98
+ #
99
+ # @yield [result, err] Result & error if block supplied
100
+ # @yieldparam result [Google::Apis::HealthcareV1::ListLocationsResponse] parsed result object
101
+ # @yieldparam err [StandardError] error object if request failed
102
+ #
103
+ # @return [Google::Apis::HealthcareV1::ListLocationsResponse]
104
+ #
105
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
106
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
107
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
108
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
109
+ command = make_simple_command(:get, 'v1/{+name}/locations', options)
110
+ command.response_representation = Google::Apis::HealthcareV1::ListLocationsResponse::Representation
111
+ command.response_class = Google::Apis::HealthcareV1::ListLocationsResponse
112
+ command.params['name'] = name unless name.nil?
113
+ command.query['filter'] = filter unless filter.nil?
114
+ command.query['pageSize'] = page_size unless page_size.nil?
115
+ command.query['pageToken'] = page_token unless page_token.nil?
116
+ command.query['fields'] = fields unless fields.nil?
117
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
118
+ execute_or_queue_command(command, &block)
119
+ end
120
+
121
+ # Creates a new health dataset. Results are returned through the Operation
122
+ # interface which returns either an `Operation.response` which contains a
123
+ # Dataset or `Operation.error`. The metadata field type is OperationMetadata.
124
+ # @param [String] parent
125
+ # The name of the project where the server creates the dataset. For example, `
126
+ # projects/`project_id`/locations/`location_id``.
127
+ # @param [Google::Apis::HealthcareV1::Dataset] dataset_object
128
+ # @param [String] dataset_id
129
+ # The ID of the dataset that is being created. The string must match the
130
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
131
+ # @param [String] fields
132
+ # Selector specifying which fields to include in a partial response.
133
+ # @param [String] quota_user
134
+ # Available to use for quota purposes for server-side applications. Can be any
135
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
136
+ # @param [Google::Apis::RequestOptions] options
137
+ # Request-specific options
138
+ #
139
+ # @yield [result, err] Result & error if block supplied
140
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
141
+ # @yieldparam err [StandardError] error object if request failed
142
+ #
143
+ # @return [Google::Apis::HealthcareV1::Operation]
144
+ #
145
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
146
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
147
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
148
+ def create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil, &block)
149
+ command = make_simple_command(:post, 'v1/{+parent}/datasets', options)
150
+ command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation
151
+ command.request_object = dataset_object
152
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
153
+ command.response_class = Google::Apis::HealthcareV1::Operation
154
+ command.params['parent'] = parent unless parent.nil?
155
+ command.query['datasetId'] = dataset_id unless dataset_id.nil?
156
+ command.query['fields'] = fields unless fields.nil?
157
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
158
+ execute_or_queue_command(command, &block)
159
+ end
160
+
161
+ # Creates a new dataset containing de-identified data from the source dataset.
162
+ # The metadata field type is OperationMetadata. If the request is successful,
163
+ # the response field type is DeidentifySummary. If errors occur, error is set.
164
+ # The LRO result may still be successful if de-identification fails for some
165
+ # DICOM instances. The new de-identified dataset will not contain these failed
166
+ # resources. Failed resource totals are tracked in Operation.metadata. Error
167
+ # details are also logged to Cloud Logging. For more information, see [Viewing
168
+ # logs](/healthcare/docs/how-tos/logging).
169
+ # @param [String] source_dataset
170
+ # Source dataset resource name. For example, `projects/`project_id`/locations/`
171
+ # location_id`/datasets/`dataset_id``.
172
+ # @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object
173
+ # @param [String] fields
174
+ # Selector specifying which fields to include in a partial response.
175
+ # @param [String] quota_user
176
+ # Available to use for quota purposes for server-side applications. Can be any
177
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
178
+ # @param [Google::Apis::RequestOptions] options
179
+ # Request-specific options
180
+ #
181
+ # @yield [result, err] Result & error if block supplied
182
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
183
+ # @yieldparam err [StandardError] error object if request failed
184
+ #
185
+ # @return [Google::Apis::HealthcareV1::Operation]
186
+ #
187
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
188
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
189
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
190
+ def deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
191
+ command = make_simple_command(:post, 'v1/{+sourceDataset}:deidentify', options)
192
+ command.request_representation = Google::Apis::HealthcareV1::DeidentifyDatasetRequest::Representation
193
+ command.request_object = deidentify_dataset_request_object
194
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
195
+ command.response_class = Google::Apis::HealthcareV1::Operation
196
+ command.params['sourceDataset'] = source_dataset unless source_dataset.nil?
197
+ command.query['fields'] = fields unless fields.nil?
198
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
199
+ execute_or_queue_command(command, &block)
200
+ end
201
+
202
+ # Deletes the specified health dataset and all data contained in the dataset.
203
+ # Deleting a dataset does not affect the sources from which the dataset was
204
+ # imported (if any).
205
+ # @param [String] name
206
+ # The name of the dataset to delete. For example, `projects/`project_id`/
207
+ # locations/`location_id`/datasets/`dataset_id``.
208
+ # @param [String] fields
209
+ # Selector specifying which fields to include in a partial response.
210
+ # @param [String] quota_user
211
+ # Available to use for quota purposes for server-side applications. Can be any
212
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
213
+ # @param [Google::Apis::RequestOptions] options
214
+ # Request-specific options
215
+ #
216
+ # @yield [result, err] Result & error if block supplied
217
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
218
+ # @yieldparam err [StandardError] error object if request failed
219
+ #
220
+ # @return [Google::Apis::HealthcareV1::Empty]
221
+ #
222
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
223
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
224
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
225
+ def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
226
+ command = make_simple_command(:delete, 'v1/{+name}', options)
227
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
228
+ command.response_class = Google::Apis::HealthcareV1::Empty
229
+ command.params['name'] = name unless name.nil?
230
+ command.query['fields'] = fields unless fields.nil?
231
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
232
+ execute_or_queue_command(command, &block)
233
+ end
234
+
235
+ # Gets any metadata associated with a dataset.
236
+ # @param [String] name
237
+ # The name of the dataset to read. For example, `projects/`project_id`/locations/
238
+ # `location_id`/datasets/`dataset_id``.
239
+ # @param [String] fields
240
+ # Selector specifying which fields to include in a partial response.
241
+ # @param [String] quota_user
242
+ # Available to use for quota purposes for server-side applications. Can be any
243
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
244
+ # @param [Google::Apis::RequestOptions] options
245
+ # Request-specific options
246
+ #
247
+ # @yield [result, err] Result & error if block supplied
248
+ # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
249
+ # @yieldparam err [StandardError] error object if request failed
250
+ #
251
+ # @return [Google::Apis::HealthcareV1::Dataset]
252
+ #
253
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
254
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
255
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
256
+ def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
257
+ command = make_simple_command(:get, 'v1/{+name}', options)
258
+ command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation
259
+ command.response_class = Google::Apis::HealthcareV1::Dataset
260
+ command.params['name'] = name unless name.nil?
261
+ command.query['fields'] = fields unless fields.nil?
262
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
263
+ execute_or_queue_command(command, &block)
264
+ end
265
+
266
+ # Gets the access control policy for a resource. Returns an empty policy if the
267
+ # resource exists and does not have a policy set.
268
+ # @param [String] resource
269
+ # REQUIRED: The resource for which the policy is being requested. See the
270
+ # operation documentation for the appropriate value for this field.
271
+ # @param [Fixnum] options_requested_policy_version
272
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
273
+ # 3. Requests specifying an invalid value will be rejected. Requests for
274
+ # policies with any conditional bindings must specify version 3. Policies
275
+ # without any conditional bindings may specify any valid value or leave the
276
+ # field unset. To learn which resources support conditions in their IAM policies,
277
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
278
+ # resource-policies).
279
+ # @param [String] fields
280
+ # Selector specifying which fields to include in a partial response.
281
+ # @param [String] quota_user
282
+ # Available to use for quota purposes for server-side applications. Can be any
283
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
284
+ # @param [Google::Apis::RequestOptions] options
285
+ # Request-specific options
286
+ #
287
+ # @yield [result, err] Result & error if block supplied
288
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
289
+ # @yieldparam err [StandardError] error object if request failed
290
+ #
291
+ # @return [Google::Apis::HealthcareV1::Policy]
292
+ #
293
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
294
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
295
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
296
+ def get_project_location_dataset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
297
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
298
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
299
+ command.response_class = Google::Apis::HealthcareV1::Policy
300
+ command.params['resource'] = resource unless resource.nil?
301
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
302
+ command.query['fields'] = fields unless fields.nil?
303
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
304
+ execute_or_queue_command(command, &block)
305
+ end
306
+
307
+ # Lists the health datasets in the current project.
308
+ # @param [String] parent
309
+ # The name of the project whose datasets should be listed. For example, `
310
+ # projects/`project_id`/locations/`location_id``.
311
+ # @param [Fixnum] page_size
312
+ # The maximum number of items to return. If not specified, 100 is used. May not
313
+ # be larger than 1000.
314
+ # @param [String] page_token
315
+ # The next_page_token value returned from a previous List request, if any.
316
+ # @param [String] fields
317
+ # Selector specifying which fields to include in a partial response.
318
+ # @param [String] quota_user
319
+ # Available to use for quota purposes for server-side applications. Can be any
320
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
321
+ # @param [Google::Apis::RequestOptions] options
322
+ # Request-specific options
323
+ #
324
+ # @yield [result, err] Result & error if block supplied
325
+ # @yieldparam result [Google::Apis::HealthcareV1::ListDatasetsResponse] parsed result object
326
+ # @yieldparam err [StandardError] error object if request failed
327
+ #
328
+ # @return [Google::Apis::HealthcareV1::ListDatasetsResponse]
329
+ #
330
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
333
+ def list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
334
+ command = make_simple_command(:get, 'v1/{+parent}/datasets', options)
335
+ command.response_representation = Google::Apis::HealthcareV1::ListDatasetsResponse::Representation
336
+ command.response_class = Google::Apis::HealthcareV1::ListDatasetsResponse
337
+ command.params['parent'] = parent unless parent.nil?
338
+ command.query['pageSize'] = page_size unless page_size.nil?
339
+ command.query['pageToken'] = page_token unless page_token.nil?
340
+ command.query['fields'] = fields unless fields.nil?
341
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
342
+ execute_or_queue_command(command, &block)
343
+ end
344
+
345
+ # Updates dataset metadata.
346
+ # @param [String] name
347
+ # Resource name of the dataset, of the form `projects/`project_id`/locations/`
348
+ # location_id`/datasets/`dataset_id``.
349
+ # @param [Google::Apis::HealthcareV1::Dataset] dataset_object
350
+ # @param [String] update_mask
351
+ # The update mask applies to the resource. For the `FieldMask` definition, see
352
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
353
+ # fieldmask
354
+ # @param [String] fields
355
+ # Selector specifying which fields to include in a partial response.
356
+ # @param [String] quota_user
357
+ # Available to use for quota purposes for server-side applications. Can be any
358
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
359
+ # @param [Google::Apis::RequestOptions] options
360
+ # Request-specific options
361
+ #
362
+ # @yield [result, err] Result & error if block supplied
363
+ # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
364
+ # @yieldparam err [StandardError] error object if request failed
365
+ #
366
+ # @return [Google::Apis::HealthcareV1::Dataset]
367
+ #
368
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
369
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
370
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
371
+ def patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
372
+ command = make_simple_command(:patch, 'v1/{+name}', options)
373
+ command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation
374
+ command.request_object = dataset_object
375
+ command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation
376
+ command.response_class = Google::Apis::HealthcareV1::Dataset
377
+ command.params['name'] = name unless name.nil?
378
+ command.query['updateMask'] = update_mask unless update_mask.nil?
379
+ command.query['fields'] = fields unless fields.nil?
380
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
381
+ execute_or_queue_command(command, &block)
382
+ end
383
+
384
+ # Sets the access control policy on the specified resource. Replaces any
385
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
386
+ # PERMISSION_DENIED` errors.
387
+ # @param [String] resource
388
+ # REQUIRED: The resource for which the policy is being specified. See the
389
+ # operation documentation for the appropriate value for this field.
390
+ # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object
391
+ # @param [String] fields
392
+ # Selector specifying which fields to include in a partial response.
393
+ # @param [String] quota_user
394
+ # Available to use for quota purposes for server-side applications. Can be any
395
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
396
+ # @param [Google::Apis::RequestOptions] options
397
+ # Request-specific options
398
+ #
399
+ # @yield [result, err] Result & error if block supplied
400
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
401
+ # @yieldparam err [StandardError] error object if request failed
402
+ #
403
+ # @return [Google::Apis::HealthcareV1::Policy]
404
+ #
405
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
406
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
407
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
408
+ def set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
409
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
410
+ command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
411
+ command.request_object = set_iam_policy_request_object
412
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
413
+ command.response_class = Google::Apis::HealthcareV1::Policy
414
+ command.params['resource'] = resource unless resource.nil?
415
+ command.query['fields'] = fields unless fields.nil?
416
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
417
+ execute_or_queue_command(command, &block)
418
+ end
419
+
420
+ # Returns permissions that a caller has on the specified resource. If the
421
+ # resource does not exist, this will return an empty set of permissions, not a `
422
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
423
+ # permission-aware UIs and command-line tools, not for authorization checking.
424
+ # This operation may "fail open" without warning.
425
+ # @param [String] resource
426
+ # REQUIRED: The resource for which the policy detail is being requested. See the
427
+ # operation documentation for the appropriate value for this field.
428
+ # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object
429
+ # @param [String] fields
430
+ # Selector specifying which fields to include in a partial response.
431
+ # @param [String] quota_user
432
+ # Available to use for quota purposes for server-side applications. Can be any
433
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
434
+ # @param [Google::Apis::RequestOptions] options
435
+ # Request-specific options
436
+ #
437
+ # @yield [result, err] Result & error if block supplied
438
+ # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
439
+ # @yieldparam err [StandardError] error object if request failed
440
+ #
441
+ # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
442
+ #
443
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
444
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
445
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
446
+ def test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
447
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
448
+ command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
449
+ command.request_object = test_iam_permissions_request_object
450
+ command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
451
+ command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
452
+ command.params['resource'] = resource unless resource.nil?
453
+ command.query['fields'] = fields unless fields.nil?
454
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
455
+ execute_or_queue_command(command, &block)
456
+ end
457
+
458
+ # Creates a new DICOM store within the parent dataset.
459
+ # @param [String] parent
460
+ # The name of the dataset this DICOM store belongs to.
461
+ # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object
462
+ # @param [String] dicom_store_id
463
+ # The ID of the DICOM store that is being created. Any string value up to 256
464
+ # characters in length.
465
+ # @param [String] fields
466
+ # Selector specifying which fields to include in a partial response.
467
+ # @param [String] quota_user
468
+ # Available to use for quota purposes for server-side applications. Can be any
469
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
470
+ # @param [Google::Apis::RequestOptions] options
471
+ # Request-specific options
472
+ #
473
+ # @yield [result, err] Result & error if block supplied
474
+ # @yieldparam result [Google::Apis::HealthcareV1::DicomStore] parsed result object
475
+ # @yieldparam err [StandardError] error object if request failed
476
+ #
477
+ # @return [Google::Apis::HealthcareV1::DicomStore]
478
+ #
479
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
480
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
481
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
482
+ def create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
483
+ command = make_simple_command(:post, 'v1/{+parent}/dicomStores', options)
484
+ command.request_representation = Google::Apis::HealthcareV1::DicomStore::Representation
485
+ command.request_object = dicom_store_object
486
+ command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation
487
+ command.response_class = Google::Apis::HealthcareV1::DicomStore
488
+ command.params['parent'] = parent unless parent.nil?
489
+ command.query['dicomStoreId'] = dicom_store_id unless dicom_store_id.nil?
490
+ command.query['fields'] = fields unless fields.nil?
491
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
492
+ execute_or_queue_command(command, &block)
493
+ end
494
+
495
+ # De-identifies data from the source store and writes it to the destination
496
+ # store. The metadata field type is OperationMetadata. If the request is
497
+ # successful, the response field type is DeidentifyDicomStoreSummary. If errors
498
+ # occur, error is set. The LRO result may still be successful if de-
499
+ # identification fails for some DICOM instances. The output DICOM store will not
500
+ # contain these failed resources. Failed resource totals are tracked in
501
+ # Operation.metadata. Error details are also logged to Cloud Logging (see [
502
+ # Viewing logs](/healthcare/docs/how-tos/logging)).
503
+ # @param [String] source_store
504
+ # Source DICOM store resource name. For example, `projects/`project_id`/
505
+ # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
506
+ # @param [Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object
507
+ # @param [String] fields
508
+ # Selector specifying which fields to include in a partial response.
509
+ # @param [String] quota_user
510
+ # Available to use for quota purposes for server-side applications. Can be any
511
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
512
+ # @param [Google::Apis::RequestOptions] options
513
+ # Request-specific options
514
+ #
515
+ # @yield [result, err] Result & error if block supplied
516
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
517
+ # @yieldparam err [StandardError] error object if request failed
518
+ #
519
+ # @return [Google::Apis::HealthcareV1::Operation]
520
+ #
521
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
522
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
523
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
524
+ def deidentify_dicom_store(source_store, deidentify_dicom_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
525
+ command = make_simple_command(:post, 'v1/{+sourceStore}:deidentify', options)
526
+ command.request_representation = Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest::Representation
527
+ command.request_object = deidentify_dicom_store_request_object
528
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
529
+ command.response_class = Google::Apis::HealthcareV1::Operation
530
+ command.params['sourceStore'] = source_store unless source_store.nil?
531
+ command.query['fields'] = fields unless fields.nil?
532
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
533
+ execute_or_queue_command(command, &block)
534
+ end
535
+
536
+ # Deletes the specified DICOM store and removes all images that are contained
537
+ # within it.
538
+ # @param [String] name
539
+ # The resource name of the DICOM store to delete.
540
+ # @param [String] fields
541
+ # Selector specifying which fields to include in a partial response.
542
+ # @param [String] quota_user
543
+ # Available to use for quota purposes for server-side applications. Can be any
544
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
545
+ # @param [Google::Apis::RequestOptions] options
546
+ # Request-specific options
547
+ #
548
+ # @yield [result, err] Result & error if block supplied
549
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
550
+ # @yieldparam err [StandardError] error object if request failed
551
+ #
552
+ # @return [Google::Apis::HealthcareV1::Empty]
553
+ #
554
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
555
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
556
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
557
+ def delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
558
+ command = make_simple_command(:delete, 'v1/{+name}', options)
559
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
560
+ command.response_class = Google::Apis::HealthcareV1::Empty
561
+ command.params['name'] = name unless name.nil?
562
+ command.query['fields'] = fields unless fields.nil?
563
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
564
+ execute_or_queue_command(command, &block)
565
+ end
566
+
567
+ # Exports data to the specified destination by copying it from the DICOM store.
568
+ # Errors are also logged to Cloud Logging. For more information, see [Viewing
569
+ # logs](/healthcare/docs/how-tos/logging). The metadata field type is
570
+ # OperationMetadata.
571
+ # @param [String] name
572
+ # The DICOM store resource name from which to export the data. For example, `
573
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
574
+ # dicomStores/`dicom_store_id``.
575
+ # @param [Google::Apis::HealthcareV1::ExportDicomDataRequest] export_dicom_data_request_object
576
+ # @param [String] fields
577
+ # Selector specifying which fields to include in a partial response.
578
+ # @param [String] quota_user
579
+ # Available to use for quota purposes for server-side applications. Can be any
580
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
581
+ # @param [Google::Apis::RequestOptions] options
582
+ # Request-specific options
583
+ #
584
+ # @yield [result, err] Result & error if block supplied
585
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
586
+ # @yieldparam err [StandardError] error object if request failed
587
+ #
588
+ # @return [Google::Apis::HealthcareV1::Operation]
589
+ #
590
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
591
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
592
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
593
+ def export_dicom_store_dicom_data(name, export_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
594
+ command = make_simple_command(:post, 'v1/{+name}:export', options)
595
+ command.request_representation = Google::Apis::HealthcareV1::ExportDicomDataRequest::Representation
596
+ command.request_object = export_dicom_data_request_object
597
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
598
+ command.response_class = Google::Apis::HealthcareV1::Operation
599
+ command.params['name'] = name unless name.nil?
600
+ command.query['fields'] = fields unless fields.nil?
601
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
602
+ execute_or_queue_command(command, &block)
603
+ end
604
+
605
+ # Gets the specified DICOM store.
606
+ # @param [String] name
607
+ # The resource name of the DICOM store to get.
608
+ # @param [String] fields
609
+ # Selector specifying which fields to include in a partial response.
610
+ # @param [String] quota_user
611
+ # Available to use for quota purposes for server-side applications. Can be any
612
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
613
+ # @param [Google::Apis::RequestOptions] options
614
+ # Request-specific options
615
+ #
616
+ # @yield [result, err] Result & error if block supplied
617
+ # @yieldparam result [Google::Apis::HealthcareV1::DicomStore] parsed result object
618
+ # @yieldparam err [StandardError] error object if request failed
619
+ #
620
+ # @return [Google::Apis::HealthcareV1::DicomStore]
621
+ #
622
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
623
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
624
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
625
+ def get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block)
626
+ command = make_simple_command(:get, 'v1/{+name}', options)
627
+ command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation
628
+ command.response_class = Google::Apis::HealthcareV1::DicomStore
629
+ command.params['name'] = name unless name.nil?
630
+ command.query['fields'] = fields unless fields.nil?
631
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
632
+ execute_or_queue_command(command, &block)
633
+ end
634
+
635
+ # Gets the access control policy for a resource. Returns an empty policy if the
636
+ # resource exists and does not have a policy set.
637
+ # @param [String] resource
638
+ # REQUIRED: The resource for which the policy is being requested. See the
639
+ # operation documentation for the appropriate value for this field.
640
+ # @param [Fixnum] options_requested_policy_version
641
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
642
+ # 3. Requests specifying an invalid value will be rejected. Requests for
643
+ # policies with any conditional bindings must specify version 3. Policies
644
+ # without any conditional bindings may specify any valid value or leave the
645
+ # field unset. To learn which resources support conditions in their IAM policies,
646
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
647
+ # resource-policies).
648
+ # @param [String] fields
649
+ # Selector specifying which fields to include in a partial response.
650
+ # @param [String] quota_user
651
+ # Available to use for quota purposes for server-side applications. Can be any
652
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
653
+ # @param [Google::Apis::RequestOptions] options
654
+ # Request-specific options
655
+ #
656
+ # @yield [result, err] Result & error if block supplied
657
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
658
+ # @yieldparam err [StandardError] error object if request failed
659
+ #
660
+ # @return [Google::Apis::HealthcareV1::Policy]
661
+ #
662
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
663
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
664
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
665
+ def get_project_location_dataset_dicom_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
666
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
667
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
668
+ command.response_class = Google::Apis::HealthcareV1::Policy
669
+ command.params['resource'] = resource unless resource.nil?
670
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
671
+ command.query['fields'] = fields unless fields.nil?
672
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
673
+ execute_or_queue_command(command, &block)
674
+ end
675
+
676
+ # Imports data into the DICOM store by copying it from the specified source.
677
+ # Errors are logged to Cloud Logging. For more information, see [Viewing logs](/
678
+ # healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.
679
+ # @param [String] name
680
+ # The name of the DICOM store resource into which the data is imported. For
681
+ # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
682
+ # dicomStores/`dicom_store_id``.
683
+ # @param [Google::Apis::HealthcareV1::ImportDicomDataRequest] import_dicom_data_request_object
684
+ # @param [String] fields
685
+ # Selector specifying which fields to include in a partial response.
686
+ # @param [String] quota_user
687
+ # Available to use for quota purposes for server-side applications. Can be any
688
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
689
+ # @param [Google::Apis::RequestOptions] options
690
+ # Request-specific options
691
+ #
692
+ # @yield [result, err] Result & error if block supplied
693
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
694
+ # @yieldparam err [StandardError] error object if request failed
695
+ #
696
+ # @return [Google::Apis::HealthcareV1::Operation]
697
+ #
698
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
699
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
700
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
701
+ def import_dicom_store_dicom_data(name, import_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
702
+ command = make_simple_command(:post, 'v1/{+name}:import', options)
703
+ command.request_representation = Google::Apis::HealthcareV1::ImportDicomDataRequest::Representation
704
+ command.request_object = import_dicom_data_request_object
705
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
706
+ command.response_class = Google::Apis::HealthcareV1::Operation
707
+ command.params['name'] = name unless name.nil?
708
+ command.query['fields'] = fields unless fields.nil?
709
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
710
+ execute_or_queue_command(command, &block)
711
+ end
712
+
713
+ # Lists the DICOM stores in the given dataset.
714
+ # @param [String] parent
715
+ # Name of the dataset.
716
+ # @param [String] filter
717
+ # Restricts stores returned to those matching a filter. Syntax: https://cloud.
718
+ # google.com/appengine/docs/standard/python/search/query_strings Only filtering
719
+ # on labels is supported. For example, `labels.key=value`.
720
+ # @param [Fixnum] page_size
721
+ # Limit on the number of DICOM stores to return in a single response. If not
722
+ # specified, 100 is used. May not be larger than 1000.
723
+ # @param [String] page_token
724
+ # The next_page_token value returned from the previous List request, if any.
725
+ # @param [String] fields
726
+ # Selector specifying which fields to include in a partial response.
727
+ # @param [String] quota_user
728
+ # Available to use for quota purposes for server-side applications. Can be any
729
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
730
+ # @param [Google::Apis::RequestOptions] options
731
+ # Request-specific options
732
+ #
733
+ # @yield [result, err] Result & error if block supplied
734
+ # @yieldparam result [Google::Apis::HealthcareV1::ListDicomStoresResponse] parsed result object
735
+ # @yieldparam err [StandardError] error object if request failed
736
+ #
737
+ # @return [Google::Apis::HealthcareV1::ListDicomStoresResponse]
738
+ #
739
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
740
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
741
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
742
+ def list_project_location_dataset_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
743
+ command = make_simple_command(:get, 'v1/{+parent}/dicomStores', options)
744
+ command.response_representation = Google::Apis::HealthcareV1::ListDicomStoresResponse::Representation
745
+ command.response_class = Google::Apis::HealthcareV1::ListDicomStoresResponse
746
+ command.params['parent'] = parent unless parent.nil?
747
+ command.query['filter'] = filter unless filter.nil?
748
+ command.query['pageSize'] = page_size unless page_size.nil?
749
+ command.query['pageToken'] = page_token unless page_token.nil?
750
+ command.query['fields'] = fields unless fields.nil?
751
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
752
+ execute_or_queue_command(command, &block)
753
+ end
754
+
755
+ # Updates the specified DICOM store.
756
+ # @param [String] name
757
+ # Resource name of the DICOM store, of the form `projects/`project_id`/locations/
758
+ # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
759
+ # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object
760
+ # @param [String] update_mask
761
+ # The update mask applies to the resource. For the `FieldMask` definition, see
762
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
763
+ # fieldmask
764
+ # @param [String] fields
765
+ # Selector specifying which fields to include in a partial response.
766
+ # @param [String] quota_user
767
+ # Available to use for quota purposes for server-side applications. Can be any
768
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
769
+ # @param [Google::Apis::RequestOptions] options
770
+ # Request-specific options
771
+ #
772
+ # @yield [result, err] Result & error if block supplied
773
+ # @yieldparam result [Google::Apis::HealthcareV1::DicomStore] parsed result object
774
+ # @yieldparam err [StandardError] error object if request failed
775
+ #
776
+ # @return [Google::Apis::HealthcareV1::DicomStore]
777
+ #
778
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
779
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
780
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
781
+ def patch_project_location_dataset_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
782
+ command = make_simple_command(:patch, 'v1/{+name}', options)
783
+ command.request_representation = Google::Apis::HealthcareV1::DicomStore::Representation
784
+ command.request_object = dicom_store_object
785
+ command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation
786
+ command.response_class = Google::Apis::HealthcareV1::DicomStore
787
+ command.params['name'] = name unless name.nil?
788
+ command.query['updateMask'] = update_mask unless update_mask.nil?
789
+ command.query['fields'] = fields unless fields.nil?
790
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
791
+ execute_or_queue_command(command, &block)
792
+ end
793
+
794
+ # SearchForInstances returns a list of matching instances. See [Search
795
+ # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.
796
+ # html#sect_10.6). For details on the implementation of SearchForInstances, see [
797
+ # Search transaction](https://cloud.google.com/healthcare/docs/dicom#
798
+ # search_transaction) in the Cloud Healthcare API conformance statement. For
799
+ # samples that show how to call SearchForInstances, see [Searching for studies,
800
+ # series, instances, and frames](https://cloud.google.com/healthcare/docs/how-
801
+ # tos/dicomweb#searching_for_studies_series_instances_and_frames).
802
+ # @param [String] parent
803
+ # The name of the DICOM store that is being accessed. For example, `projects/`
804
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
805
+ # dicom_store_id``.
806
+ # @param [String] dicom_web_path
807
+ # The path of the SearchForInstancesRequest DICOMweb request. For example, `
808
+ # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
809
+ # .
810
+ # @param [String] fields
811
+ # Selector specifying which fields to include in a partial response.
812
+ # @param [String] quota_user
813
+ # Available to use for quota purposes for server-side applications. Can be any
814
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
815
+ # @param [Google::Apis::RequestOptions] options
816
+ # Request-specific options
817
+ #
818
+ # @yield [result, err] Result & error if block supplied
819
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
820
+ # @yieldparam err [StandardError] error object if request failed
821
+ #
822
+ # @return [Google::Apis::HealthcareV1::HttpBody]
823
+ #
824
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
825
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
826
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
827
+ def search_project_location_dataset_dicom_store_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
828
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
829
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
830
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
831
+ command.params['parent'] = parent unless parent.nil?
832
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
833
+ command.query['fields'] = fields unless fields.nil?
834
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
835
+ execute_or_queue_command(command, &block)
836
+ end
837
+
838
+ # SearchForSeries returns a list of matching series. See [Search Transaction] (
839
+ # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6).
840
+ # For details on the implementation of SearchForSeries, see [Search transaction]
841
+ # (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the
842
+ # Cloud Healthcare API conformance statement. For samples that show how to call
843
+ # SearchForSeries, see [Searching for studies, series, instances, and frames](
844
+ # https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
845
+ # searching_for_studies_series_instances_and_frames).
846
+ # @param [String] parent
847
+ # The name of the DICOM store that is being accessed. For example, `projects/`
848
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
849
+ # dicom_store_id``.
850
+ # @param [String] dicom_web_path
851
+ # The path of the SearchForSeries DICOMweb request. For example, `series` or `
852
+ # studies/`study_uid`/series`.
853
+ # @param [String] fields
854
+ # Selector specifying which fields to include in a partial response.
855
+ # @param [String] quota_user
856
+ # Available to use for quota purposes for server-side applications. Can be any
857
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
858
+ # @param [Google::Apis::RequestOptions] options
859
+ # Request-specific options
860
+ #
861
+ # @yield [result, err] Result & error if block supplied
862
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
863
+ # @yieldparam err [StandardError] error object if request failed
864
+ #
865
+ # @return [Google::Apis::HealthcareV1::HttpBody]
866
+ #
867
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
868
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
869
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
870
+ def search_project_location_dataset_dicom_store_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
871
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
872
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
873
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
874
+ command.params['parent'] = parent unless parent.nil?
875
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
876
+ command.query['fields'] = fields unless fields.nil?
877
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
878
+ execute_or_queue_command(command, &block)
879
+ end
880
+
881
+ # SearchForStudies returns a list of matching studies. See [Search Transaction] (
882
+ # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6).
883
+ # For details on the implementation of SearchForStudies, see [Search
884
+ # transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction)
885
+ # in the Cloud Healthcare API conformance statement. For samples that show how
886
+ # to call SearchForStudies, see [Searching for studies, series, instances, and
887
+ # frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
888
+ # searching_for_studies_series_instances_and_frames).
889
+ # @param [String] parent
890
+ # The name of the DICOM store that is being accessed. For example, `projects/`
891
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
892
+ # dicom_store_id``.
893
+ # @param [String] dicom_web_path
894
+ # The path of the SearchForStudies DICOMweb request. For example, `studies`.
895
+ # @param [String] fields
896
+ # Selector specifying which fields to include in a partial response.
897
+ # @param [String] quota_user
898
+ # Available to use for quota purposes for server-side applications. Can be any
899
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
900
+ # @param [Google::Apis::RequestOptions] options
901
+ # Request-specific options
902
+ #
903
+ # @yield [result, err] Result & error if block supplied
904
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
905
+ # @yieldparam err [StandardError] error object if request failed
906
+ #
907
+ # @return [Google::Apis::HealthcareV1::HttpBody]
908
+ #
909
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
910
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
911
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
912
+ def search_project_location_dataset_dicom_store_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
913
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
914
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
915
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
916
+ command.params['parent'] = parent unless parent.nil?
917
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
918
+ command.query['fields'] = fields unless fields.nil?
919
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
920
+ execute_or_queue_command(command, &block)
921
+ end
922
+
923
+ # Sets the access control policy on the specified resource. Replaces any
924
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
925
+ # PERMISSION_DENIED` errors.
926
+ # @param [String] resource
927
+ # REQUIRED: The resource for which the policy is being specified. See the
928
+ # operation documentation for the appropriate value for this field.
929
+ # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object
930
+ # @param [String] fields
931
+ # Selector specifying which fields to include in a partial response.
932
+ # @param [String] quota_user
933
+ # Available to use for quota purposes for server-side applications. Can be any
934
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
935
+ # @param [Google::Apis::RequestOptions] options
936
+ # Request-specific options
937
+ #
938
+ # @yield [result, err] Result & error if block supplied
939
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
940
+ # @yieldparam err [StandardError] error object if request failed
941
+ #
942
+ # @return [Google::Apis::HealthcareV1::Policy]
943
+ #
944
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
945
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
946
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
947
+ def set_dicom_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
948
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
949
+ command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
950
+ command.request_object = set_iam_policy_request_object
951
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
952
+ command.response_class = Google::Apis::HealthcareV1::Policy
953
+ command.params['resource'] = resource unless resource.nil?
954
+ command.query['fields'] = fields unless fields.nil?
955
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
956
+ execute_or_queue_command(command, &block)
957
+ end
958
+
959
+ # StoreInstances stores DICOM instances associated with study instance unique
960
+ # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/
961
+ # dicom/current/output/html/part18.html#sect_10.5). For details on the
962
+ # implementation of StoreInstances, see [Store transaction](https://cloud.google.
963
+ # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API
964
+ # conformance statement. For samples that show how to call StoreInstances, see [
965
+ # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
966
+ # storing_dicom_data).
967
+ # @param [String] parent
968
+ # The name of the DICOM store that is being accessed. For example, `projects/`
969
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
970
+ # dicom_store_id``.
971
+ # @param [String] dicom_web_path
972
+ # The path of the StoreInstances DICOMweb request. For example, `studies/[`
973
+ # study_uid`]`. Note that the `study_uid` is optional.
974
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
975
+ # @param [String] fields
976
+ # Selector specifying which fields to include in a partial response.
977
+ # @param [String] quota_user
978
+ # Available to use for quota purposes for server-side applications. Can be any
979
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
980
+ # @param [Google::Apis::RequestOptions] options
981
+ # Request-specific options
982
+ #
983
+ # @yield [result, err] Result & error if block supplied
984
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
985
+ # @yieldparam err [StandardError] error object if request failed
986
+ #
987
+ # @return [Google::Apis::HealthcareV1::HttpBody]
988
+ #
989
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
990
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
991
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
992
+ def store_project_location_dataset_dicom_store_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
993
+ command = make_simple_command(:post, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
994
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
995
+ command.request_object = http_body_object
996
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
997
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
998
+ command.params['parent'] = parent unless parent.nil?
999
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1000
+ command.query['fields'] = fields unless fields.nil?
1001
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1002
+ execute_or_queue_command(command, &block)
1003
+ end
1004
+
1005
+ # Returns permissions that a caller has on the specified resource. If the
1006
+ # resource does not exist, this will return an empty set of permissions, not a `
1007
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
1008
+ # permission-aware UIs and command-line tools, not for authorization checking.
1009
+ # This operation may "fail open" without warning.
1010
+ # @param [String] resource
1011
+ # REQUIRED: The resource for which the policy detail is being requested. See the
1012
+ # operation documentation for the appropriate value for this field.
1013
+ # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object
1014
+ # @param [String] fields
1015
+ # Selector specifying which fields to include in a partial response.
1016
+ # @param [String] quota_user
1017
+ # Available to use for quota purposes for server-side applications. Can be any
1018
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1019
+ # @param [Google::Apis::RequestOptions] options
1020
+ # Request-specific options
1021
+ #
1022
+ # @yield [result, err] Result & error if block supplied
1023
+ # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
1024
+ # @yieldparam err [StandardError] error object if request failed
1025
+ #
1026
+ # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
1027
+ #
1028
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1029
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1030
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1031
+ def test_dicom_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1032
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
1033
+ command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
1034
+ command.request_object = test_iam_permissions_request_object
1035
+ command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
1036
+ command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
1037
+ command.params['resource'] = resource unless resource.nil?
1038
+ command.query['fields'] = fields unless fields.nil?
1039
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1040
+ execute_or_queue_command(command, &block)
1041
+ end
1042
+
1043
+ # DeleteStudy deletes all instances within the given study. Delete requests are
1044
+ # equivalent to the GET requests specified in the Retrieve transaction. The
1045
+ # method returns an Operation which will be marked successful when the deletion
1046
+ # is complete. Warning: Inserting instances into a study while a delete
1047
+ # operation is running for that study could result in the new instances not
1048
+ # appearing in search results until the deletion operation finishes. For samples
1049
+ # that show how to call DeleteStudy, see [Deleting a study, series, or instance](
1050
+ # https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
1051
+ # deleting_a_study_series_or_instance).
1052
+ # @param [String] parent
1053
+ # @param [String] dicom_web_path
1054
+ # The path of the DeleteStudy request. For example, `studies/`study_uid``.
1055
+ # @param [String] fields
1056
+ # Selector specifying which fields to include in a partial response.
1057
+ # @param [String] quota_user
1058
+ # Available to use for quota purposes for server-side applications. Can be any
1059
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1060
+ # @param [Google::Apis::RequestOptions] options
1061
+ # Request-specific options
1062
+ #
1063
+ # @yield [result, err] Result & error if block supplied
1064
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
1065
+ # @yieldparam err [StandardError] error object if request failed
1066
+ #
1067
+ # @return [Google::Apis::HealthcareV1::Operation]
1068
+ #
1069
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1070
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1071
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1072
+ def delete_project_location_dataset_dicom_store_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1073
+ command = make_simple_command(:delete, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1074
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
1075
+ command.response_class = Google::Apis::HealthcareV1::Operation
1076
+ command.params['parent'] = parent unless parent.nil?
1077
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1078
+ command.query['fields'] = fields unless fields.nil?
1079
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1080
+ execute_or_queue_command(command, &block)
1081
+ end
1082
+
1083
+ # RetrieveStudyMetadata returns instance associated with the given study
1084
+ # presented as metadata with the bulk data removed. See [RetrieveTransaction] (
1085
+ # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).
1086
+ # For details on the implementation of RetrieveStudyMetadata, see [Metadata
1087
+ # resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources)
1088
+ # in the Cloud Healthcare API conformance statement. For samples that show how
1089
+ # to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.
1090
+ # com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).
1091
+ # @param [String] parent
1092
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1093
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1094
+ # dicom_store_id``.
1095
+ # @param [String] dicom_web_path
1096
+ # The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/`
1097
+ # study_uid`/metadata`.
1098
+ # @param [String] fields
1099
+ # Selector specifying which fields to include in a partial response.
1100
+ # @param [String] quota_user
1101
+ # Available to use for quota purposes for server-side applications. Can be any
1102
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1103
+ # @param [Google::Apis::RequestOptions] options
1104
+ # Request-specific options
1105
+ #
1106
+ # @yield [result, err] Result & error if block supplied
1107
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1108
+ # @yieldparam err [StandardError] error object if request failed
1109
+ #
1110
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1111
+ #
1112
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1113
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1114
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1115
+ def retrieve_project_location_dataset_dicom_store_study_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1116
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1117
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1118
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1119
+ command.params['parent'] = parent unless parent.nil?
1120
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1121
+ command.query['fields'] = fields unless fields.nil?
1122
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1123
+ execute_or_queue_command(command, &block)
1124
+ end
1125
+
1126
+ # RetrieveStudy returns all instances within the given study. See [
1127
+ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/
1128
+ # part18.html#sect_10.4). For details on the implementation of RetrieveStudy,
1129
+ # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/
1130
+ # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance
1131
+ # statement. For samples that show how to call RetrieveStudy, see [Retrieving
1132
+ # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
1133
+ # retrieving_dicom_data).
1134
+ # @param [String] parent
1135
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1136
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1137
+ # dicom_store_id``.
1138
+ # @param [String] dicom_web_path
1139
+ # The path of the RetrieveStudy DICOMweb request. For example, `studies/`
1140
+ # study_uid``.
1141
+ # @param [String] fields
1142
+ # Selector specifying which fields to include in a partial response.
1143
+ # @param [String] quota_user
1144
+ # Available to use for quota purposes for server-side applications. Can be any
1145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1146
+ # @param [Google::Apis::RequestOptions] options
1147
+ # Request-specific options
1148
+ #
1149
+ # @yield [result, err] Result & error if block supplied
1150
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1151
+ # @yieldparam err [StandardError] error object if request failed
1152
+ #
1153
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1154
+ #
1155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1158
+ def retrieve_project_location_dataset_dicom_store_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1159
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1160
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1161
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1162
+ command.params['parent'] = parent unless parent.nil?
1163
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1164
+ command.query['fields'] = fields unless fields.nil?
1165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1166
+ execute_or_queue_command(command, &block)
1167
+ end
1168
+
1169
+ # SearchForInstances returns a list of matching instances. See [Search
1170
+ # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.
1171
+ # html#sect_10.6). For details on the implementation of SearchForInstances, see [
1172
+ # Search transaction](https://cloud.google.com/healthcare/docs/dicom#
1173
+ # search_transaction) in the Cloud Healthcare API conformance statement. For
1174
+ # samples that show how to call SearchForInstances, see [Searching for studies,
1175
+ # series, instances, and frames](https://cloud.google.com/healthcare/docs/how-
1176
+ # tos/dicomweb#searching_for_studies_series_instances_and_frames).
1177
+ # @param [String] parent
1178
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1179
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1180
+ # dicom_store_id``.
1181
+ # @param [String] dicom_web_path
1182
+ # The path of the SearchForInstancesRequest DICOMweb request. For example, `
1183
+ # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
1184
+ # .
1185
+ # @param [String] fields
1186
+ # Selector specifying which fields to include in a partial response.
1187
+ # @param [String] quota_user
1188
+ # Available to use for quota purposes for server-side applications. Can be any
1189
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1190
+ # @param [Google::Apis::RequestOptions] options
1191
+ # Request-specific options
1192
+ #
1193
+ # @yield [result, err] Result & error if block supplied
1194
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1195
+ # @yieldparam err [StandardError] error object if request failed
1196
+ #
1197
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1198
+ #
1199
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1200
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1201
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1202
+ def search_project_location_dataset_dicom_store_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1203
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1204
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1205
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1206
+ command.params['parent'] = parent unless parent.nil?
1207
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1208
+ command.query['fields'] = fields unless fields.nil?
1209
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1210
+ execute_or_queue_command(command, &block)
1211
+ end
1212
+
1213
+ # SearchForSeries returns a list of matching series. See [Search Transaction] (
1214
+ # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6).
1215
+ # For details on the implementation of SearchForSeries, see [Search transaction]
1216
+ # (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the
1217
+ # Cloud Healthcare API conformance statement. For samples that show how to call
1218
+ # SearchForSeries, see [Searching for studies, series, instances, and frames](
1219
+ # https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
1220
+ # searching_for_studies_series_instances_and_frames).
1221
+ # @param [String] parent
1222
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1223
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1224
+ # dicom_store_id``.
1225
+ # @param [String] dicom_web_path
1226
+ # The path of the SearchForSeries DICOMweb request. For example, `series` or `
1227
+ # studies/`study_uid`/series`.
1228
+ # @param [String] fields
1229
+ # Selector specifying which fields to include in a partial response.
1230
+ # @param [String] quota_user
1231
+ # Available to use for quota purposes for server-side applications. Can be any
1232
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1233
+ # @param [Google::Apis::RequestOptions] options
1234
+ # Request-specific options
1235
+ #
1236
+ # @yield [result, err] Result & error if block supplied
1237
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1238
+ # @yieldparam err [StandardError] error object if request failed
1239
+ #
1240
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1241
+ #
1242
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1243
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1244
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1245
+ def search_project_location_dataset_dicom_store_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1246
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1247
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1248
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1249
+ command.params['parent'] = parent unless parent.nil?
1250
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1251
+ command.query['fields'] = fields unless fields.nil?
1252
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1253
+ execute_or_queue_command(command, &block)
1254
+ end
1255
+
1256
+ # StoreInstances stores DICOM instances associated with study instance unique
1257
+ # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/
1258
+ # dicom/current/output/html/part18.html#sect_10.5). For details on the
1259
+ # implementation of StoreInstances, see [Store transaction](https://cloud.google.
1260
+ # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API
1261
+ # conformance statement. For samples that show how to call StoreInstances, see [
1262
+ # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
1263
+ # storing_dicom_data).
1264
+ # @param [String] parent
1265
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1266
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1267
+ # dicom_store_id``.
1268
+ # @param [String] dicom_web_path
1269
+ # The path of the StoreInstances DICOMweb request. For example, `studies/[`
1270
+ # study_uid`]`. Note that the `study_uid` is optional.
1271
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
1272
+ # @param [String] fields
1273
+ # Selector specifying which fields to include in a partial response.
1274
+ # @param [String] quota_user
1275
+ # Available to use for quota purposes for server-side applications. Can be any
1276
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1277
+ # @param [Google::Apis::RequestOptions] options
1278
+ # Request-specific options
1279
+ #
1280
+ # @yield [result, err] Result & error if block supplied
1281
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1282
+ # @yieldparam err [StandardError] error object if request failed
1283
+ #
1284
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1285
+ #
1286
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1287
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1288
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1289
+ def store_project_location_dataset_dicom_store_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1290
+ command = make_simple_command(:post, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1291
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1292
+ command.request_object = http_body_object
1293
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1294
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1295
+ command.params['parent'] = parent unless parent.nil?
1296
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1297
+ command.query['fields'] = fields unless fields.nil?
1298
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1299
+ execute_or_queue_command(command, &block)
1300
+ end
1301
+
1302
+ # DeleteSeries deletes all instances within the given study and series. Delete
1303
+ # requests are equivalent to the GET requests specified in the Retrieve
1304
+ # transaction. The method returns an Operation which will be marked successful
1305
+ # when the deletion is complete. Warning: Inserting instances into a series
1306
+ # while a delete operation is running for that series could result in the new
1307
+ # instances not appearing in search results until the deletion operation
1308
+ # finishes. For samples that show how to call DeleteSeries, see [Deleting a
1309
+ # study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/
1310
+ # dicomweb#deleting_a_study_series_or_instance).
1311
+ # @param [String] parent
1312
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1313
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1314
+ # dicom_store_id``.
1315
+ # @param [String] dicom_web_path
1316
+ # The path of the DeleteSeries request. For example, `studies/`study_uid`/series/
1317
+ # `series_uid``.
1318
+ # @param [String] fields
1319
+ # Selector specifying which fields to include in a partial response.
1320
+ # @param [String] quota_user
1321
+ # Available to use for quota purposes for server-side applications. Can be any
1322
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1323
+ # @param [Google::Apis::RequestOptions] options
1324
+ # Request-specific options
1325
+ #
1326
+ # @yield [result, err] Result & error if block supplied
1327
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
1328
+ # @yieldparam err [StandardError] error object if request failed
1329
+ #
1330
+ # @return [Google::Apis::HealthcareV1::Operation]
1331
+ #
1332
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1333
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1334
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1335
+ def delete_project_location_dataset_dicom_store_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1336
+ command = make_simple_command(:delete, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1337
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
1338
+ command.response_class = Google::Apis::HealthcareV1::Operation
1339
+ command.params['parent'] = parent unless parent.nil?
1340
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1341
+ command.query['fields'] = fields unless fields.nil?
1342
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1343
+ execute_or_queue_command(command, &block)
1344
+ end
1345
+
1346
+ # RetrieveSeriesMetadata returns instance associated with the given study and
1347
+ # series, presented as metadata with the bulk data removed. See [
1348
+ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/
1349
+ # part18.html#sect_10.4). For details on the implementation of
1350
+ # RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/
1351
+ # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API
1352
+ # conformance statement. For samples that show how to call
1353
+ # RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/
1354
+ # healthcare/docs/how-tos/dicomweb#retrieving_metadata).
1355
+ # @param [String] parent
1356
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1357
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1358
+ # dicom_store_id``.
1359
+ # @param [String] dicom_web_path
1360
+ # The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/
1361
+ # `study_uid`/series/`series_uid`/metadata`.
1362
+ # @param [String] fields
1363
+ # Selector specifying which fields to include in a partial response.
1364
+ # @param [String] quota_user
1365
+ # Available to use for quota purposes for server-side applications. Can be any
1366
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1367
+ # @param [Google::Apis::RequestOptions] options
1368
+ # Request-specific options
1369
+ #
1370
+ # @yield [result, err] Result & error if block supplied
1371
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1372
+ # @yieldparam err [StandardError] error object if request failed
1373
+ #
1374
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1375
+ #
1376
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1377
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1378
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1379
+ def retrieve_project_location_dataset_dicom_store_study_series_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1380
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1381
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1382
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1383
+ command.params['parent'] = parent unless parent.nil?
1384
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1385
+ command.query['fields'] = fields unless fields.nil?
1386
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1387
+ execute_or_queue_command(command, &block)
1388
+ end
1389
+
1390
+ # RetrieveSeries returns all instances within the given study and series. See [
1391
+ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/
1392
+ # part18.html#sect_10.4). For details on the implementation of RetrieveSeries,
1393
+ # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/
1394
+ # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance
1395
+ # statement. For samples that show how to call RetrieveSeries, see [Retrieving
1396
+ # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
1397
+ # retrieving_dicom_data).
1398
+ # @param [String] parent
1399
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1400
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1401
+ # dicom_store_id``.
1402
+ # @param [String] dicom_web_path
1403
+ # The path of the RetrieveSeries DICOMweb request. For example, `studies/`
1404
+ # study_uid`/series/`series_uid``.
1405
+ # @param [String] fields
1406
+ # Selector specifying which fields to include in a partial response.
1407
+ # @param [String] quota_user
1408
+ # Available to use for quota purposes for server-side applications. Can be any
1409
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1410
+ # @param [Google::Apis::RequestOptions] options
1411
+ # Request-specific options
1412
+ #
1413
+ # @yield [result, err] Result & error if block supplied
1414
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1415
+ # @yieldparam err [StandardError] error object if request failed
1416
+ #
1417
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1418
+ #
1419
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1420
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1421
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1422
+ def retrieve_project_location_dataset_dicom_store_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1423
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1424
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1425
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1426
+ command.params['parent'] = parent unless parent.nil?
1427
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1428
+ command.query['fields'] = fields unless fields.nil?
1429
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1430
+ execute_or_queue_command(command, &block)
1431
+ end
1432
+
1433
+ # SearchForInstances returns a list of matching instances. See [Search
1434
+ # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.
1435
+ # html#sect_10.6). For details on the implementation of SearchForInstances, see [
1436
+ # Search transaction](https://cloud.google.com/healthcare/docs/dicom#
1437
+ # search_transaction) in the Cloud Healthcare API conformance statement. For
1438
+ # samples that show how to call SearchForInstances, see [Searching for studies,
1439
+ # series, instances, and frames](https://cloud.google.com/healthcare/docs/how-
1440
+ # tos/dicomweb#searching_for_studies_series_instances_and_frames).
1441
+ # @param [String] parent
1442
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1443
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1444
+ # dicom_store_id``.
1445
+ # @param [String] dicom_web_path
1446
+ # The path of the SearchForInstancesRequest DICOMweb request. For example, `
1447
+ # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
1448
+ # .
1449
+ # @param [String] fields
1450
+ # Selector specifying which fields to include in a partial response.
1451
+ # @param [String] quota_user
1452
+ # Available to use for quota purposes for server-side applications. Can be any
1453
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1454
+ # @param [Google::Apis::RequestOptions] options
1455
+ # Request-specific options
1456
+ #
1457
+ # @yield [result, err] Result & error if block supplied
1458
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1459
+ # @yieldparam err [StandardError] error object if request failed
1460
+ #
1461
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1462
+ #
1463
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1464
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1465
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1466
+ def search_project_location_dataset_dicom_store_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1467
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1468
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1469
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1470
+ command.params['parent'] = parent unless parent.nil?
1471
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1472
+ command.query['fields'] = fields unless fields.nil?
1473
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1474
+ execute_or_queue_command(command, &block)
1475
+ end
1476
+
1477
+ # DeleteInstance deletes an instance associated with the given study, series,
1478
+ # and SOP Instance UID. Delete requests are equivalent to the GET requests
1479
+ # specified in the Retrieve transaction. Study and series search results can
1480
+ # take a few seconds to be updated after an instance is deleted using
1481
+ # DeleteInstance. For samples that show how to call DeleteInstance, see [
1482
+ # Deleting a study, series, or instance](https://cloud.google.com/healthcare/
1483
+ # docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
1484
+ # @param [String] parent
1485
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1486
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1487
+ # dicom_store_id``.
1488
+ # @param [String] dicom_web_path
1489
+ # The path of the DeleteInstance request. For example, `studies/`study_uid`/
1490
+ # series/`series_uid`/instances/`instance_uid``.
1491
+ # @param [String] fields
1492
+ # Selector specifying which fields to include in a partial response.
1493
+ # @param [String] quota_user
1494
+ # Available to use for quota purposes for server-side applications. Can be any
1495
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1496
+ # @param [Google::Apis::RequestOptions] options
1497
+ # Request-specific options
1498
+ #
1499
+ # @yield [result, err] Result & error if block supplied
1500
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1501
+ # @yieldparam err [StandardError] error object if request failed
1502
+ #
1503
+ # @return [Google::Apis::HealthcareV1::Empty]
1504
+ #
1505
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1506
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1507
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1508
+ def delete_project_location_dataset_dicom_store_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1509
+ command = make_simple_command(:delete, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1510
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
1511
+ command.response_class = Google::Apis::HealthcareV1::Empty
1512
+ command.params['parent'] = parent unless parent.nil?
1513
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1514
+ command.query['fields'] = fields unless fields.nil?
1515
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1516
+ execute_or_queue_command(command, &block)
1517
+ end
1518
+
1519
+ # RetrieveInstance returns instance associated with the given study, series, and
1520
+ # SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/
1521
+ # dicom/current/output/html/part18.html#sect_10.4). For details on the
1522
+ # implementation of RetrieveInstance, see [DICOM study/series/instances](https://
1523
+ # cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM
1524
+ # instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in
1525
+ # the Cloud Healthcare API conformance statement. For samples that show how to
1526
+ # call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/
1527
+ # healthcare/docs/how-tos/dicomweb#retrieving_an_instance).
1528
+ # @param [String] parent
1529
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1530
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1531
+ # dicom_store_id``.
1532
+ # @param [String] dicom_web_path
1533
+ # The path of the RetrieveInstance DICOMweb request. For example, `studies/`
1534
+ # study_uid`/series/`series_uid`/instances/`instance_uid``.
1535
+ # @param [String] fields
1536
+ # Selector specifying which fields to include in a partial response.
1537
+ # @param [String] quota_user
1538
+ # Available to use for quota purposes for server-side applications. Can be any
1539
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1540
+ # @param [Google::Apis::RequestOptions] options
1541
+ # Request-specific options
1542
+ #
1543
+ # @yield [result, err] Result & error if block supplied
1544
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1545
+ # @yieldparam err [StandardError] error object if request failed
1546
+ #
1547
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1548
+ #
1549
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1550
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1551
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1552
+ def retrieve_project_location_dataset_dicom_store_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1553
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1554
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1555
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1556
+ command.params['parent'] = parent unless parent.nil?
1557
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1558
+ command.query['fields'] = fields unless fields.nil?
1559
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1560
+ execute_or_queue_command(command, &block)
1561
+ end
1562
+
1563
+ # RetrieveInstanceMetadata returns instance associated with the given study,
1564
+ # series, and SOP Instance UID presented as metadata with the bulk data removed.
1565
+ # See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/
1566
+ # html/part18.html#sect_10.4). For details on the implementation of
1567
+ # RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/
1568
+ # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API
1569
+ # conformance statement. For samples that show how to call
1570
+ # RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/
1571
+ # healthcare/docs/how-tos/dicomweb#retrieving_metadata).
1572
+ # @param [String] parent
1573
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1574
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1575
+ # dicom_store_id``.
1576
+ # @param [String] dicom_web_path
1577
+ # The path of the RetrieveInstanceMetadata DICOMweb request. For example, `
1578
+ # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`.
1579
+ # @param [String] fields
1580
+ # Selector specifying which fields to include in a partial response.
1581
+ # @param [String] quota_user
1582
+ # Available to use for quota purposes for server-side applications. Can be any
1583
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1584
+ # @param [Google::Apis::RequestOptions] options
1585
+ # Request-specific options
1586
+ #
1587
+ # @yield [result, err] Result & error if block supplied
1588
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1589
+ # @yieldparam err [StandardError] error object if request failed
1590
+ #
1591
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1592
+ #
1593
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1594
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1595
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1596
+ def retrieve_project_location_dataset_dicom_store_study_series_instance_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1597
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1598
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1599
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1600
+ command.params['parent'] = parent unless parent.nil?
1601
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1602
+ command.query['fields'] = fields unless fields.nil?
1603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1604
+ execute_or_queue_command(command, &block)
1605
+ end
1606
+
1607
+ # RetrieveRenderedInstance returns instance associated with the given study,
1608
+ # series, and SOP Instance UID in an acceptable Rendered Media Type. See [
1609
+ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/
1610
+ # part18.html#sect_10.4). For details on the implementation of
1611
+ # RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/
1612
+ # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API
1613
+ # conformance statement. For samples that show how to call
1614
+ # RetrieveRenderedInstance, see [Retrieving consumer image formats](https://
1615
+ # cloud.google.com/healthcare/docs/how-tos/dicomweb#
1616
+ # retrieving_consumer_image_formats).
1617
+ # @param [String] parent
1618
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1619
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1620
+ # dicom_store_id``.
1621
+ # @param [String] dicom_web_path
1622
+ # The path of the RetrieveRenderedInstance DICOMweb request. For example, `
1623
+ # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`.
1624
+ # @param [String] fields
1625
+ # Selector specifying which fields to include in a partial response.
1626
+ # @param [String] quota_user
1627
+ # Available to use for quota purposes for server-side applications. Can be any
1628
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1629
+ # @param [Google::Apis::RequestOptions] options
1630
+ # Request-specific options
1631
+ #
1632
+ # @yield [result, err] Result & error if block supplied
1633
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1634
+ # @yieldparam err [StandardError] error object if request failed
1635
+ #
1636
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1637
+ #
1638
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1639
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1640
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1641
+ def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1642
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1643
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1644
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1645
+ command.params['parent'] = parent unless parent.nil?
1646
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1647
+ command.query['fields'] = fields unless fields.nil?
1648
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1649
+ execute_or_queue_command(command, &block)
1650
+ end
1651
+
1652
+ # RetrieveFrames returns instances associated with the given study, series, SOP
1653
+ # Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.
1654
+ # org/medical/dicom/current/output/html/part18.html#sect_10.4`. For details on
1655
+ # the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.
1656
+ # com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API
1657
+ # conformance statement. For samples that show how to call RetrieveFrames, see [
1658
+ # Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/
1659
+ # dicomweb#retrieving_dicom_data).
1660
+ # @param [String] parent
1661
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1662
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1663
+ # dicom_store_id``.
1664
+ # @param [String] dicom_web_path
1665
+ # The path of the RetrieveFrames DICOMweb request. For example, `studies/`
1666
+ # study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list``.
1667
+ # @param [String] fields
1668
+ # Selector specifying which fields to include in a partial response.
1669
+ # @param [String] quota_user
1670
+ # Available to use for quota purposes for server-side applications. Can be any
1671
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1672
+ # @param [Google::Apis::RequestOptions] options
1673
+ # Request-specific options
1674
+ #
1675
+ # @yield [result, err] Result & error if block supplied
1676
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1677
+ # @yieldparam err [StandardError] error object if request failed
1678
+ #
1679
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1680
+ #
1681
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1682
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1683
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1684
+ def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1685
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1686
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1687
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1688
+ command.params['parent'] = parent unless parent.nil?
1689
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1690
+ command.query['fields'] = fields unless fields.nil?
1691
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1692
+ execute_or_queue_command(command, &block)
1693
+ end
1694
+
1695
+ # RetrieveRenderedFrames returns instances associated with the given study,
1696
+ # series, SOP Instance UID and frame numbers in an acceptable Rendered Media
1697
+ # Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/
1698
+ # output/html/part18.html#sect_10.4). For details on the implementation of
1699
+ # RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/
1700
+ # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API
1701
+ # conformance statement. For samples that show how to call
1702
+ # RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.
1703
+ # google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).
1704
+ # @param [String] parent
1705
+ # The name of the DICOM store that is being accessed. For example, `projects/`
1706
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
1707
+ # dicom_store_id``.
1708
+ # @param [String] dicom_web_path
1709
+ # The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/
1710
+ # `study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list`/
1711
+ # rendered`.
1712
+ # @param [String] fields
1713
+ # Selector specifying which fields to include in a partial response.
1714
+ # @param [String] quota_user
1715
+ # Available to use for quota purposes for server-side applications. Can be any
1716
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1717
+ # @param [Google::Apis::RequestOptions] options
1718
+ # Request-specific options
1719
+ #
1720
+ # @yield [result, err] Result & error if block supplied
1721
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
1722
+ # @yieldparam err [StandardError] error object if request failed
1723
+ #
1724
+ # @return [Google::Apis::HealthcareV1::HttpBody]
1725
+ #
1726
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1727
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1728
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1729
+ def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block)
1730
+ command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options)
1731
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
1732
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
1733
+ command.params['parent'] = parent unless parent.nil?
1734
+ command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil?
1735
+ command.query['fields'] = fields unless fields.nil?
1736
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1737
+ execute_or_queue_command(command, &block)
1738
+ end
1739
+
1740
+ # Creates a new FHIR store within the parent dataset.
1741
+ # @param [String] parent
1742
+ # The name of the dataset this FHIR store belongs to.
1743
+ # @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object
1744
+ # @param [String] fhir_store_id
1745
+ # The ID of the FHIR store that is being created. The string must match the
1746
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
1747
+ # @param [String] fields
1748
+ # Selector specifying which fields to include in a partial response.
1749
+ # @param [String] quota_user
1750
+ # Available to use for quota purposes for server-side applications. Can be any
1751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1752
+ # @param [Google::Apis::RequestOptions] options
1753
+ # Request-specific options
1754
+ #
1755
+ # @yield [result, err] Result & error if block supplied
1756
+ # @yieldparam result [Google::Apis::HealthcareV1::FhirStore] parsed result object
1757
+ # @yieldparam err [StandardError] error object if request failed
1758
+ #
1759
+ # @return [Google::Apis::HealthcareV1::FhirStore]
1760
+ #
1761
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1762
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1763
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1764
+ def create_project_location_dataset_fhir_store(parent, fhir_store_object = nil, fhir_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1765
+ command = make_simple_command(:post, 'v1/{+parent}/fhirStores', options)
1766
+ command.request_representation = Google::Apis::HealthcareV1::FhirStore::Representation
1767
+ command.request_object = fhir_store_object
1768
+ command.response_representation = Google::Apis::HealthcareV1::FhirStore::Representation
1769
+ command.response_class = Google::Apis::HealthcareV1::FhirStore
1770
+ command.params['parent'] = parent unless parent.nil?
1771
+ command.query['fhirStoreId'] = fhir_store_id unless fhir_store_id.nil?
1772
+ command.query['fields'] = fields unless fields.nil?
1773
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1774
+ execute_or_queue_command(command, &block)
1775
+ end
1776
+
1777
+ # De-identifies data from the source store and writes it to the destination
1778
+ # store. The metadata field type is OperationMetadata. If the request is
1779
+ # successful, the response field type is DeidentifyFhirStoreSummary. If errors
1780
+ # occur, error is set. Error details are also logged to Cloud Logging (see [
1781
+ # Viewing logs](/healthcare/docs/how-tos/logging)).
1782
+ # @param [String] source_store
1783
+ # Source FHIR store resource name. For example, `projects/`project_id`/locations/
1784
+ # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
1785
+ # @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
1786
+ # @param [String] fields
1787
+ # Selector specifying which fields to include in a partial response.
1788
+ # @param [String] quota_user
1789
+ # Available to use for quota purposes for server-side applications. Can be any
1790
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1791
+ # @param [Google::Apis::RequestOptions] options
1792
+ # Request-specific options
1793
+ #
1794
+ # @yield [result, err] Result & error if block supplied
1795
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
1796
+ # @yieldparam err [StandardError] error object if request failed
1797
+ #
1798
+ # @return [Google::Apis::HealthcareV1::Operation]
1799
+ #
1800
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1801
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1802
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1803
+ def deidentify_fhir_store(source_store, deidentify_fhir_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1804
+ command = make_simple_command(:post, 'v1/{+sourceStore}:deidentify', options)
1805
+ command.request_representation = Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest::Representation
1806
+ command.request_object = deidentify_fhir_store_request_object
1807
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
1808
+ command.response_class = Google::Apis::HealthcareV1::Operation
1809
+ command.params['sourceStore'] = source_store unless source_store.nil?
1810
+ command.query['fields'] = fields unless fields.nil?
1811
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1812
+ execute_or_queue_command(command, &block)
1813
+ end
1814
+
1815
+ # Deletes the specified FHIR store and removes all resources within it.
1816
+ # @param [String] name
1817
+ # The resource name of the FHIR store to delete.
1818
+ # @param [String] fields
1819
+ # Selector specifying which fields to include in a partial response.
1820
+ # @param [String] quota_user
1821
+ # Available to use for quota purposes for server-side applications. Can be any
1822
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1823
+ # @param [Google::Apis::RequestOptions] options
1824
+ # Request-specific options
1825
+ #
1826
+ # @yield [result, err] Result & error if block supplied
1827
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1828
+ # @yieldparam err [StandardError] error object if request failed
1829
+ #
1830
+ # @return [Google::Apis::HealthcareV1::Empty]
1831
+ #
1832
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1833
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1834
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1835
+ def delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
1836
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1837
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
1838
+ command.response_class = Google::Apis::HealthcareV1::Empty
1839
+ command.params['name'] = name unless name.nil?
1840
+ command.query['fields'] = fields unless fields.nil?
1841
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1842
+ execute_or_queue_command(command, &block)
1843
+ end
1844
+
1845
+ # Export resources from the FHIR store to the specified destination. This method
1846
+ # returns an Operation that can be used to track the status of the export by
1847
+ # calling GetOperation. Immediate fatal errors appear in the error field, errors
1848
+ # are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/
1849
+ # logging)). Otherwise, when the operation finishes, a detailed response of type
1850
+ # ExportResourcesResponse is returned in the response field. The metadata field
1851
+ # type for this operation is OperationMetadata.
1852
+ # @param [String] name
1853
+ # The name of the FHIR store to export resource from, in the format of `projects/
1854
+ # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
1855
+ # fhir_store_id``.
1856
+ # @param [Google::Apis::HealthcareV1::ExportResourcesRequest] export_resources_request_object
1857
+ # @param [String] fields
1858
+ # Selector specifying which fields to include in a partial response.
1859
+ # @param [String] quota_user
1860
+ # Available to use for quota purposes for server-side applications. Can be any
1861
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1862
+ # @param [Google::Apis::RequestOptions] options
1863
+ # Request-specific options
1864
+ #
1865
+ # @yield [result, err] Result & error if block supplied
1866
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
1867
+ # @yieldparam err [StandardError] error object if request failed
1868
+ #
1869
+ # @return [Google::Apis::HealthcareV1::Operation]
1870
+ #
1871
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1872
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1873
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1874
+ def export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1875
+ command = make_simple_command(:post, 'v1/{+name}:export', options)
1876
+ command.request_representation = Google::Apis::HealthcareV1::ExportResourcesRequest::Representation
1877
+ command.request_object = export_resources_request_object
1878
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
1879
+ command.response_class = Google::Apis::HealthcareV1::Operation
1880
+ command.params['name'] = name unless name.nil?
1881
+ command.query['fields'] = fields unless fields.nil?
1882
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1883
+ execute_or_queue_command(command, &block)
1884
+ end
1885
+
1886
+ # Gets the configuration of the specified FHIR store.
1887
+ # @param [String] name
1888
+ # The resource name of the FHIR store to get.
1889
+ # @param [String] fields
1890
+ # Selector specifying which fields to include in a partial response.
1891
+ # @param [String] quota_user
1892
+ # Available to use for quota purposes for server-side applications. Can be any
1893
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1894
+ # @param [Google::Apis::RequestOptions] options
1895
+ # Request-specific options
1896
+ #
1897
+ # @yield [result, err] Result & error if block supplied
1898
+ # @yieldparam result [Google::Apis::HealthcareV1::FhirStore] parsed result object
1899
+ # @yieldparam err [StandardError] error object if request failed
1900
+ #
1901
+ # @return [Google::Apis::HealthcareV1::FhirStore]
1902
+ #
1903
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1904
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1905
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1906
+ def get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block)
1907
+ command = make_simple_command(:get, 'v1/{+name}', options)
1908
+ command.response_representation = Google::Apis::HealthcareV1::FhirStore::Representation
1909
+ command.response_class = Google::Apis::HealthcareV1::FhirStore
1910
+ command.params['name'] = name unless name.nil?
1911
+ command.query['fields'] = fields unless fields.nil?
1912
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1913
+ execute_or_queue_command(command, &block)
1914
+ end
1915
+
1916
+ # Gets the access control policy for a resource. Returns an empty policy if the
1917
+ # resource exists and does not have a policy set.
1918
+ # @param [String] resource
1919
+ # REQUIRED: The resource for which the policy is being requested. See the
1920
+ # operation documentation for the appropriate value for this field.
1921
+ # @param [Fixnum] options_requested_policy_version
1922
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
1923
+ # 3. Requests specifying an invalid value will be rejected. Requests for
1924
+ # policies with any conditional bindings must specify version 3. Policies
1925
+ # without any conditional bindings may specify any valid value or leave the
1926
+ # field unset. To learn which resources support conditions in their IAM policies,
1927
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
1928
+ # resource-policies).
1929
+ # @param [String] fields
1930
+ # Selector specifying which fields to include in a partial response.
1931
+ # @param [String] quota_user
1932
+ # Available to use for quota purposes for server-side applications. Can be any
1933
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1934
+ # @param [Google::Apis::RequestOptions] options
1935
+ # Request-specific options
1936
+ #
1937
+ # @yield [result, err] Result & error if block supplied
1938
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1939
+ # @yieldparam err [StandardError] error object if request failed
1940
+ #
1941
+ # @return [Google::Apis::HealthcareV1::Policy]
1942
+ #
1943
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1944
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1945
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1946
+ def get_project_location_dataset_fhir_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
1947
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
1948
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
1949
+ command.response_class = Google::Apis::HealthcareV1::Policy
1950
+ command.params['resource'] = resource unless resource.nil?
1951
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
1952
+ command.query['fields'] = fields unless fields.nil?
1953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1954
+ execute_or_queue_command(command, &block)
1955
+ end
1956
+
1957
+ # Imports resources to the FHIR store by loading data from the specified sources.
1958
+ # This method is optimized to load large quantities of data using import
1959
+ # semantics that ignore some FHIR store configuration options and are not
1960
+ # suitable for all use cases. It is primarily intended to load data into an
1961
+ # empty FHIR store that is not being used by other clients. In cases where this
1962
+ # method is not appropriate, consider using ExecuteBundle to load data. Every
1963
+ # resource in the input must contain a client-supplied ID. Each resource is
1964
+ # stored using the supplied ID regardless of the enable_update_create setting on
1965
+ # the FHIR store. The import process does not enforce referential integrity,
1966
+ # regardless of the disable_referential_integrity setting on the FHIR store.
1967
+ # This allows the import of resources with arbitrary interdependencies without
1968
+ # considering grouping or ordering, but if the input data contains invalid
1969
+ # references or if some resources fail to be imported, the FHIR store might be
1970
+ # left in a state that violates referential integrity. The import process does
1971
+ # not trigger Pub/Sub notification or BigQuery streaming update, regardless of
1972
+ # how those are configured on the FHIR store. If a resource with the specified
1973
+ # ID already exists, the most recent version of the resource is overwritten
1974
+ # without creating a new historical version, regardless of the
1975
+ # disable_resource_versioning setting on the FHIR store. If transient failures
1976
+ # occur during the import, it's possible that successfully imported resources
1977
+ # will be overwritten more than once. The import operation is idempotent unless
1978
+ # the input data contains multiple valid resources with the same ID but
1979
+ # different contents. In that case, after the import completes, the store
1980
+ # contains exactly one resource with that ID but there is no ordering guarantee
1981
+ # on which version of the contents it will have. The operation result counters
1982
+ # do not count duplicate IDs as an error and count one success for each resource
1983
+ # in the input, which might result in a success count larger than the number of
1984
+ # resources in the FHIR store. This often occurs when importing data organized
1985
+ # in bundles produced by Patient-everything where each bundle contains its own
1986
+ # copy of a resource such as Practitioner that might be referred to by many
1987
+ # patients. If some resources fail to import, for example due to parsing errors,
1988
+ # successfully imported resources are not rolled back. The location and format
1989
+ # of the input data is specified by the parameters in ImportResourcesRequest.
1990
+ # Note that if no format is specified, this method assumes the `BUNDLE` format.
1991
+ # When using the `BUNDLE` format this method ignores the `Bundle.type` field,
1992
+ # except that `history` bundles are rejected, and does not apply any of the
1993
+ # bundle processing semantics for batch or transaction bundles. Unlike in
1994
+ # ExecuteBundle, transaction bundles are not executed as a single transaction
1995
+ # and bundle-internal references are not rewritten. The bundle is treated as a
1996
+ # collection of resources to be written as provided in `Bundle.entry.resource`,
1997
+ # ignoring `Bundle.entry.request`. As an example, this allows the import of `
1998
+ # searchset` bundles produced by a FHIR search or Patient-everything operation.
1999
+ # This method returns an Operation that can be used to track the status of the
2000
+ # import by calling GetOperation. Immediate fatal errors appear in the error
2001
+ # field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/
2002
+ # docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed
2003
+ # response of type ImportResourcesResponse is returned in the response field.
2004
+ # The metadata field type for this operation is OperationMetadata.
2005
+ # @param [String] name
2006
+ # The name of the FHIR store to import FHIR resources to, in the format of `
2007
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
2008
+ # `fhir_store_id``.
2009
+ # @param [Google::Apis::HealthcareV1::ImportResourcesRequest] import_resources_request_object
2010
+ # @param [String] fields
2011
+ # Selector specifying which fields to include in a partial response.
2012
+ # @param [String] quota_user
2013
+ # Available to use for quota purposes for server-side applications. Can be any
2014
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2015
+ # @param [Google::Apis::RequestOptions] options
2016
+ # Request-specific options
2017
+ #
2018
+ # @yield [result, err] Result & error if block supplied
2019
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
2020
+ # @yieldparam err [StandardError] error object if request failed
2021
+ #
2022
+ # @return [Google::Apis::HealthcareV1::Operation]
2023
+ #
2024
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2025
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2026
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2027
+ def import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2028
+ command = make_simple_command(:post, 'v1/{+name}:import', options)
2029
+ command.request_representation = Google::Apis::HealthcareV1::ImportResourcesRequest::Representation
2030
+ command.request_object = import_resources_request_object
2031
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
2032
+ command.response_class = Google::Apis::HealthcareV1::Operation
2033
+ command.params['name'] = name unless name.nil?
2034
+ command.query['fields'] = fields unless fields.nil?
2035
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2036
+ execute_or_queue_command(command, &block)
2037
+ end
2038
+
2039
+ # Lists the FHIR stores in the given dataset.
2040
+ # @param [String] parent
2041
+ # Name of the dataset.
2042
+ # @param [String] filter
2043
+ # Restricts stores returned to those matching a filter. Syntax: https://cloud.
2044
+ # google.com/appengine/docs/standard/python/search/query_strings Only filtering
2045
+ # on labels is supported, for example `labels.key=value`.
2046
+ # @param [Fixnum] page_size
2047
+ # Limit on the number of FHIR stores to return in a single response. If not
2048
+ # specified, 100 is used. May not be larger than 1000.
2049
+ # @param [String] page_token
2050
+ # The next_page_token value returned from the previous List request, if any.
2051
+ # @param [String] fields
2052
+ # Selector specifying which fields to include in a partial response.
2053
+ # @param [String] quota_user
2054
+ # Available to use for quota purposes for server-side applications. Can be any
2055
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2056
+ # @param [Google::Apis::RequestOptions] options
2057
+ # Request-specific options
2058
+ #
2059
+ # @yield [result, err] Result & error if block supplied
2060
+ # @yieldparam result [Google::Apis::HealthcareV1::ListFhirStoresResponse] parsed result object
2061
+ # @yieldparam err [StandardError] error object if request failed
2062
+ #
2063
+ # @return [Google::Apis::HealthcareV1::ListFhirStoresResponse]
2064
+ #
2065
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2066
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2067
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2068
+ def list_project_location_dataset_fhir_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2069
+ command = make_simple_command(:get, 'v1/{+parent}/fhirStores', options)
2070
+ command.response_representation = Google::Apis::HealthcareV1::ListFhirStoresResponse::Representation
2071
+ command.response_class = Google::Apis::HealthcareV1::ListFhirStoresResponse
2072
+ command.params['parent'] = parent unless parent.nil?
2073
+ command.query['filter'] = filter unless filter.nil?
2074
+ command.query['pageSize'] = page_size unless page_size.nil?
2075
+ command.query['pageToken'] = page_token unless page_token.nil?
2076
+ command.query['fields'] = fields unless fields.nil?
2077
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2078
+ execute_or_queue_command(command, &block)
2079
+ end
2080
+
2081
+ # Updates the configuration of the specified FHIR store.
2082
+ # @param [String] name
2083
+ # Output only. Resource name of the FHIR store, of the form `projects/`
2084
+ # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
2085
+ # @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object
2086
+ # @param [String] update_mask
2087
+ # The update mask applies to the resource. For the `FieldMask` definition, see
2088
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
2089
+ # fieldmask
2090
+ # @param [String] fields
2091
+ # Selector specifying which fields to include in a partial response.
2092
+ # @param [String] quota_user
2093
+ # Available to use for quota purposes for server-side applications. Can be any
2094
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2095
+ # @param [Google::Apis::RequestOptions] options
2096
+ # Request-specific options
2097
+ #
2098
+ # @yield [result, err] Result & error if block supplied
2099
+ # @yieldparam result [Google::Apis::HealthcareV1::FhirStore] parsed result object
2100
+ # @yieldparam err [StandardError] error object if request failed
2101
+ #
2102
+ # @return [Google::Apis::HealthcareV1::FhirStore]
2103
+ #
2104
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2105
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2106
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2107
+ def patch_project_location_dataset_fhir_store(name, fhir_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2108
+ command = make_simple_command(:patch, 'v1/{+name}', options)
2109
+ command.request_representation = Google::Apis::HealthcareV1::FhirStore::Representation
2110
+ command.request_object = fhir_store_object
2111
+ command.response_representation = Google::Apis::HealthcareV1::FhirStore::Representation
2112
+ command.response_class = Google::Apis::HealthcareV1::FhirStore
2113
+ command.params['name'] = name unless name.nil?
2114
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2115
+ command.query['fields'] = fields unless fields.nil?
2116
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2117
+ execute_or_queue_command(command, &block)
2118
+ end
2119
+
2120
+ # Sets the access control policy on the specified resource. Replaces any
2121
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
2122
+ # PERMISSION_DENIED` errors.
2123
+ # @param [String] resource
2124
+ # REQUIRED: The resource for which the policy is being specified. See the
2125
+ # operation documentation for the appropriate value for this field.
2126
+ # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object
2127
+ # @param [String] fields
2128
+ # Selector specifying which fields to include in a partial response.
2129
+ # @param [String] quota_user
2130
+ # Available to use for quota purposes for server-side applications. Can be any
2131
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2132
+ # @param [Google::Apis::RequestOptions] options
2133
+ # Request-specific options
2134
+ #
2135
+ # @yield [result, err] Result & error if block supplied
2136
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
2137
+ # @yieldparam err [StandardError] error object if request failed
2138
+ #
2139
+ # @return [Google::Apis::HealthcareV1::Policy]
2140
+ #
2141
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2142
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2143
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2144
+ def set_fhir_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2145
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
2146
+ command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
2147
+ command.request_object = set_iam_policy_request_object
2148
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
2149
+ command.response_class = Google::Apis::HealthcareV1::Policy
2150
+ command.params['resource'] = resource unless resource.nil?
2151
+ command.query['fields'] = fields unless fields.nil?
2152
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2153
+ execute_or_queue_command(command, &block)
2154
+ end
2155
+
2156
+ # Returns permissions that a caller has on the specified resource. If the
2157
+ # resource does not exist, this will return an empty set of permissions, not a `
2158
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
2159
+ # permission-aware UIs and command-line tools, not for authorization checking.
2160
+ # This operation may "fail open" without warning.
2161
+ # @param [String] resource
2162
+ # REQUIRED: The resource for which the policy detail is being requested. See the
2163
+ # operation documentation for the appropriate value for this field.
2164
+ # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object
2165
+ # @param [String] fields
2166
+ # Selector specifying which fields to include in a partial response.
2167
+ # @param [String] quota_user
2168
+ # Available to use for quota purposes for server-side applications. Can be any
2169
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2170
+ # @param [Google::Apis::RequestOptions] options
2171
+ # Request-specific options
2172
+ #
2173
+ # @yield [result, err] Result & error if block supplied
2174
+ # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
2175
+ # @yieldparam err [StandardError] error object if request failed
2176
+ #
2177
+ # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
2178
+ #
2179
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2180
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2181
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2182
+ def test_fhir_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2183
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
2184
+ command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
2185
+ command.request_object = test_iam_permissions_request_object
2186
+ command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
2187
+ command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
2188
+ command.params['resource'] = resource unless resource.nil?
2189
+ command.query['fields'] = fields unless fields.nil?
2190
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2191
+ execute_or_queue_command(command, &block)
2192
+ end
2193
+
2194
+ # Retrieves a Patient resource and resources related to that patient. Implements
2195
+ # the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/
2196
+ # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](
2197
+ # http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#
2198
+ # everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-
2199
+ # operations.html#everything)). On success, the response body will contain a
2200
+ # JSON-encoded representation of a `Bundle` resource of type `searchset`,
2201
+ # containing the results of the operation. Errors generated by the FHIR store
2202
+ # will contain a JSON-encoded `OperationOutcome` resource describing the reason
2203
+ # for the error. If the request cannot be mapped to a valid API method on a FHIR
2204
+ # store, a generic GCP error might be returned instead. The resources in scope
2205
+ # for the response are: * The patient resource itself. * All the resources
2206
+ # directly referenced by the patient resource. * Resources directly referencing
2207
+ # the patient resource that meet the inclusion criteria. The inclusion criteria
2208
+ # are based on the membership rules in the patient compartment definition ([
2209
+ # DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.
2210
+ # hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/
2211
+ # fhir/R4/compartmentdefinition-patient.html)), which details the eligible
2212
+ # resource types and referencing search parameters. For samples that show how to
2213
+ # call `Patient-everything`, see [Getting all patient compartment resources](/
2214
+ # healthcare/docs/how-tos/fhir-resources#
2215
+ # getting_all_patient_compartment_resources).
2216
+ # @param [String] name
2217
+ # Name of the `Patient` resource for which the information is required.
2218
+ # @param [Fixnum] _count
2219
+ # Maximum number of resources in a page. If not specified, 100 is used. May not
2220
+ # be larger than 1000.
2221
+ # @param [String] _page_token
2222
+ # Used to retrieve the next or previous page of results when using pagination.
2223
+ # Set `_page_token` to the value of _page_token set in next or previous page
2224
+ # links' url. Next and previous page are returned in the response bundle's links
2225
+ # field, where `link.relation` is "previous" or "next". Omit `_page_token` if no
2226
+ # previous request has been made.
2227
+ # @param [String] _since
2228
+ # If provided, only resources updated after this time are returned. The time
2229
+ # uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:
2230
+ # 17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the
2231
+ # second and include a time zone.
2232
+ # @param [String] _type
2233
+ # String of comma-delimited FHIR resource types. If provided, only resources of
2234
+ # the specified resource type(s) are returned.
2235
+ # @param [String] end_
2236
+ # The response includes records prior to the end date. If no end date is
2237
+ # provided, all records subsequent to the start date are in scope.
2238
+ # @param [String] start
2239
+ # The response includes records subsequent to the start date. If no start date
2240
+ # is provided, all records prior to the end date are in scope.
2241
+ # @param [String] fields
2242
+ # Selector specifying which fields to include in a partial response.
2243
+ # @param [String] quota_user
2244
+ # Available to use for quota purposes for server-side applications. Can be any
2245
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2246
+ # @param [Google::Apis::RequestOptions] options
2247
+ # Request-specific options
2248
+ #
2249
+ # @yield [result, err] Result & error if block supplied
2250
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2251
+ # @yieldparam err [StandardError] error object if request failed
2252
+ #
2253
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2254
+ #
2255
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2256
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2257
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2258
+ def patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, _page_token: nil, _since: nil, _type: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block)
2259
+ command = make_simple_command(:get, 'v1/{+name}/$everything', options)
2260
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2261
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2262
+ command.params['name'] = name unless name.nil?
2263
+ command.query['_count'] = _count unless _count.nil?
2264
+ command.query['_page_token'] = _page_token unless _page_token.nil?
2265
+ command.query['_since'] = _since unless _since.nil?
2266
+ command.query['_type'] = _type unless _type.nil?
2267
+ command.query['end'] = end_ unless end_.nil?
2268
+ command.query['start'] = start unless start.nil?
2269
+ command.query['fields'] = fields unless fields.nil?
2270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2271
+ execute_or_queue_command(command, &block)
2272
+ end
2273
+
2274
+ # Deletes all the historical versions of a resource (excluding the current
2275
+ # version) from the FHIR store. To remove all versions of a resource, first
2276
+ # delete the current version and then call this method. This is not a FHIR
2277
+ # standard operation. For samples that show how to call `Resource-purge`, see [
2278
+ # Deleting historical versions of a FHIR resource](/healthcare/docs/how-tos/fhir-
2279
+ # resources#deleting_historical_versions_of_a_fhir_resource).
2280
+ # @param [String] name
2281
+ # The name of the resource to purge.
2282
+ # @param [String] fields
2283
+ # Selector specifying which fields to include in a partial response.
2284
+ # @param [String] quota_user
2285
+ # Available to use for quota purposes for server-side applications. Can be any
2286
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2287
+ # @param [Google::Apis::RequestOptions] options
2288
+ # Request-specific options
2289
+ #
2290
+ # @yield [result, err] Result & error if block supplied
2291
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
2292
+ # @yieldparam err [StandardError] error object if request failed
2293
+ #
2294
+ # @return [Google::Apis::HealthcareV1::Empty]
2295
+ #
2296
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2297
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2298
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2299
+ def resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil, &block)
2300
+ command = make_simple_command(:delete, 'v1/{+name}/$purge', options)
2301
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
2302
+ command.response_class = Google::Apis::HealthcareV1::Empty
2303
+ command.params['name'] = name unless name.nil?
2304
+ command.query['fields'] = fields unless fields.nil?
2305
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2306
+ execute_or_queue_command(command, &block)
2307
+ end
2308
+
2309
+ # Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/
2310
+ # fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/
2311
+ # fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.
2312
+ # org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the
2313
+ # store, which contains a description of functionality supported by the server.
2314
+ # Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/
2315
+ # implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/
2316
+ # implement/standards/fhir/R4/http.html#capabilities)), or the [conformance
2317
+ # interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#
2318
+ # conformance) in the DSTU2 case. On success, the response body will contain a
2319
+ # JSON-encoded representation of a `CapabilityStatement` resource.
2320
+ # @param [String] name
2321
+ # Name of the FHIR store to retrieve the capabilities for.
2322
+ # @param [String] fields
2323
+ # Selector specifying which fields to include in a partial response.
2324
+ # @param [String] quota_user
2325
+ # Available to use for quota purposes for server-side applications. Can be any
2326
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2327
+ # @param [Google::Apis::RequestOptions] options
2328
+ # Request-specific options
2329
+ #
2330
+ # @yield [result, err] Result & error if block supplied
2331
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2332
+ # @yieldparam err [StandardError] error object if request failed
2333
+ #
2334
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2335
+ #
2336
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2337
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2338
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2339
+ def capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
2340
+ command = make_simple_command(:get, 'v1/{+name}/fhir/metadata', options)
2341
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2342
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2343
+ command.params['name'] = name unless name.nil?
2344
+ command.query['fields'] = fields unless fields.nil?
2345
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2346
+ execute_or_queue_command(command, &block)
2347
+ end
2348
+
2349
+ # Creates a FHIR resource. Implements the FHIR standard create interaction ([
2350
+ # DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](
2351
+ # http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://
2352
+ # hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new
2353
+ # resource with a server-assigned resource ID. The request body must contain a
2354
+ # JSON-encoded FHIR resource, and the request headers must contain `Content-Type:
2355
+ # application/fhir+json`. On success, the response body will contain a JSON-
2356
+ # encoded representation of the resource as it was created on the server,
2357
+ # including the server-assigned resource ID and version ID. Errors generated by
2358
+ # the FHIR store will contain a JSON-encoded `OperationOutcome` resource
2359
+ # describing the reason for the error. If the request cannot be mapped to a
2360
+ # valid API method on a FHIR store, a generic GCP error might be returned
2361
+ # instead. For samples that show how to call `create`, see [Creating a FHIR
2362
+ # resource](/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).
2363
+ # @param [String] parent
2364
+ # The name of the FHIR store this resource belongs to.
2365
+ # @param [String] type
2366
+ # The FHIR resource type to create, such as Patient or Observation. For a
2367
+ # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
2368
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
2369
+ # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/
2370
+ # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
2371
+ # provided content.
2372
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
2373
+ # @param [String] fields
2374
+ # Selector specifying which fields to include in a partial response.
2375
+ # @param [String] quota_user
2376
+ # Available to use for quota purposes for server-side applications. Can be any
2377
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2378
+ # @param [Google::Apis::RequestOptions] options
2379
+ # Request-specific options
2380
+ #
2381
+ # @yield [result, err] Result & error if block supplied
2382
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2383
+ # @yieldparam err [StandardError] error object if request failed
2384
+ #
2385
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2386
+ #
2387
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2388
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2389
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2390
+ def create_project_location_dataset_fhir_store_fhir(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2391
+ command = make_simple_command(:post, 'v1/{+parent}/fhir/{+type}', options)
2392
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2393
+ command.request_object = http_body_object
2394
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2395
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2396
+ command.params['parent'] = parent unless parent.nil?
2397
+ command.params['type'] = type unless type.nil?
2398
+ command.query['fields'] = fields unless fields.nil?
2399
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2400
+ execute_or_queue_command(command, &block)
2401
+ end
2402
+
2403
+ # Deletes a FHIR resource. Implements the FHIR standard delete interaction ([
2404
+ # DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](
2405
+ # http://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](http://
2406
+ # hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource
2407
+ # versioning is disabled by setting the disable_resource_versioning flag on the
2408
+ # FHIR store, the deleted resources will be moved to a history repository that
2409
+ # can still be retrieved through vread and related methods, unless they are
2410
+ # removed by the purge method. For samples that show how to call `delete`, see [
2411
+ # Deleting a FHIR resource](/healthcare/docs/how-tos/fhir-resources#
2412
+ # deleting_a_fhir_resource).
2413
+ # @param [String] name
2414
+ # The name of the resource to delete.
2415
+ # @param [String] fields
2416
+ # Selector specifying which fields to include in a partial response.
2417
+ # @param [String] quota_user
2418
+ # Available to use for quota purposes for server-side applications. Can be any
2419
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2420
+ # @param [Google::Apis::RequestOptions] options
2421
+ # Request-specific options
2422
+ #
2423
+ # @yield [result, err] Result & error if block supplied
2424
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2425
+ # @yieldparam err [StandardError] error object if request failed
2426
+ #
2427
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2428
+ #
2429
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2430
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2431
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2432
+ def delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
2433
+ command = make_simple_command(:delete, 'v1/{+name}', options)
2434
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2435
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2436
+ command.params['name'] = name unless name.nil?
2437
+ command.query['fields'] = fields unless fields.nil?
2438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2439
+ execute_or_queue_command(command, &block)
2440
+ end
2441
+
2442
+ # Executes all the requests in the given Bundle. Implements the FHIR standard
2443
+ # batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/
2444
+ # DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/
2445
+ # STU3/http.html#transaction), [R4](http://hl7.org/implement/standards/fhir/R4/
2446
+ # http.html#transaction)). Supports all interactions within a bundle, except
2447
+ # search. This method accepts Bundles of type `batch` and `transaction`,
2448
+ # processing them according to the batch processing rules ([DSTU2](http://hl7.
2449
+ # org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.
2450
+ # org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/
2451
+ # implement/standards/fhir/R4/http.html#brules)) and transaction processing
2452
+ # rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.
2453
+ # 16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.
2454
+ # 2), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). The
2455
+ # request body must contain a JSON-encoded FHIR `Bundle` resource, and the
2456
+ # request headers must contain `Content-Type: application/fhir+json`. For a
2457
+ # batch bundle or a successful transaction the response body will contain a JSON-
2458
+ # encoded representation of a `Bundle` resource of type `batch-response` or `
2459
+ # transaction-response` containing one entry for each entry in the request, with
2460
+ # the outcome of processing the entry. In the case of an error for a transaction
2461
+ # bundle, the response body will contain a JSON-encoded `OperationOutcome`
2462
+ # resource describing the reason for the error. If the request cannot be mapped
2463
+ # to a valid API method on a FHIR store, a generic GCP error might be returned
2464
+ # instead. For samples that show how to call `executeBundle`, see [Managing FHIR
2465
+ # resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles).
2466
+ # @param [String] parent
2467
+ # Name of the FHIR store in which this bundle will be executed.
2468
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
2469
+ # @param [String] fields
2470
+ # Selector specifying which fields to include in a partial response.
2471
+ # @param [String] quota_user
2472
+ # Available to use for quota purposes for server-side applications. Can be any
2473
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2474
+ # @param [Google::Apis::RequestOptions] options
2475
+ # Request-specific options
2476
+ #
2477
+ # @yield [result, err] Result & error if block supplied
2478
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2479
+ # @yieldparam err [StandardError] error object if request failed
2480
+ #
2481
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2482
+ #
2483
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2484
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2485
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2486
+ def execute_project_location_dataset_fhir_store_fhir_bundle(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2487
+ command = make_simple_command(:post, 'v1/{+parent}/fhir', options)
2488
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2489
+ command.request_object = http_body_object
2490
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2491
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2492
+ command.params['parent'] = parent unless parent.nil?
2493
+ command.query['fields'] = fields unless fields.nil?
2494
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2495
+ execute_or_queue_command(command, &block)
2496
+ end
2497
+
2498
+ # Lists all the versions of a resource (including the current version and
2499
+ # deleted versions) from the FHIR store. Implements the per-resource form of the
2500
+ # FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/
2501
+ # fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/
2502
+ # STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.
2503
+ # html#history)). On success, the response body will contain a JSON-encoded
2504
+ # representation of a `Bundle` resource of type `history`, containing the
2505
+ # version history sorted from most recent to oldest versions. Errors generated
2506
+ # by the FHIR store will contain a JSON-encoded `OperationOutcome` resource
2507
+ # describing the reason for the error. If the request cannot be mapped to a
2508
+ # valid API method on a FHIR store, a generic GCP error might be returned
2509
+ # instead. For samples that show how to call `history`, see [Listing FHIR
2510
+ # resource versions](/healthcare/docs/how-tos/fhir-resources#
2511
+ # listing_fhir_resource_versions).
2512
+ # @param [String] name
2513
+ # The name of the resource to retrieve.
2514
+ # @param [String] _at
2515
+ # Only include resource versions that were current at some point during the time
2516
+ # period specified in the date time value. The date parameter format is yyyy-mm-
2517
+ # ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An
2518
+ # entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `
2519
+ # _at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z`
2520
+ # @param [Fixnum] _count
2521
+ # The maximum number of search results on a page. If not specified, 100 is used.
2522
+ # May not be larger than 1000.
2523
+ # @param [String] _page_token
2524
+ # Used to retrieve the first, previous, next, or last page of resource versions
2525
+ # when using pagination. Value should be set to the value of `_page_token` set
2526
+ # in next or previous page links' URLs. Next and previous page are returned in
2527
+ # the response bundle's links field, where `link.relation` is "previous" or "
2528
+ # next". Omit `_page_token` if no previous request has been made.
2529
+ # @param [String] _since
2530
+ # Only include resource versions that were created at or after the given instant
2531
+ # in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (
2532
+ # for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time
2533
+ # must be specified to the second and include a time zone.
2534
+ # @param [String] fields
2535
+ # Selector specifying which fields to include in a partial response.
2536
+ # @param [String] quota_user
2537
+ # Available to use for quota purposes for server-side applications. Can be any
2538
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2539
+ # @param [Google::Apis::RequestOptions] options
2540
+ # Request-specific options
2541
+ #
2542
+ # @yield [result, err] Result & error if block supplied
2543
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2544
+ # @yieldparam err [StandardError] error object if request failed
2545
+ #
2546
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2547
+ #
2548
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2549
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2550
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2551
+ def history_project_location_dataset_fhir_store_fhir(name, _at: nil, _count: nil, _page_token: nil, _since: nil, fields: nil, quota_user: nil, options: nil, &block)
2552
+ command = make_simple_command(:get, 'v1/{+name}/_history', options)
2553
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2554
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2555
+ command.params['name'] = name unless name.nil?
2556
+ command.query['_at'] = _at unless _at.nil?
2557
+ command.query['_count'] = _count unless _count.nil?
2558
+ command.query['_page_token'] = _page_token unless _page_token.nil?
2559
+ command.query['_since'] = _since unless _since.nil?
2560
+ command.query['fields'] = fields unless fields.nil?
2561
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2562
+ execute_or_queue_command(command, &block)
2563
+ end
2564
+
2565
+ # Updates part of an existing resource by applying the operations specified in a
2566
+ # [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard
2567
+ # patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.
2568
+ # html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)).
2569
+ # DSTU2 doesn't define a patch method, but the server supports it in the same
2570
+ # way it supports STU3. The request body must contain a JSON Patch document, and
2571
+ # the request headers must contain `Content-Type: application/json-patch+json`.
2572
+ # On success, the response body will contain a JSON-encoded representation of
2573
+ # the updated resource, including the server-assigned version ID. Errors
2574
+ # generated by the FHIR store will contain a JSON-encoded `OperationOutcome`
2575
+ # resource describing the reason for the error. If the request cannot be mapped
2576
+ # to a valid API method on a FHIR store, a generic GCP error might be returned
2577
+ # instead. For samples that show how to call `patch`, see [Patching a FHIR
2578
+ # resource](/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).
2579
+ # @param [String] name
2580
+ # The name of the resource to update.
2581
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
2582
+ # @param [String] fields
2583
+ # Selector specifying which fields to include in a partial response.
2584
+ # @param [String] quota_user
2585
+ # Available to use for quota purposes for server-side applications. Can be any
2586
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2587
+ # @param [Google::Apis::RequestOptions] options
2588
+ # Request-specific options
2589
+ #
2590
+ # @yield [result, err] Result & error if block supplied
2591
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2592
+ # @yieldparam err [StandardError] error object if request failed
2593
+ #
2594
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2595
+ #
2596
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2597
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2598
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2599
+ def patch_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2600
+ command = make_simple_command(:patch, 'v1/{+name}', options)
2601
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2602
+ command.request_object = http_body_object
2603
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2604
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2605
+ command.params['name'] = name unless name.nil?
2606
+ command.query['fields'] = fields unless fields.nil?
2607
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2608
+ execute_or_queue_command(command, &block)
2609
+ end
2610
+
2611
+ # Gets the contents of a FHIR resource. Implements the FHIR standard read
2612
+ # interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#
2613
+ # read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), [
2614
+ # R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports
2615
+ # the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/
2616
+ # implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/
2617
+ # implement/standards/fhir/STU3/http.html#cread), [R4](http://hl7.org/implement/
2618
+ # standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-
2619
+ # Since` header with a date/time value or an `If-None-Match` header with an ETag
2620
+ # value. On success, the response body will contain a JSON-encoded
2621
+ # representation of the resource. Errors generated by the FHIR store will
2622
+ # contain a JSON-encoded `OperationOutcome` resource describing the reason for
2623
+ # the error. If the request cannot be mapped to a valid API method on a FHIR
2624
+ # store, a generic GCP error might be returned instead. For samples that show
2625
+ # how to call `read`, see [Getting a FHIR resource](/healthcare/docs/how-tos/
2626
+ # fhir-resources#getting_a_fhir_resource).
2627
+ # @param [String] name
2628
+ # The name of the resource to retrieve.
2629
+ # @param [String] fields
2630
+ # Selector specifying which fields to include in a partial response.
2631
+ # @param [String] quota_user
2632
+ # Available to use for quota purposes for server-side applications. Can be any
2633
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2634
+ # @param [Google::Apis::RequestOptions] options
2635
+ # Request-specific options
2636
+ #
2637
+ # @yield [result, err] Result & error if block supplied
2638
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2639
+ # @yieldparam err [StandardError] error object if request failed
2640
+ #
2641
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2642
+ #
2643
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2644
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2645
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2646
+ def read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
2647
+ command = make_simple_command(:get, 'v1/{+name}', options)
2648
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2649
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2650
+ command.params['name'] = name unless name.nil?
2651
+ command.query['fields'] = fields unless fields.nil?
2652
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2653
+ execute_or_queue_command(command, &block)
2654
+ end
2655
+
2656
+ # Searches for resources in the given FHIR store according to criteria specified
2657
+ # as query parameters. Implements the FHIR standard search interaction ([DSTU2](
2658
+ # http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://
2659
+ # hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/
2660
+ # implement/standards/fhir/R4/http.html#search)) using the search semantics
2661
+ # described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/
2662
+ # standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/
2663
+ # fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.
2664
+ # html)). Supports three methods of search defined by the specification: * `GET [
2665
+ # base]?[parameters]` to search across all resources. * `GET [base]/[type]?[
2666
+ # parameters]` to search resources of a specified type. * `POST [base]/[type]/
2667
+ # _search?[parameters]` as an alternate form having the same semantics as the `
2668
+ # GET` method. The `GET` methods do not support compartment searches. The `POST`
2669
+ # method does not support `application/x-www-form-urlencoded` search parameters.
2670
+ # On success, the response body will contain a JSON-encoded representation of a `
2671
+ # Bundle` resource of type `searchset`, containing the results of the search.
2672
+ # Errors generated by the FHIR store will contain a JSON-encoded `
2673
+ # OperationOutcome` resource describing the reason for the error. If the request
2674
+ # cannot be mapped to a valid API method on a FHIR store, a generic GCP error
2675
+ # might be returned instead. The server's capability statement, retrieved
2676
+ # through capabilities, indicates what search parameters are supported on each
2677
+ # FHIR resource. A list of all search parameters defined by the specification
2678
+ # can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/
2679
+ # implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.
2680
+ # org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search
2681
+ # parameters for DSTU2 can be found on each resource's definition page.
2682
+ # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`,
2683
+ # `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported
2684
+ # search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `
2685
+ # _summary=text`, `_summary=data`, and `_elements`. The maximum number of search
2686
+ # results returned defaults to 100, which can be overridden by the `_count`
2687
+ # parameter up to a maximum limit of 1000. If there are additional results, the
2688
+ # returned `Bundle` will contain pagination links. Resources with a total size
2689
+ # larger than 5MB or a field count larger than 50,000 might not be fully
2690
+ # searchable as the server might trim its generated search index in those cases.
2691
+ # Note: FHIR resources are indexed asynchronously, so there might be a slight
2692
+ # delay between the time a resource is created or changes and when the change is
2693
+ # reflected in search results. For samples and detailed information, see [
2694
+ # Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [
2695
+ # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).
2696
+ # @param [String] parent
2697
+ # Name of the FHIR store to retrieve resources from.
2698
+ # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
2699
+ # @param [String] fields
2700
+ # Selector specifying which fields to include in a partial response.
2701
+ # @param [String] quota_user
2702
+ # Available to use for quota purposes for server-side applications. Can be any
2703
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2704
+ # @param [Google::Apis::RequestOptions] options
2705
+ # Request-specific options
2706
+ #
2707
+ # @yield [result, err] Result & error if block supplied
2708
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2709
+ # @yieldparam err [StandardError] error object if request failed
2710
+ #
2711
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2712
+ #
2713
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2714
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2715
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2716
+ def search_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2717
+ command = make_simple_command(:post, 'v1/{+parent}/fhir/_search', options)
2718
+ command.request_representation = Google::Apis::HealthcareV1::SearchResourcesRequest::Representation
2719
+ command.request_object = search_resources_request_object
2720
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2721
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2722
+ command.params['parent'] = parent unless parent.nil?
2723
+ command.query['fields'] = fields unless fields.nil?
2724
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2725
+ execute_or_queue_command(command, &block)
2726
+ end
2727
+
2728
+ # Updates the entire contents of a resource. Implements the FHIR standard update
2729
+ # interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#
2730
+ # update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update),
2731
+ # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the
2732
+ # specified resource does not exist and the FHIR store has enable_update_create
2733
+ # set, creates the resource with the client-specified ID. The request body must
2734
+ # contain a JSON-encoded FHIR resource, and the request headers must contain `
2735
+ # Content-Type: application/fhir+json`. The resource must contain an `id`
2736
+ # element having an identical value to the ID in the REST path of the request.
2737
+ # On success, the response body will contain a JSON-encoded representation of
2738
+ # the updated resource, including the server-assigned version ID. Errors
2739
+ # generated by the FHIR store will contain a JSON-encoded `OperationOutcome`
2740
+ # resource describing the reason for the error. If the request cannot be mapped
2741
+ # to a valid API method on a FHIR store, a generic GCP error might be returned
2742
+ # instead. For samples that show how to call `update`, see [Updating a FHIR
2743
+ # resource](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
2744
+ # @param [String] name
2745
+ # The name of the resource to update.
2746
+ # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
2747
+ # @param [String] fields
2748
+ # Selector specifying which fields to include in a partial response.
2749
+ # @param [String] quota_user
2750
+ # Available to use for quota purposes for server-side applications. Can be any
2751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2752
+ # @param [Google::Apis::RequestOptions] options
2753
+ # Request-specific options
2754
+ #
2755
+ # @yield [result, err] Result & error if block supplied
2756
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2757
+ # @yieldparam err [StandardError] error object if request failed
2758
+ #
2759
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2760
+ #
2761
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2762
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2763
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2764
+ def update_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2765
+ command = make_simple_command(:put, 'v1/{+name}', options)
2766
+ command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2767
+ command.request_object = http_body_object
2768
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2769
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2770
+ command.params['name'] = name unless name.nil?
2771
+ command.query['fields'] = fields unless fields.nil?
2772
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2773
+ execute_or_queue_command(command, &block)
2774
+ end
2775
+
2776
+ # Gets the contents of a version (current or historical) of a FHIR resource by
2777
+ # version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.
2778
+ # org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/
2779
+ # implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/
2780
+ # standards/fhir/R4/http.html#vread)). On success, the response body will
2781
+ # contain a JSON-encoded representation of the resource. Errors generated by the
2782
+ # FHIR store will contain a JSON-encoded `OperationOutcome` resource describing
2783
+ # the reason for the error. If the request cannot be mapped to a valid API
2784
+ # method on a FHIR store, a generic GCP error might be returned instead. For
2785
+ # samples that show how to call `vread`, see [Retrieving a FHIR resource version]
2786
+ # (/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).
2787
+ # @param [String] name
2788
+ # The name of the resource version to retrieve.
2789
+ # @param [String] fields
2790
+ # Selector specifying which fields to include in a partial response.
2791
+ # @param [String] quota_user
2792
+ # Available to use for quota purposes for server-side applications. Can be any
2793
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2794
+ # @param [Google::Apis::RequestOptions] options
2795
+ # Request-specific options
2796
+ #
2797
+ # @yield [result, err] Result & error if block supplied
2798
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
2799
+ # @yieldparam err [StandardError] error object if request failed
2800
+ #
2801
+ # @return [Google::Apis::HealthcareV1::HttpBody]
2802
+ #
2803
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2804
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2805
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2806
+ def vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block)
2807
+ command = make_simple_command(:get, 'v1/{+name}', options)
2808
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
2809
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
2810
+ command.params['name'] = name unless name.nil?
2811
+ command.query['fields'] = fields unless fields.nil?
2812
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2813
+ execute_or_queue_command(command, &block)
2814
+ end
2815
+
2816
+ # Creates a new HL7v2 store within the parent dataset.
2817
+ # @param [String] parent
2818
+ # The name of the dataset this HL7v2 store belongs to.
2819
+ # @param [Google::Apis::HealthcareV1::Hl7V2Store] hl7_v2_store_object
2820
+ # @param [String] hl7_v2_store_id
2821
+ # The ID of the HL7v2 store that is being created. The string must match the
2822
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
2823
+ # @param [String] fields
2824
+ # Selector specifying which fields to include in a partial response.
2825
+ # @param [String] quota_user
2826
+ # Available to use for quota purposes for server-side applications. Can be any
2827
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2828
+ # @param [Google::Apis::RequestOptions] options
2829
+ # Request-specific options
2830
+ #
2831
+ # @yield [result, err] Result & error if block supplied
2832
+ # @yieldparam result [Google::Apis::HealthcareV1::Hl7V2Store] parsed result object
2833
+ # @yieldparam err [StandardError] error object if request failed
2834
+ #
2835
+ # @return [Google::Apis::HealthcareV1::Hl7V2Store]
2836
+ #
2837
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2838
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2839
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2840
+ def create_project_location_dataset_hl7_v2_store(parent, hl7_v2_store_object = nil, hl7_v2_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
2841
+ command = make_simple_command(:post, 'v1/{+parent}/hl7V2Stores', options)
2842
+ command.request_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
2843
+ command.request_object = hl7_v2_store_object
2844
+ command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
2845
+ command.response_class = Google::Apis::HealthcareV1::Hl7V2Store
2846
+ command.params['parent'] = parent unless parent.nil?
2847
+ command.query['hl7V2StoreId'] = hl7_v2_store_id unless hl7_v2_store_id.nil?
2848
+ command.query['fields'] = fields unless fields.nil?
2849
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2850
+ execute_or_queue_command(command, &block)
2851
+ end
2852
+
2853
+ # Deletes the specified HL7v2 store and removes all messages that it contains.
2854
+ # @param [String] name
2855
+ # The resource name of the HL7v2 store to delete.
2856
+ # @param [String] fields
2857
+ # Selector specifying which fields to include in a partial response.
2858
+ # @param [String] quota_user
2859
+ # Available to use for quota purposes for server-side applications. Can be any
2860
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2861
+ # @param [Google::Apis::RequestOptions] options
2862
+ # Request-specific options
2863
+ #
2864
+ # @yield [result, err] Result & error if block supplied
2865
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
2866
+ # @yieldparam err [StandardError] error object if request failed
2867
+ #
2868
+ # @return [Google::Apis::HealthcareV1::Empty]
2869
+ #
2870
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2871
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2872
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2873
+ def delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
2874
+ command = make_simple_command(:delete, 'v1/{+name}', options)
2875
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
2876
+ command.response_class = Google::Apis::HealthcareV1::Empty
2877
+ command.params['name'] = name unless name.nil?
2878
+ command.query['fields'] = fields unless fields.nil?
2879
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2880
+ execute_or_queue_command(command, &block)
2881
+ end
2882
+
2883
+ # Gets the specified HL7v2 store.
2884
+ # @param [String] name
2885
+ # The resource name of the HL7v2 store to get.
2886
+ # @param [String] fields
2887
+ # Selector specifying which fields to include in a partial response.
2888
+ # @param [String] quota_user
2889
+ # Available to use for quota purposes for server-side applications. Can be any
2890
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2891
+ # @param [Google::Apis::RequestOptions] options
2892
+ # Request-specific options
2893
+ #
2894
+ # @yield [result, err] Result & error if block supplied
2895
+ # @yieldparam result [Google::Apis::HealthcareV1::Hl7V2Store] parsed result object
2896
+ # @yieldparam err [StandardError] error object if request failed
2897
+ #
2898
+ # @return [Google::Apis::HealthcareV1::Hl7V2Store]
2899
+ #
2900
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2901
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2902
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2903
+ def get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block)
2904
+ command = make_simple_command(:get, 'v1/{+name}', options)
2905
+ command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
2906
+ command.response_class = Google::Apis::HealthcareV1::Hl7V2Store
2907
+ command.params['name'] = name unless name.nil?
2908
+ command.query['fields'] = fields unless fields.nil?
2909
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2910
+ execute_or_queue_command(command, &block)
2911
+ end
2912
+
2913
+ # Gets the access control policy for a resource. Returns an empty policy if the
2914
+ # resource exists and does not have a policy set.
2915
+ # @param [String] resource
2916
+ # REQUIRED: The resource for which the policy is being requested. See the
2917
+ # operation documentation for the appropriate value for this field.
2918
+ # @param [Fixnum] options_requested_policy_version
2919
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
2920
+ # 3. Requests specifying an invalid value will be rejected. Requests for
2921
+ # policies with any conditional bindings must specify version 3. Policies
2922
+ # without any conditional bindings may specify any valid value or leave the
2923
+ # field unset. To learn which resources support conditions in their IAM policies,
2924
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
2925
+ # resource-policies).
2926
+ # @param [String] fields
2927
+ # Selector specifying which fields to include in a partial response.
2928
+ # @param [String] quota_user
2929
+ # Available to use for quota purposes for server-side applications. Can be any
2930
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2931
+ # @param [Google::Apis::RequestOptions] options
2932
+ # Request-specific options
2933
+ #
2934
+ # @yield [result, err] Result & error if block supplied
2935
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
2936
+ # @yieldparam err [StandardError] error object if request failed
2937
+ #
2938
+ # @return [Google::Apis::HealthcareV1::Policy]
2939
+ #
2940
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2941
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2942
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2943
+ def get_project_location_dataset_hl7_v2_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
2944
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
2945
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
2946
+ command.response_class = Google::Apis::HealthcareV1::Policy
2947
+ command.params['resource'] = resource unless resource.nil?
2948
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
2949
+ command.query['fields'] = fields unless fields.nil?
2950
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2951
+ execute_or_queue_command(command, &block)
2952
+ end
2953
+
2954
+ # Lists the HL7v2 stores in the given dataset.
2955
+ # @param [String] parent
2956
+ # Name of the dataset.
2957
+ # @param [String] filter
2958
+ # Restricts stores returned to those matching a filter. Syntax: https://cloud.
2959
+ # google.com/appengine/docs/standard/python/search/query_strings Only filtering
2960
+ # on labels is supported. For example, `labels.key=value`.
2961
+ # @param [Fixnum] page_size
2962
+ # Limit on the number of HL7v2 stores to return in a single response. If not
2963
+ # specified, 100 is used. May not be larger than 1000.
2964
+ # @param [String] page_token
2965
+ # The next_page_token value returned from the previous List request, if any.
2966
+ # @param [String] fields
2967
+ # Selector specifying which fields to include in a partial response.
2968
+ # @param [String] quota_user
2969
+ # Available to use for quota purposes for server-side applications. Can be any
2970
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2971
+ # @param [Google::Apis::RequestOptions] options
2972
+ # Request-specific options
2973
+ #
2974
+ # @yield [result, err] Result & error if block supplied
2975
+ # @yieldparam result [Google::Apis::HealthcareV1::ListHl7V2StoresResponse] parsed result object
2976
+ # @yieldparam err [StandardError] error object if request failed
2977
+ #
2978
+ # @return [Google::Apis::HealthcareV1::ListHl7V2StoresResponse]
2979
+ #
2980
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2981
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2982
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2983
+ def list_project_location_dataset_hl7_v2_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2984
+ command = make_simple_command(:get, 'v1/{+parent}/hl7V2Stores', options)
2985
+ command.response_representation = Google::Apis::HealthcareV1::ListHl7V2StoresResponse::Representation
2986
+ command.response_class = Google::Apis::HealthcareV1::ListHl7V2StoresResponse
2987
+ command.params['parent'] = parent unless parent.nil?
2988
+ command.query['filter'] = filter unless filter.nil?
2989
+ command.query['pageSize'] = page_size unless page_size.nil?
2990
+ command.query['pageToken'] = page_token unless page_token.nil?
2991
+ command.query['fields'] = fields unless fields.nil?
2992
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2993
+ execute_or_queue_command(command, &block)
2994
+ end
2995
+
2996
+ # Updates the HL7v2 store.
2997
+ # @param [String] name
2998
+ # Resource name of the HL7v2 store, of the form `projects/`project_id`/datasets/`
2999
+ # dataset_id`/hl7V2Stores/`hl7v2_store_id``.
3000
+ # @param [Google::Apis::HealthcareV1::Hl7V2Store] hl7_v2_store_object
3001
+ # @param [String] update_mask
3002
+ # The update mask applies to the resource. For the `FieldMask` definition, see
3003
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
3004
+ # fieldmask
3005
+ # @param [String] fields
3006
+ # Selector specifying which fields to include in a partial response.
3007
+ # @param [String] quota_user
3008
+ # Available to use for quota purposes for server-side applications. Can be any
3009
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3010
+ # @param [Google::Apis::RequestOptions] options
3011
+ # Request-specific options
3012
+ #
3013
+ # @yield [result, err] Result & error if block supplied
3014
+ # @yieldparam result [Google::Apis::HealthcareV1::Hl7V2Store] parsed result object
3015
+ # @yieldparam err [StandardError] error object if request failed
3016
+ #
3017
+ # @return [Google::Apis::HealthcareV1::Hl7V2Store]
3018
+ #
3019
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3020
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3021
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3022
+ def patch_project_location_dataset_hl7_v2_store(name, hl7_v2_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3023
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3024
+ command.request_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
3025
+ command.request_object = hl7_v2_store_object
3026
+ command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation
3027
+ command.response_class = Google::Apis::HealthcareV1::Hl7V2Store
3028
+ command.params['name'] = name unless name.nil?
3029
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3030
+ command.query['fields'] = fields unless fields.nil?
3031
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3032
+ execute_or_queue_command(command, &block)
3033
+ end
3034
+
3035
+ # Sets the access control policy on the specified resource. Replaces any
3036
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
3037
+ # PERMISSION_DENIED` errors.
3038
+ # @param [String] resource
3039
+ # REQUIRED: The resource for which the policy is being specified. See the
3040
+ # operation documentation for the appropriate value for this field.
3041
+ # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object
3042
+ # @param [String] fields
3043
+ # Selector specifying which fields to include in a partial response.
3044
+ # @param [String] quota_user
3045
+ # Available to use for quota purposes for server-side applications. Can be any
3046
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3047
+ # @param [Google::Apis::RequestOptions] options
3048
+ # Request-specific options
3049
+ #
3050
+ # @yield [result, err] Result & error if block supplied
3051
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
3052
+ # @yieldparam err [StandardError] error object if request failed
3053
+ #
3054
+ # @return [Google::Apis::HealthcareV1::Policy]
3055
+ #
3056
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3057
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3058
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3059
+ def set_hl7_v2_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3060
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
3061
+ command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
3062
+ command.request_object = set_iam_policy_request_object
3063
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
3064
+ command.response_class = Google::Apis::HealthcareV1::Policy
3065
+ command.params['resource'] = resource unless resource.nil?
3066
+ command.query['fields'] = fields unless fields.nil?
3067
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3068
+ execute_or_queue_command(command, &block)
3069
+ end
3070
+
3071
+ # Returns permissions that a caller has on the specified resource. If the
3072
+ # resource does not exist, this will return an empty set of permissions, not a `
3073
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
3074
+ # permission-aware UIs and command-line tools, not for authorization checking.
3075
+ # This operation may "fail open" without warning.
3076
+ # @param [String] resource
3077
+ # REQUIRED: The resource for which the policy detail is being requested. See the
3078
+ # operation documentation for the appropriate value for this field.
3079
+ # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object
3080
+ # @param [String] fields
3081
+ # Selector specifying which fields to include in a partial response.
3082
+ # @param [String] quota_user
3083
+ # Available to use for quota purposes for server-side applications. Can be any
3084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3085
+ # @param [Google::Apis::RequestOptions] options
3086
+ # Request-specific options
3087
+ #
3088
+ # @yield [result, err] Result & error if block supplied
3089
+ # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
3090
+ # @yieldparam err [StandardError] error object if request failed
3091
+ #
3092
+ # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
3093
+ #
3094
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3095
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3096
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3097
+ def test_hl7_v2_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3098
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
3099
+ command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
3100
+ command.request_object = test_iam_permissions_request_object
3101
+ command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
3102
+ command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
3103
+ command.params['resource'] = resource unless resource.nil?
3104
+ command.query['fields'] = fields unless fields.nil?
3105
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3106
+ execute_or_queue_command(command, &block)
3107
+ end
3108
+
3109
+ # Parses and stores an HL7v2 message. This method triggers an asynchronous
3110
+ # notification to any Cloud Pub/Sub topic configured in projects.locations.
3111
+ # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
3112
+ # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
3113
+ # the adapter transmits the message when a notification is received.
3114
+ # @param [String] parent
3115
+ # The name of the dataset this message belongs to.
3116
+ # @param [Google::Apis::HealthcareV1::CreateMessageRequest] create_message_request_object
3117
+ # @param [String] fields
3118
+ # Selector specifying which fields to include in a partial response.
3119
+ # @param [String] quota_user
3120
+ # Available to use for quota purposes for server-side applications. Can be any
3121
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3122
+ # @param [Google::Apis::RequestOptions] options
3123
+ # Request-specific options
3124
+ #
3125
+ # @yield [result, err] Result & error if block supplied
3126
+ # @yieldparam result [Google::Apis::HealthcareV1::Message] parsed result object
3127
+ # @yieldparam err [StandardError] error object if request failed
3128
+ #
3129
+ # @return [Google::Apis::HealthcareV1::Message]
3130
+ #
3131
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3132
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3133
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3134
+ def create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3135
+ command = make_simple_command(:post, 'v1/{+parent}/messages', options)
3136
+ command.request_representation = Google::Apis::HealthcareV1::CreateMessageRequest::Representation
3137
+ command.request_object = create_message_request_object
3138
+ command.response_representation = Google::Apis::HealthcareV1::Message::Representation
3139
+ command.response_class = Google::Apis::HealthcareV1::Message
3140
+ command.params['parent'] = parent unless parent.nil?
3141
+ command.query['fields'] = fields unless fields.nil?
3142
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3143
+ execute_or_queue_command(command, &block)
3144
+ end
3145
+
3146
+ # Deletes an HL7v2 message.
3147
+ # @param [String] name
3148
+ # The resource name of the HL7v2 message to delete.
3149
+ # @param [String] fields
3150
+ # Selector specifying which fields to include in a partial response.
3151
+ # @param [String] quota_user
3152
+ # Available to use for quota purposes for server-side applications. Can be any
3153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3154
+ # @param [Google::Apis::RequestOptions] options
3155
+ # Request-specific options
3156
+ #
3157
+ # @yield [result, err] Result & error if block supplied
3158
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
3159
+ # @yieldparam err [StandardError] error object if request failed
3160
+ #
3161
+ # @return [Google::Apis::HealthcareV1::Empty]
3162
+ #
3163
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3164
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3165
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3166
+ def delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil, &block)
3167
+ command = make_simple_command(:delete, 'v1/{+name}', options)
3168
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
3169
+ command.response_class = Google::Apis::HealthcareV1::Empty
3170
+ command.params['name'] = name unless name.nil?
3171
+ command.query['fields'] = fields unless fields.nil?
3172
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3173
+ execute_or_queue_command(command, &block)
3174
+ end
3175
+
3176
+ # Gets an HL7v2 message.
3177
+ # @param [String] name
3178
+ # The resource name of the HL7v2 message to retrieve.
3179
+ # @param [String] view
3180
+ # Specifies which parts of the Message resource to return in the response. When
3181
+ # unspecified, equivalent to FULL.
3182
+ # @param [String] fields
3183
+ # Selector specifying which fields to include in a partial response.
3184
+ # @param [String] quota_user
3185
+ # Available to use for quota purposes for server-side applications. Can be any
3186
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3187
+ # @param [Google::Apis::RequestOptions] options
3188
+ # Request-specific options
3189
+ #
3190
+ # @yield [result, err] Result & error if block supplied
3191
+ # @yieldparam result [Google::Apis::HealthcareV1::Message] parsed result object
3192
+ # @yieldparam err [StandardError] error object if request failed
3193
+ #
3194
+ # @return [Google::Apis::HealthcareV1::Message]
3195
+ #
3196
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3197
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3198
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3199
+ def get_project_location_dataset_hl7_v2_store_message(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
3200
+ command = make_simple_command(:get, 'v1/{+name}', options)
3201
+ command.response_representation = Google::Apis::HealthcareV1::Message::Representation
3202
+ command.response_class = Google::Apis::HealthcareV1::Message
3203
+ command.params['name'] = name unless name.nil?
3204
+ command.query['view'] = view unless view.nil?
3205
+ command.query['fields'] = fields unless fields.nil?
3206
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3207
+ execute_or_queue_command(command, &block)
3208
+ end
3209
+
3210
+ # Parses and stores an HL7v2 message. This method triggers an asynchronous
3211
+ # notification to any Cloud Pub/Sub topic configured in projects.locations.
3212
+ # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
3213
+ # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
3214
+ # the adapter transmits the message when a notification is received. This method
3215
+ # also generates a response containing an HL7v2 acknowledgement (`ACK`) message
3216
+ # when successful or a negative acknowledgement (`NACK`) message in case of
3217
+ # error, suitable for replying to HL7v2 interface systems that expect these
3218
+ # acknowledgements.
3219
+ # @param [String] parent
3220
+ # The name of the HL7v2 store this message belongs to.
3221
+ # @param [Google::Apis::HealthcareV1::IngestMessageRequest] ingest_message_request_object
3222
+ # @param [String] fields
3223
+ # Selector specifying which fields to include in a partial response.
3224
+ # @param [String] quota_user
3225
+ # Available to use for quota purposes for server-side applications. Can be any
3226
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3227
+ # @param [Google::Apis::RequestOptions] options
3228
+ # Request-specific options
3229
+ #
3230
+ # @yield [result, err] Result & error if block supplied
3231
+ # @yieldparam result [Google::Apis::HealthcareV1::IngestMessageResponse] parsed result object
3232
+ # @yieldparam err [StandardError] error object if request failed
3233
+ #
3234
+ # @return [Google::Apis::HealthcareV1::IngestMessageResponse]
3235
+ #
3236
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3237
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3238
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3239
+ def ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3240
+ command = make_simple_command(:post, 'v1/{+parent}/messages:ingest', options)
3241
+ command.request_representation = Google::Apis::HealthcareV1::IngestMessageRequest::Representation
3242
+ command.request_object = ingest_message_request_object
3243
+ command.response_representation = Google::Apis::HealthcareV1::IngestMessageResponse::Representation
3244
+ command.response_class = Google::Apis::HealthcareV1::IngestMessageResponse
3245
+ command.params['parent'] = parent unless parent.nil?
3246
+ command.query['fields'] = fields unless fields.nil?
3247
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3248
+ execute_or_queue_command(command, &block)
3249
+ end
3250
+
3251
+ # Lists all the messages in the given HL7v2 store with support for filtering.
3252
+ # Note: HL7v2 messages are indexed asynchronously, so there might be a slight
3253
+ # delay between the time a message is created and when it can be found through a
3254
+ # filter.
3255
+ # @param [String] parent
3256
+ # Name of the HL7v2 store to retrieve messages from.
3257
+ # @param [String] filter
3258
+ # Restricts messages returned to those matching a filter. Syntax: https://cloud.
3259
+ # google.com/appengine/docs/standard/python/search/query_strings Fields/
3260
+ # functions available for filtering are: * `message_type`, from the MSH-9.1
3261
+ # field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`,
3262
+ # the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the
3263
+ # MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the
3264
+ # timestamp when the message was sent, using the RFC3339 time format for
3265
+ # comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:
3266
+ # 00:00-05:00"`. * `send_facility`, the care center that the message came from,
3267
+ # from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(
3268
+ # value, type)`, which matches if the message lists a patient having an ID of
3269
+ # the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `
3270
+ # PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with
3271
+ # key `x` as set using the Message.labels map. For example, `labels."priority"="
3272
+ # high"`. The operator `:*` can be used to assert the existence of a label. For
3273
+ # example, `labels."priority":*`.
3274
+ # @param [String] order_by
3275
+ # Orders messages returned by the specified order_by clause. Syntax: https://
3276
+ # cloud.google.com/apis/design/design_patterns#sorting_order Fields available
3277
+ # for ordering are: * `send_time`
3278
+ # @param [Fixnum] page_size
3279
+ # Limit on the number of messages to return in a single response. If not
3280
+ # specified, 100 is used. May not be larger than 1000.
3281
+ # @param [String] page_token
3282
+ # The next_page_token value returned from the previous List request, if any.
3283
+ # @param [String] view
3284
+ # Specifies the parts of the Message to return in the response. When unspecified,
3285
+ # equivalent to BASIC. Setting this to anything other than BASIC with a `
3286
+ # page_size` larger than the default can generate a large response, which
3287
+ # impacts the performance of this method.
3288
+ # @param [String] fields
3289
+ # Selector specifying which fields to include in a partial response.
3290
+ # @param [String] quota_user
3291
+ # Available to use for quota purposes for server-side applications. Can be any
3292
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3293
+ # @param [Google::Apis::RequestOptions] options
3294
+ # Request-specific options
3295
+ #
3296
+ # @yield [result, err] Result & error if block supplied
3297
+ # @yieldparam result [Google::Apis::HealthcareV1::ListMessagesResponse] parsed result object
3298
+ # @yieldparam err [StandardError] error object if request failed
3299
+ #
3300
+ # @return [Google::Apis::HealthcareV1::ListMessagesResponse]
3301
+ #
3302
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3303
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3304
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3305
+ def list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
3306
+ command = make_simple_command(:get, 'v1/{+parent}/messages', options)
3307
+ command.response_representation = Google::Apis::HealthcareV1::ListMessagesResponse::Representation
3308
+ command.response_class = Google::Apis::HealthcareV1::ListMessagesResponse
3309
+ command.params['parent'] = parent unless parent.nil?
3310
+ command.query['filter'] = filter unless filter.nil?
3311
+ command.query['orderBy'] = order_by unless order_by.nil?
3312
+ command.query['pageSize'] = page_size unless page_size.nil?
3313
+ command.query['pageToken'] = page_token unless page_token.nil?
3314
+ command.query['view'] = view unless view.nil?
3315
+ command.query['fields'] = fields unless fields.nil?
3316
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3317
+ execute_or_queue_command(command, &block)
3318
+ end
3319
+
3320
+ # Update the message. The contents of the message in Message.data and data
3321
+ # extracted from the contents such as Message.create_time cannot be altered.
3322
+ # Only the Message.labels field is allowed to be updated. The labels in the
3323
+ # request are merged with the existing set of labels. Existing labels with the
3324
+ # same keys are updated.
3325
+ # @param [String] name
3326
+ # Resource name of the Message, of the form `projects/`project_id`/datasets/`
3327
+ # dataset_id`/hl7V2Stores/`hl7_v2_store_id`/messages/`message_id``. Assigned by
3328
+ # the server.
3329
+ # @param [Google::Apis::HealthcareV1::Message] message_object
3330
+ # @param [String] update_mask
3331
+ # The update mask applies to the resource. For the `FieldMask` definition, see
3332
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
3333
+ # fieldmask
3334
+ # @param [String] fields
3335
+ # Selector specifying which fields to include in a partial response.
3336
+ # @param [String] quota_user
3337
+ # Available to use for quota purposes for server-side applications. Can be any
3338
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3339
+ # @param [Google::Apis::RequestOptions] options
3340
+ # Request-specific options
3341
+ #
3342
+ # @yield [result, err] Result & error if block supplied
3343
+ # @yieldparam result [Google::Apis::HealthcareV1::Message] parsed result object
3344
+ # @yieldparam err [StandardError] error object if request failed
3345
+ #
3346
+ # @return [Google::Apis::HealthcareV1::Message]
3347
+ #
3348
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3349
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3350
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3351
+ def patch_project_location_dataset_hl7_v2_store_message(name, message_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
3352
+ command = make_simple_command(:patch, 'v1/{+name}', options)
3353
+ command.request_representation = Google::Apis::HealthcareV1::Message::Representation
3354
+ command.request_object = message_object
3355
+ command.response_representation = Google::Apis::HealthcareV1::Message::Representation
3356
+ command.response_class = Google::Apis::HealthcareV1::Message
3357
+ command.params['name'] = name unless name.nil?
3358
+ command.query['updateMask'] = update_mask unless update_mask.nil?
3359
+ command.query['fields'] = fields unless fields.nil?
3360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3361
+ execute_or_queue_command(command, &block)
3362
+ end
3363
+
3364
+ # Starts asynchronous cancellation on a long-running operation. The server makes
3365
+ # a best effort to cancel the operation, but success is not guaranteed. If the
3366
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
3367
+ # Clients can use Operations.GetOperation or other methods to check whether the
3368
+ # cancellation succeeded or whether the operation completed despite cancellation.
3369
+ # On successful cancellation, the operation is not deleted; instead, it becomes
3370
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
3371
+ # corresponding to `Code.CANCELLED`.
3372
+ # @param [String] name
3373
+ # The name of the operation resource to be cancelled.
3374
+ # @param [Google::Apis::HealthcareV1::CancelOperationRequest] cancel_operation_request_object
3375
+ # @param [String] fields
3376
+ # Selector specifying which fields to include in a partial response.
3377
+ # @param [String] quota_user
3378
+ # Available to use for quota purposes for server-side applications. Can be any
3379
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3380
+ # @param [Google::Apis::RequestOptions] options
3381
+ # Request-specific options
3382
+ #
3383
+ # @yield [result, err] Result & error if block supplied
3384
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
3385
+ # @yieldparam err [StandardError] error object if request failed
3386
+ #
3387
+ # @return [Google::Apis::HealthcareV1::Empty]
3388
+ #
3389
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3390
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3391
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3392
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3393
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
3394
+ command.request_representation = Google::Apis::HealthcareV1::CancelOperationRequest::Representation
3395
+ command.request_object = cancel_operation_request_object
3396
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
3397
+ command.response_class = Google::Apis::HealthcareV1::Empty
3398
+ command.params['name'] = name unless name.nil?
3399
+ command.query['fields'] = fields unless fields.nil?
3400
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3401
+ execute_or_queue_command(command, &block)
3402
+ end
3403
+
3404
+ # Gets the latest state of a long-running operation. Clients can use this method
3405
+ # to poll the operation result at intervals as recommended by the API service.
3406
+ # @param [String] name
3407
+ # The name of the operation resource.
3408
+ # @param [String] fields
3409
+ # Selector specifying which fields to include in a partial response.
3410
+ # @param [String] quota_user
3411
+ # Available to use for quota purposes for server-side applications. Can be any
3412
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3413
+ # @param [Google::Apis::RequestOptions] options
3414
+ # Request-specific options
3415
+ #
3416
+ # @yield [result, err] Result & error if block supplied
3417
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
3418
+ # @yieldparam err [StandardError] error object if request failed
3419
+ #
3420
+ # @return [Google::Apis::HealthcareV1::Operation]
3421
+ #
3422
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3423
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3424
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3425
+ def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
3426
+ command = make_simple_command(:get, 'v1/{+name}', options)
3427
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
3428
+ command.response_class = Google::Apis::HealthcareV1::Operation
3429
+ command.params['name'] = name unless name.nil?
3430
+ command.query['fields'] = fields unless fields.nil?
3431
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3432
+ execute_or_queue_command(command, &block)
3433
+ end
3434
+
3435
+ # Lists operations that match the specified filter in the request. If the server
3436
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
3437
+ # binding allows API services to override the binding to use different resource
3438
+ # name schemes, such as `users/*/operations`. To override the binding, API
3439
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
3440
+ # service configuration. For backwards compatibility, the default name includes
3441
+ # the operations collection id, however overriding users must ensure the name
3442
+ # binding is the parent resource, without the operations collection id.
3443
+ # @param [String] name
3444
+ # The name of the operation's parent resource.
3445
+ # @param [String] filter
3446
+ # The standard list filter.
3447
+ # @param [Fixnum] page_size
3448
+ # The standard list page size.
3449
+ # @param [String] page_token
3450
+ # The standard list page token.
3451
+ # @param [String] fields
3452
+ # Selector specifying which fields to include in a partial response.
3453
+ # @param [String] quota_user
3454
+ # Available to use for quota purposes for server-side applications. Can be any
3455
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3456
+ # @param [Google::Apis::RequestOptions] options
3457
+ # Request-specific options
3458
+ #
3459
+ # @yield [result, err] Result & error if block supplied
3460
+ # @yieldparam result [Google::Apis::HealthcareV1::ListOperationsResponse] parsed result object
3461
+ # @yieldparam err [StandardError] error object if request failed
3462
+ #
3463
+ # @return [Google::Apis::HealthcareV1::ListOperationsResponse]
3464
+ #
3465
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3466
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3467
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3468
+ def list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
3469
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
3470
+ command.response_representation = Google::Apis::HealthcareV1::ListOperationsResponse::Representation
3471
+ command.response_class = Google::Apis::HealthcareV1::ListOperationsResponse
3472
+ command.params['name'] = name unless name.nil?
3473
+ command.query['filter'] = filter unless filter.nil?
3474
+ command.query['pageSize'] = page_size unless page_size.nil?
3475
+ command.query['pageToken'] = page_token unless page_token.nil?
3476
+ command.query['fields'] = fields unless fields.nil?
3477
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3478
+ execute_or_queue_command(command, &block)
3479
+ end
3480
+
3481
+ protected
3482
+
3483
+ def apply_command_defaults(command)
3484
+ command.query['key'] = key unless key.nil?
3485
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3486
+ end
3487
+ end
3488
+ end
3489
+ end
3490
+ end