google-apis-healthcare_v1 0.1.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -83,11 +83,1432 @@ module Google
83
83
  # @param [String] name
84
84
  # The resource that owns the locations collection, if applicable.
85
85
  # @param [String] filter
86
- # The standard list filter.
86
+ # A filter to narrow down results to a preferred subset. The filtering language
87
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
88
+ # AIP-160](https://google.aip.dev/160).
89
+ # @param [Fixnum] page_size
90
+ # The maximum number of results to return. If not set, the service will select a
91
+ # default.
92
+ # @param [String] page_token
93
+ # A page token received from the `next_page_token` field in the response. Send
94
+ # that page token to receive the subsequent page.
95
+ # @param [String] fields
96
+ # Selector specifying which fields to include in a partial response.
97
+ # @param [String] quota_user
98
+ # Available to use for quota purposes for server-side applications. Can be any
99
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
100
+ # @param [Google::Apis::RequestOptions] options
101
+ # Request-specific options
102
+ #
103
+ # @yield [result, err] Result & error if block supplied
104
+ # @yieldparam result [Google::Apis::HealthcareV1::ListLocationsResponse] parsed result object
105
+ # @yieldparam err [StandardError] error object if request failed
106
+ #
107
+ # @return [Google::Apis::HealthcareV1::ListLocationsResponse]
108
+ #
109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
112
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
113
+ command = make_simple_command(:get, 'v1/{+name}/locations', options)
114
+ command.response_representation = Google::Apis::HealthcareV1::ListLocationsResponse::Representation
115
+ command.response_class = Google::Apis::HealthcareV1::ListLocationsResponse
116
+ command.params['name'] = name unless name.nil?
117
+ command.query['filter'] = filter unless filter.nil?
118
+ command.query['pageSize'] = page_size unless page_size.nil?
119
+ command.query['pageToken'] = page_token unless page_token.nil?
120
+ command.query['fields'] = fields unless fields.nil?
121
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
122
+ execute_or_queue_command(command, &block)
123
+ end
124
+
125
+ # Creates a new health dataset. Results are returned through the Operation
126
+ # interface which returns either an `Operation.response` which contains a
127
+ # Dataset or `Operation.error`. The metadata field type is OperationMetadata.
128
+ # @param [String] parent
129
+ # The name of the project where the server creates the dataset. For example, `
130
+ # projects/`project_id`/locations/`location_id``.
131
+ # @param [Google::Apis::HealthcareV1::Dataset] dataset_object
132
+ # @param [String] dataset_id
133
+ # The ID of the dataset that is being created. The string must match the
134
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
135
+ # @param [String] fields
136
+ # Selector specifying which fields to include in a partial response.
137
+ # @param [String] quota_user
138
+ # Available to use for quota purposes for server-side applications. Can be any
139
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
140
+ # @param [Google::Apis::RequestOptions] options
141
+ # Request-specific options
142
+ #
143
+ # @yield [result, err] Result & error if block supplied
144
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
145
+ # @yieldparam err [StandardError] error object if request failed
146
+ #
147
+ # @return [Google::Apis::HealthcareV1::Operation]
148
+ #
149
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
150
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
151
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
152
+ def create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil, &block)
153
+ command = make_simple_command(:post, 'v1/{+parent}/datasets', options)
154
+ command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation
155
+ command.request_object = dataset_object
156
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
157
+ command.response_class = Google::Apis::HealthcareV1::Operation
158
+ command.params['parent'] = parent unless parent.nil?
159
+ command.query['datasetId'] = dataset_id unless dataset_id.nil?
160
+ command.query['fields'] = fields unless fields.nil?
161
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
162
+ execute_or_queue_command(command, &block)
163
+ end
164
+
165
+ # Creates a new dataset containing de-identified data from the source dataset.
166
+ # The metadata field type is OperationMetadata. If the request is successful,
167
+ # the response field type is DeidentifySummary. If errors occur, error is set.
168
+ # The LRO result may still be successful if de-identification fails for some
169
+ # DICOM instances. The new de-identified dataset will not contain these failed
170
+ # resources. Failed resource totals are tracked in Operation.metadata. Error
171
+ # details are also logged to Cloud Logging. For more information, see [Viewing
172
+ # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
173
+ # logging).
174
+ # @param [String] source_dataset
175
+ # Source dataset resource name. For example, `projects/`project_id`/locations/`
176
+ # location_id`/datasets/`dataset_id``.
177
+ # @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object
178
+ # @param [String] fields
179
+ # Selector specifying which fields to include in a partial response.
180
+ # @param [String] quota_user
181
+ # Available to use for quota purposes for server-side applications. Can be any
182
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
183
+ # @param [Google::Apis::RequestOptions] options
184
+ # Request-specific options
185
+ #
186
+ # @yield [result, err] Result & error if block supplied
187
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
188
+ # @yieldparam err [StandardError] error object if request failed
189
+ #
190
+ # @return [Google::Apis::HealthcareV1::Operation]
191
+ #
192
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
193
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
194
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
195
+ def deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
196
+ command = make_simple_command(:post, 'v1/{+sourceDataset}:deidentify', options)
197
+ command.request_representation = Google::Apis::HealthcareV1::DeidentifyDatasetRequest::Representation
198
+ command.request_object = deidentify_dataset_request_object
199
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
200
+ command.response_class = Google::Apis::HealthcareV1::Operation
201
+ command.params['sourceDataset'] = source_dataset unless source_dataset.nil?
202
+ command.query['fields'] = fields unless fields.nil?
203
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
204
+ execute_or_queue_command(command, &block)
205
+ end
206
+
207
+ # Deletes the specified health dataset and all data contained in the dataset.
208
+ # Deleting a dataset does not affect the sources from which the dataset was
209
+ # imported (if any).
210
+ # @param [String] name
211
+ # The name of the dataset to delete. For example, `projects/`project_id`/
212
+ # locations/`location_id`/datasets/`dataset_id``.
213
+ # @param [String] fields
214
+ # Selector specifying which fields to include in a partial response.
215
+ # @param [String] quota_user
216
+ # Available to use for quota purposes for server-side applications. Can be any
217
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
218
+ # @param [Google::Apis::RequestOptions] options
219
+ # Request-specific options
220
+ #
221
+ # @yield [result, err] Result & error if block supplied
222
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
223
+ # @yieldparam err [StandardError] error object if request failed
224
+ #
225
+ # @return [Google::Apis::HealthcareV1::Empty]
226
+ #
227
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
228
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
229
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
230
+ def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
231
+ command = make_simple_command(:delete, 'v1/{+name}', options)
232
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
233
+ command.response_class = Google::Apis::HealthcareV1::Empty
234
+ command.params['name'] = name unless name.nil?
235
+ command.query['fields'] = fields unless fields.nil?
236
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
237
+ execute_or_queue_command(command, &block)
238
+ end
239
+
240
+ # Gets any metadata associated with a dataset.
241
+ # @param [String] name
242
+ # The name of the dataset to read. For example, `projects/`project_id`/locations/
243
+ # `location_id`/datasets/`dataset_id``.
244
+ # @param [String] fields
245
+ # Selector specifying which fields to include in a partial response.
246
+ # @param [String] quota_user
247
+ # Available to use for quota purposes for server-side applications. Can be any
248
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
249
+ # @param [Google::Apis::RequestOptions] options
250
+ # Request-specific options
251
+ #
252
+ # @yield [result, err] Result & error if block supplied
253
+ # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
254
+ # @yieldparam err [StandardError] error object if request failed
255
+ #
256
+ # @return [Google::Apis::HealthcareV1::Dataset]
257
+ #
258
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
259
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
260
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
261
+ def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
262
+ command = make_simple_command(:get, 'v1/{+name}', options)
263
+ command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation
264
+ command.response_class = Google::Apis::HealthcareV1::Dataset
265
+ command.params['name'] = name unless name.nil?
266
+ command.query['fields'] = fields unless fields.nil?
267
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
268
+ execute_or_queue_command(command, &block)
269
+ end
270
+
271
+ # Gets the access control policy for a resource. Returns an empty policy if the
272
+ # resource exists and does not have a policy set.
273
+ # @param [String] resource
274
+ # REQUIRED: The resource for which the policy is being requested. See the
275
+ # operation documentation for the appropriate value for this field.
276
+ # @param [Fixnum] options_requested_policy_version
277
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
278
+ # 3. Requests specifying an invalid value will be rejected. Requests for
279
+ # policies with any conditional bindings must specify version 3. Policies
280
+ # without any conditional bindings may specify any valid value or leave the
281
+ # field unset. To learn which resources support conditions in their IAM policies,
282
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
283
+ # resource-policies).
284
+ # @param [String] fields
285
+ # Selector specifying which fields to include in a partial response.
286
+ # @param [String] quota_user
287
+ # Available to use for quota purposes for server-side applications. Can be any
288
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
289
+ # @param [Google::Apis::RequestOptions] options
290
+ # Request-specific options
291
+ #
292
+ # @yield [result, err] Result & error if block supplied
293
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
294
+ # @yieldparam err [StandardError] error object if request failed
295
+ #
296
+ # @return [Google::Apis::HealthcareV1::Policy]
297
+ #
298
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
299
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
300
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
301
+ def get_project_location_dataset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
302
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
303
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
304
+ command.response_class = Google::Apis::HealthcareV1::Policy
305
+ command.params['resource'] = resource unless resource.nil?
306
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
307
+ command.query['fields'] = fields unless fields.nil?
308
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
309
+ execute_or_queue_command(command, &block)
310
+ end
311
+
312
+ # Lists the health datasets in the current project.
313
+ # @param [String] parent
314
+ # The name of the project whose datasets should be listed. For example, `
315
+ # projects/`project_id`/locations/`location_id``.
316
+ # @param [Fixnum] page_size
317
+ # The maximum number of items to return. If not specified, 100 is used. May not
318
+ # be larger than 1000.
319
+ # @param [String] page_token
320
+ # The next_page_token value returned from a previous List request, if any.
321
+ # @param [String] fields
322
+ # Selector specifying which fields to include in a partial response.
323
+ # @param [String] quota_user
324
+ # Available to use for quota purposes for server-side applications. Can be any
325
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
326
+ # @param [Google::Apis::RequestOptions] options
327
+ # Request-specific options
328
+ #
329
+ # @yield [result, err] Result & error if block supplied
330
+ # @yieldparam result [Google::Apis::HealthcareV1::ListDatasetsResponse] parsed result object
331
+ # @yieldparam err [StandardError] error object if request failed
332
+ #
333
+ # @return [Google::Apis::HealthcareV1::ListDatasetsResponse]
334
+ #
335
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
336
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
337
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
338
+ def list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
339
+ command = make_simple_command(:get, 'v1/{+parent}/datasets', options)
340
+ command.response_representation = Google::Apis::HealthcareV1::ListDatasetsResponse::Representation
341
+ command.response_class = Google::Apis::HealthcareV1::ListDatasetsResponse
342
+ command.params['parent'] = parent unless parent.nil?
343
+ command.query['pageSize'] = page_size unless page_size.nil?
344
+ command.query['pageToken'] = page_token unless page_token.nil?
345
+ command.query['fields'] = fields unless fields.nil?
346
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
347
+ execute_or_queue_command(command, &block)
348
+ end
349
+
350
+ # Updates dataset metadata.
351
+ # @param [String] name
352
+ # Resource name of the dataset, of the form `projects/`project_id`/locations/`
353
+ # location_id`/datasets/`dataset_id``.
354
+ # @param [Google::Apis::HealthcareV1::Dataset] dataset_object
355
+ # @param [String] update_mask
356
+ # The update mask applies to the resource. For the `FieldMask` definition, see
357
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
358
+ # fieldmask
359
+ # @param [String] fields
360
+ # Selector specifying which fields to include in a partial response.
361
+ # @param [String] quota_user
362
+ # Available to use for quota purposes for server-side applications. Can be any
363
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
364
+ # @param [Google::Apis::RequestOptions] options
365
+ # Request-specific options
366
+ #
367
+ # @yield [result, err] Result & error if block supplied
368
+ # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
369
+ # @yieldparam err [StandardError] error object if request failed
370
+ #
371
+ # @return [Google::Apis::HealthcareV1::Dataset]
372
+ #
373
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
374
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
375
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
376
+ def patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
377
+ command = make_simple_command(:patch, 'v1/{+name}', options)
378
+ command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation
379
+ command.request_object = dataset_object
380
+ command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation
381
+ command.response_class = Google::Apis::HealthcareV1::Dataset
382
+ command.params['name'] = name unless name.nil?
383
+ command.query['updateMask'] = update_mask unless update_mask.nil?
384
+ command.query['fields'] = fields unless fields.nil?
385
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
386
+ execute_or_queue_command(command, &block)
387
+ end
388
+
389
+ # Sets the access control policy on the specified resource. Replaces any
390
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
391
+ # PERMISSION_DENIED` errors.
392
+ # @param [String] resource
393
+ # REQUIRED: The resource for which the policy is being specified. See the
394
+ # operation documentation for the appropriate value for this field.
395
+ # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object
396
+ # @param [String] fields
397
+ # Selector specifying which fields to include in a partial response.
398
+ # @param [String] quota_user
399
+ # Available to use for quota purposes for server-side applications. Can be any
400
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
401
+ # @param [Google::Apis::RequestOptions] options
402
+ # Request-specific options
403
+ #
404
+ # @yield [result, err] Result & error if block supplied
405
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
406
+ # @yieldparam err [StandardError] error object if request failed
407
+ #
408
+ # @return [Google::Apis::HealthcareV1::Policy]
409
+ #
410
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
411
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
412
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
413
+ def set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
414
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
415
+ command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
416
+ command.request_object = set_iam_policy_request_object
417
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
418
+ command.response_class = Google::Apis::HealthcareV1::Policy
419
+ command.params['resource'] = resource unless resource.nil?
420
+ command.query['fields'] = fields unless fields.nil?
421
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
422
+ execute_or_queue_command(command, &block)
423
+ end
424
+
425
+ # Returns permissions that a caller has on the specified resource. If the
426
+ # resource does not exist, this will return an empty set of permissions, not a `
427
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
428
+ # permission-aware UIs and command-line tools, not for authorization checking.
429
+ # This operation may "fail open" without warning.
430
+ # @param [String] resource
431
+ # REQUIRED: The resource for which the policy detail is being requested. See the
432
+ # operation documentation for the appropriate value for this field.
433
+ # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object
434
+ # @param [String] fields
435
+ # Selector specifying which fields to include in a partial response.
436
+ # @param [String] quota_user
437
+ # Available to use for quota purposes for server-side applications. Can be any
438
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
439
+ # @param [Google::Apis::RequestOptions] options
440
+ # Request-specific options
441
+ #
442
+ # @yield [result, err] Result & error if block supplied
443
+ # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
444
+ # @yieldparam err [StandardError] error object if request failed
445
+ #
446
+ # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
447
+ #
448
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
449
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
450
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
451
+ def test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
452
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
453
+ command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
454
+ command.request_object = test_iam_permissions_request_object
455
+ command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
456
+ command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
457
+ command.params['resource'] = resource unless resource.nil?
458
+ command.query['fields'] = fields unless fields.nil?
459
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
460
+ execute_or_queue_command(command, &block)
461
+ end
462
+
463
+ # Checks if a particular data_id of a User data mapping in the specified consent
464
+ # store is consented for the specified use.
465
+ # @param [String] consent_store
466
+ # Required. Name of the consent store where the requested data_id is stored, of
467
+ # the form `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
468
+ # consentStores/`consent_store_id``.
469
+ # @param [Google::Apis::HealthcareV1::CheckDataAccessRequest] check_data_access_request_object
470
+ # @param [String] fields
471
+ # Selector specifying which fields to include in a partial response.
472
+ # @param [String] quota_user
473
+ # Available to use for quota purposes for server-side applications. Can be any
474
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
475
+ # @param [Google::Apis::RequestOptions] options
476
+ # Request-specific options
477
+ #
478
+ # @yield [result, err] Result & error if block supplied
479
+ # @yieldparam result [Google::Apis::HealthcareV1::CheckDataAccessResponse] parsed result object
480
+ # @yieldparam err [StandardError] error object if request failed
481
+ #
482
+ # @return [Google::Apis::HealthcareV1::CheckDataAccessResponse]
483
+ #
484
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
485
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
486
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
487
+ def check_consent_store_data_access(consent_store, check_data_access_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
488
+ command = make_simple_command(:post, 'v1/{+consentStore}:checkDataAccess', options)
489
+ command.request_representation = Google::Apis::HealthcareV1::CheckDataAccessRequest::Representation
490
+ command.request_object = check_data_access_request_object
491
+ command.response_representation = Google::Apis::HealthcareV1::CheckDataAccessResponse::Representation
492
+ command.response_class = Google::Apis::HealthcareV1::CheckDataAccessResponse
493
+ command.params['consentStore'] = consent_store unless consent_store.nil?
494
+ command.query['fields'] = fields unless fields.nil?
495
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
496
+ execute_or_queue_command(command, &block)
497
+ end
498
+
499
+ # Creates a new consent store in the parent dataset. Attempting to create a
500
+ # consent store with the same ID as an existing store fails with an
501
+ # ALREADY_EXISTS error.
502
+ # @param [String] parent
503
+ # Required. The name of the dataset this consent store belongs to.
504
+ # @param [Google::Apis::HealthcareV1::ConsentStore] consent_store_object
505
+ # @param [String] consent_store_id
506
+ # Required. The ID of the consent store to create. The string must match the
507
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``. Cannot be changed after creation.
508
+ # @param [String] fields
509
+ # Selector specifying which fields to include in a partial response.
510
+ # @param [String] quota_user
511
+ # Available to use for quota purposes for server-side applications. Can be any
512
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
513
+ # @param [Google::Apis::RequestOptions] options
514
+ # Request-specific options
515
+ #
516
+ # @yield [result, err] Result & error if block supplied
517
+ # @yieldparam result [Google::Apis::HealthcareV1::ConsentStore] parsed result object
518
+ # @yieldparam err [StandardError] error object if request failed
519
+ #
520
+ # @return [Google::Apis::HealthcareV1::ConsentStore]
521
+ #
522
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
523
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
524
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
525
+ def create_project_location_dataset_consent_store(parent, consent_store_object = nil, consent_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
526
+ command = make_simple_command(:post, 'v1/{+parent}/consentStores', options)
527
+ command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
528
+ command.request_object = consent_store_object
529
+ command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
530
+ command.response_class = Google::Apis::HealthcareV1::ConsentStore
531
+ command.params['parent'] = parent unless parent.nil?
532
+ command.query['consentStoreId'] = consent_store_id unless consent_store_id.nil?
533
+ command.query['fields'] = fields unless fields.nil?
534
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
535
+ execute_or_queue_command(command, &block)
536
+ end
537
+
538
+ # Deletes the specified consent store and removes all the consent store's data.
539
+ # @param [String] name
540
+ # Required. The resource name of the consent store to delete.
541
+ # @param [String] fields
542
+ # Selector specifying which fields to include in a partial response.
543
+ # @param [String] quota_user
544
+ # Available to use for quota purposes for server-side applications. Can be any
545
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
546
+ # @param [Google::Apis::RequestOptions] options
547
+ # Request-specific options
548
+ #
549
+ # @yield [result, err] Result & error if block supplied
550
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
551
+ # @yieldparam err [StandardError] error object if request failed
552
+ #
553
+ # @return [Google::Apis::HealthcareV1::Empty]
554
+ #
555
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
556
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
557
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
558
+ def delete_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil, &block)
559
+ command = make_simple_command(:delete, 'v1/{+name}', options)
560
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
561
+ command.response_class = Google::Apis::HealthcareV1::Empty
562
+ command.params['name'] = name unless name.nil?
563
+ command.query['fields'] = fields unless fields.nil?
564
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
565
+ execute_or_queue_command(command, &block)
566
+ end
567
+
568
+ # Evaluates the user's Consents for all matching User data mappings. Note: User
569
+ # data mappings are indexed asynchronously, which can cause a slight delay
570
+ # between the time mappings are created or updated and when they are included in
571
+ # EvaluateUserConsents results.
572
+ # @param [String] consent_store
573
+ # Required. Name of the consent store to retrieve User data mappings from.
574
+ # @param [Google::Apis::HealthcareV1::EvaluateUserConsentsRequest] evaluate_user_consents_request_object
575
+ # @param [String] fields
576
+ # Selector specifying which fields to include in a partial response.
577
+ # @param [String] quota_user
578
+ # Available to use for quota purposes for server-side applications. Can be any
579
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
580
+ # @param [Google::Apis::RequestOptions] options
581
+ # Request-specific options
582
+ #
583
+ # @yield [result, err] Result & error if block supplied
584
+ # @yieldparam result [Google::Apis::HealthcareV1::EvaluateUserConsentsResponse] parsed result object
585
+ # @yieldparam err [StandardError] error object if request failed
586
+ #
587
+ # @return [Google::Apis::HealthcareV1::EvaluateUserConsentsResponse]
588
+ #
589
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
590
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
591
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
592
+ def evaluate_consent_store_user_consents(consent_store, evaluate_user_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
593
+ command = make_simple_command(:post, 'v1/{+consentStore}:evaluateUserConsents', options)
594
+ command.request_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsRequest::Representation
595
+ command.request_object = evaluate_user_consents_request_object
596
+ command.response_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse::Representation
597
+ command.response_class = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse
598
+ command.params['consentStore'] = consent_store unless consent_store.nil?
599
+ command.query['fields'] = fields unless fields.nil?
600
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
601
+ execute_or_queue_command(command, &block)
602
+ end
603
+
604
+ # Gets the specified consent store.
605
+ # @param [String] name
606
+ # Required. The resource name of the consent store to get.
607
+ # @param [String] fields
608
+ # Selector specifying which fields to include in a partial response.
609
+ # @param [String] quota_user
610
+ # Available to use for quota purposes for server-side applications. Can be any
611
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
612
+ # @param [Google::Apis::RequestOptions] options
613
+ # Request-specific options
614
+ #
615
+ # @yield [result, err] Result & error if block supplied
616
+ # @yieldparam result [Google::Apis::HealthcareV1::ConsentStore] parsed result object
617
+ # @yieldparam err [StandardError] error object if request failed
618
+ #
619
+ # @return [Google::Apis::HealthcareV1::ConsentStore]
620
+ #
621
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
622
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
623
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
624
+ def get_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil, &block)
625
+ command = make_simple_command(:get, 'v1/{+name}', options)
626
+ command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
627
+ command.response_class = Google::Apis::HealthcareV1::ConsentStore
628
+ command.params['name'] = name unless name.nil?
629
+ command.query['fields'] = fields unless fields.nil?
630
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
631
+ execute_or_queue_command(command, &block)
632
+ end
633
+
634
+ # Gets the access control policy for a resource. Returns an empty policy if the
635
+ # resource exists and does not have a policy set.
636
+ # @param [String] resource
637
+ # REQUIRED: The resource for which the policy is being requested. See the
638
+ # operation documentation for the appropriate value for this field.
639
+ # @param [Fixnum] options_requested_policy_version
640
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
641
+ # 3. Requests specifying an invalid value will be rejected. Requests for
642
+ # policies with any conditional bindings must specify version 3. Policies
643
+ # without any conditional bindings may specify any valid value or leave the
644
+ # field unset. To learn which resources support conditions in their IAM policies,
645
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
646
+ # resource-policies).
647
+ # @param [String] fields
648
+ # Selector specifying which fields to include in a partial response.
649
+ # @param [String] quota_user
650
+ # Available to use for quota purposes for server-side applications. Can be any
651
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
652
+ # @param [Google::Apis::RequestOptions] options
653
+ # Request-specific options
654
+ #
655
+ # @yield [result, err] Result & error if block supplied
656
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
657
+ # @yieldparam err [StandardError] error object if request failed
658
+ #
659
+ # @return [Google::Apis::HealthcareV1::Policy]
660
+ #
661
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
662
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
663
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
664
+ def get_project_location_dataset_consent_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
665
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
666
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
667
+ command.response_class = Google::Apis::HealthcareV1::Policy
668
+ command.params['resource'] = resource unless resource.nil?
669
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
670
+ command.query['fields'] = fields unless fields.nil?
671
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
672
+ execute_or_queue_command(command, &block)
673
+ end
674
+
675
+ # Lists the consent stores in the specified dataset.
676
+ # @param [String] parent
677
+ # Required. Name of the dataset.
678
+ # @param [String] filter
679
+ # Optional. Restricts the stores returned to those matching a filter. Only
680
+ # filtering on labels is supported. For example, `filter=labels.key=value`.
681
+ # @param [Fixnum] page_size
682
+ # Optional. Limit on the number of consent stores to return in a single response.
683
+ # If not specified, 100 is used. May not be larger than 1000.
684
+ # @param [String] page_token
685
+ # Optional. Token to retrieve the next page of results, or empty to get the
686
+ # first page.
687
+ # @param [String] fields
688
+ # Selector specifying which fields to include in a partial response.
689
+ # @param [String] quota_user
690
+ # Available to use for quota purposes for server-side applications. Can be any
691
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
692
+ # @param [Google::Apis::RequestOptions] options
693
+ # Request-specific options
694
+ #
695
+ # @yield [result, err] Result & error if block supplied
696
+ # @yieldparam result [Google::Apis::HealthcareV1::ListConsentStoresResponse] parsed result object
697
+ # @yieldparam err [StandardError] error object if request failed
698
+ #
699
+ # @return [Google::Apis::HealthcareV1::ListConsentStoresResponse]
700
+ #
701
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
702
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
703
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
704
+ def list_project_location_dataset_consent_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
705
+ command = make_simple_command(:get, 'v1/{+parent}/consentStores', options)
706
+ command.response_representation = Google::Apis::HealthcareV1::ListConsentStoresResponse::Representation
707
+ command.response_class = Google::Apis::HealthcareV1::ListConsentStoresResponse
708
+ command.params['parent'] = parent unless parent.nil?
709
+ command.query['filter'] = filter unless filter.nil?
710
+ command.query['pageSize'] = page_size unless page_size.nil?
711
+ command.query['pageToken'] = page_token unless page_token.nil?
712
+ command.query['fields'] = fields unless fields.nil?
713
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
714
+ execute_or_queue_command(command, &block)
715
+ end
716
+
717
+ # Updates the specified consent store.
718
+ # @param [String] name
719
+ # Resource name of the consent store, of the form `projects/`project_id`/
720
+ # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id``
721
+ # . Cannot be changed after creation.
722
+ # @param [Google::Apis::HealthcareV1::ConsentStore] consent_store_object
723
+ # @param [String] update_mask
724
+ # Required. The update mask that applies to the resource. For the `FieldMask`
725
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
726
+ # google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `
727
+ # enable_consent_create_on_update` fields are allowed to be updated.
728
+ # @param [String] fields
729
+ # Selector specifying which fields to include in a partial response.
730
+ # @param [String] quota_user
731
+ # Available to use for quota purposes for server-side applications. Can be any
732
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
733
+ # @param [Google::Apis::RequestOptions] options
734
+ # Request-specific options
735
+ #
736
+ # @yield [result, err] Result & error if block supplied
737
+ # @yieldparam result [Google::Apis::HealthcareV1::ConsentStore] parsed result object
738
+ # @yieldparam err [StandardError] error object if request failed
739
+ #
740
+ # @return [Google::Apis::HealthcareV1::ConsentStore]
741
+ #
742
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
743
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
744
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
745
+ def patch_project_location_dataset_consent_store(name, consent_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
746
+ command = make_simple_command(:patch, 'v1/{+name}', options)
747
+ command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
748
+ command.request_object = consent_store_object
749
+ command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
750
+ command.response_class = Google::Apis::HealthcareV1::ConsentStore
751
+ command.params['name'] = name unless name.nil?
752
+ command.query['updateMask'] = update_mask unless update_mask.nil?
753
+ command.query['fields'] = fields unless fields.nil?
754
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
755
+ execute_or_queue_command(command, &block)
756
+ end
757
+
758
+ # Queries all data_ids that are consented for a specified use in the given
759
+ # consent store and writes them to a specified destination. The returned
760
+ # Operation includes a progress counter for the number of User data mappings
761
+ # processed. Errors are logged to Cloud Logging (see [Viewing error logs in
762
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). For
763
+ # example, the following sample log entry shows a `failed to evaluate consent
764
+ # policy` error that occurred during a QueryAccessibleData call to consent store
765
+ # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
766
+ # consentStores/`consent_store_id``. ```json jsonPayload: ` @type: "type.
767
+ # googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry"
768
+ # error: ` code: 9 message: "failed to evaluate consent policy" ` resourceName: "
769
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
770
+ # consentStores/`consent_store_id`/consents/`consent_id`" ` logName: "projects/`
771
+ # project_id`/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation:
772
+ # ` id: "projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
773
+ # operations/`operation_id`" producer: "healthcare.googleapis.com/
774
+ # QueryAccessibleData" ` receiveTimestamp: "TIMESTAMP" resource: ` labels: `
775
+ # consent_store_id: "`consent_store_id`" dataset_id: "`dataset_id`" location: "`
776
+ # location_id`" project_id: "`project_id`" ` type: "healthcare_consent_store" `
777
+ # severity: "ERROR" timestamp: "TIMESTAMP" ```
778
+ # @param [String] consent_store
779
+ # Required. Name of the consent store to retrieve User data mappings from.
780
+ # @param [Google::Apis::HealthcareV1::QueryAccessibleDataRequest] query_accessible_data_request_object
781
+ # @param [String] fields
782
+ # Selector specifying which fields to include in a partial response.
783
+ # @param [String] quota_user
784
+ # Available to use for quota purposes for server-side applications. Can be any
785
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
786
+ # @param [Google::Apis::RequestOptions] options
787
+ # Request-specific options
788
+ #
789
+ # @yield [result, err] Result & error if block supplied
790
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
791
+ # @yieldparam err [StandardError] error object if request failed
792
+ #
793
+ # @return [Google::Apis::HealthcareV1::Operation]
794
+ #
795
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
796
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
797
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
798
+ def query_consent_store_accessible_data(consent_store, query_accessible_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
799
+ command = make_simple_command(:post, 'v1/{+consentStore}:queryAccessibleData', options)
800
+ command.request_representation = Google::Apis::HealthcareV1::QueryAccessibleDataRequest::Representation
801
+ command.request_object = query_accessible_data_request_object
802
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
803
+ command.response_class = Google::Apis::HealthcareV1::Operation
804
+ command.params['consentStore'] = consent_store unless consent_store.nil?
805
+ command.query['fields'] = fields unless fields.nil?
806
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
807
+ execute_or_queue_command(command, &block)
808
+ end
809
+
810
+ # Sets the access control policy on the specified resource. Replaces any
811
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
812
+ # PERMISSION_DENIED` errors.
813
+ # @param [String] resource
814
+ # REQUIRED: The resource for which the policy is being specified. See the
815
+ # operation documentation for the appropriate value for this field.
816
+ # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object
817
+ # @param [String] fields
818
+ # Selector specifying which fields to include in a partial response.
819
+ # @param [String] quota_user
820
+ # Available to use for quota purposes for server-side applications. Can be any
821
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
822
+ # @param [Google::Apis::RequestOptions] options
823
+ # Request-specific options
824
+ #
825
+ # @yield [result, err] Result & error if block supplied
826
+ # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
827
+ # @yieldparam err [StandardError] error object if request failed
828
+ #
829
+ # @return [Google::Apis::HealthcareV1::Policy]
830
+ #
831
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
832
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
833
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
834
+ def set_consent_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
835
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
836
+ command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
837
+ command.request_object = set_iam_policy_request_object
838
+ command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
839
+ command.response_class = Google::Apis::HealthcareV1::Policy
840
+ command.params['resource'] = resource unless resource.nil?
841
+ command.query['fields'] = fields unless fields.nil?
842
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
843
+ execute_or_queue_command(command, &block)
844
+ end
845
+
846
+ # Returns permissions that a caller has on the specified resource. If the
847
+ # resource does not exist, this will return an empty set of permissions, not a `
848
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
849
+ # permission-aware UIs and command-line tools, not for authorization checking.
850
+ # This operation may "fail open" without warning.
851
+ # @param [String] resource
852
+ # REQUIRED: The resource for which the policy detail is being requested. See the
853
+ # operation documentation for the appropriate value for this field.
854
+ # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object
855
+ # @param [String] fields
856
+ # Selector specifying which fields to include in a partial response.
857
+ # @param [String] quota_user
858
+ # Available to use for quota purposes for server-side applications. Can be any
859
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
860
+ # @param [Google::Apis::RequestOptions] options
861
+ # Request-specific options
862
+ #
863
+ # @yield [result, err] Result & error if block supplied
864
+ # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
865
+ # @yieldparam err [StandardError] error object if request failed
866
+ #
867
+ # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
868
+ #
869
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
870
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
871
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
872
+ def test_consent_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
873
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
874
+ command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
875
+ command.request_object = test_iam_permissions_request_object
876
+ command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
877
+ command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
878
+ command.params['resource'] = resource unless resource.nil?
879
+ command.query['fields'] = fields unless fields.nil?
880
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
881
+ execute_or_queue_command(command, &block)
882
+ end
883
+
884
+ # Creates a new Attribute definition in the parent consent store.
885
+ # @param [String] parent
886
+ # Required. The name of the consent store that this Attribute definition belongs
887
+ # to.
888
+ # @param [Google::Apis::HealthcareV1::AttributeDefinition] attribute_definition_object
889
+ # @param [String] attribute_definition_id
890
+ # Required. The ID of the Attribute definition to create. The string must match
891
+ # the following regex: `_a-zA-Z`0,255`` and must not be a reserved keyword
892
+ # within the Common Expression Language as listed on https://github.com/google/
893
+ # cel-spec/blob/master/doc/langdef.md.
894
+ # @param [String] fields
895
+ # Selector specifying which fields to include in a partial response.
896
+ # @param [String] quota_user
897
+ # Available to use for quota purposes for server-side applications. Can be any
898
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
899
+ # @param [Google::Apis::RequestOptions] options
900
+ # Request-specific options
901
+ #
902
+ # @yield [result, err] Result & error if block supplied
903
+ # @yieldparam result [Google::Apis::HealthcareV1::AttributeDefinition] parsed result object
904
+ # @yieldparam err [StandardError] error object if request failed
905
+ #
906
+ # @return [Google::Apis::HealthcareV1::AttributeDefinition]
907
+ #
908
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
909
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
910
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
911
+ def create_project_location_dataset_consent_store_attribute_definition(parent, attribute_definition_object = nil, attribute_definition_id: nil, fields: nil, quota_user: nil, options: nil, &block)
912
+ command = make_simple_command(:post, 'v1/{+parent}/attributeDefinitions', options)
913
+ command.request_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
914
+ command.request_object = attribute_definition_object
915
+ command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
916
+ command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
917
+ command.params['parent'] = parent unless parent.nil?
918
+ command.query['attributeDefinitionId'] = attribute_definition_id unless attribute_definition_id.nil?
919
+ command.query['fields'] = fields unless fields.nil?
920
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
921
+ execute_or_queue_command(command, &block)
922
+ end
923
+
924
+ # Deletes the specified Attribute definition. Fails if the Attribute definition
925
+ # is referenced by any User data mapping, or the latest revision of any Consent.
926
+ # @param [String] name
927
+ # Required. The resource name of the Attribute definition to delete. To preserve
928
+ # referential integrity, Attribute definitions referenced by a User data mapping
929
+ # or the latest revision of a Consent cannot be deleted.
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::Empty] parsed result object
940
+ # @yieldparam err [StandardError] error object if request failed
941
+ #
942
+ # @return [Google::Apis::HealthcareV1::Empty]
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 delete_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil, &block)
948
+ command = make_simple_command(:delete, 'v1/{+name}', options)
949
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
950
+ command.response_class = Google::Apis::HealthcareV1::Empty
951
+ command.params['name'] = name unless name.nil?
952
+ command.query['fields'] = fields unless fields.nil?
953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
954
+ execute_or_queue_command(command, &block)
955
+ end
956
+
957
+ # Gets the specified Attribute definition.
958
+ # @param [String] name
959
+ # Required. The resource name of the Attribute definition to get.
960
+ # @param [String] fields
961
+ # Selector specifying which fields to include in a partial response.
962
+ # @param [String] quota_user
963
+ # Available to use for quota purposes for server-side applications. Can be any
964
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
965
+ # @param [Google::Apis::RequestOptions] options
966
+ # Request-specific options
967
+ #
968
+ # @yield [result, err] Result & error if block supplied
969
+ # @yieldparam result [Google::Apis::HealthcareV1::AttributeDefinition] parsed result object
970
+ # @yieldparam err [StandardError] error object if request failed
971
+ #
972
+ # @return [Google::Apis::HealthcareV1::AttributeDefinition]
973
+ #
974
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
975
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
976
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
977
+ def get_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil, &block)
978
+ command = make_simple_command(:get, 'v1/{+name}', options)
979
+ command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
980
+ command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
981
+ command.params['name'] = name unless name.nil?
982
+ command.query['fields'] = fields unless fields.nil?
983
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
984
+ execute_or_queue_command(command, &block)
985
+ end
986
+
987
+ # Lists the Attribute definitions in the specified consent store.
988
+ # @param [String] parent
989
+ # Required. Name of the consent store to retrieve Attribute definitions from.
990
+ # @param [String] filter
991
+ # Optional. Restricts the attributes returned to those matching a filter. The
992
+ # only field available for filtering is `category`. For example, `filter=
993
+ # category=\"REQUEST\"`.
994
+ # @param [Fixnum] page_size
995
+ # Optional. Limit on the number of Attribute definitions to return in a single
996
+ # response. If not specified, 100 is used. May not be larger than 1000.
997
+ # @param [String] page_token
998
+ # Optional. Token to retrieve the next page of results or empty to get the first
999
+ # page.
1000
+ # @param [String] fields
1001
+ # Selector specifying which fields to include in a partial response.
1002
+ # @param [String] quota_user
1003
+ # Available to use for quota purposes for server-side applications. Can be any
1004
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1005
+ # @param [Google::Apis::RequestOptions] options
1006
+ # Request-specific options
1007
+ #
1008
+ # @yield [result, err] Result & error if block supplied
1009
+ # @yieldparam result [Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse] parsed result object
1010
+ # @yieldparam err [StandardError] error object if request failed
1011
+ #
1012
+ # @return [Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse]
1013
+ #
1014
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1015
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1016
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1017
+ def list_project_location_dataset_consent_store_attribute_definitions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1018
+ command = make_simple_command(:get, 'v1/{+parent}/attributeDefinitions', options)
1019
+ command.response_representation = Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse::Representation
1020
+ command.response_class = Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse
1021
+ command.params['parent'] = parent unless parent.nil?
1022
+ command.query['filter'] = filter unless filter.nil?
1023
+ command.query['pageSize'] = page_size unless page_size.nil?
1024
+ command.query['pageToken'] = page_token unless page_token.nil?
1025
+ command.query['fields'] = fields unless fields.nil?
1026
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1027
+ execute_or_queue_command(command, &block)
1028
+ end
1029
+
1030
+ # Updates the specified Attribute definition.
1031
+ # @param [String] name
1032
+ # Resource name of the Attribute definition, of the form `projects/`project_id`/
1033
+ # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1034
+ # attributeDefinitions/`attribute_definition_id``. Cannot be changed after
1035
+ # creation.
1036
+ # @param [Google::Apis::HealthcareV1::AttributeDefinition] attribute_definition_object
1037
+ # @param [String] update_mask
1038
+ # Required. The update mask that applies to the resource. For the `FieldMask`
1039
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1040
+ # google.protobuf#fieldmask. Only the `description`, `allowed_values`, `
1041
+ # consent_default_values` and `data_mapping_default_value` fields can be updated.
1042
+ # The updated `allowed_values` must contain all values from the previous `
1043
+ # allowed_values`.
1044
+ # @param [String] fields
1045
+ # Selector specifying which fields to include in a partial response.
1046
+ # @param [String] quota_user
1047
+ # Available to use for quota purposes for server-side applications. Can be any
1048
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1049
+ # @param [Google::Apis::RequestOptions] options
1050
+ # Request-specific options
1051
+ #
1052
+ # @yield [result, err] Result & error if block supplied
1053
+ # @yieldparam result [Google::Apis::HealthcareV1::AttributeDefinition] parsed result object
1054
+ # @yieldparam err [StandardError] error object if request failed
1055
+ #
1056
+ # @return [Google::Apis::HealthcareV1::AttributeDefinition]
1057
+ #
1058
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1059
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1060
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1061
+ def patch_project_location_dataset_consent_store_attribute_definition(name, attribute_definition_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1062
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1063
+ command.request_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
1064
+ command.request_object = attribute_definition_object
1065
+ command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
1066
+ command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
1067
+ command.params['name'] = name unless name.nil?
1068
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1069
+ command.query['fields'] = fields unless fields.nil?
1070
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1071
+ execute_or_queue_command(command, &block)
1072
+ end
1073
+
1074
+ # Creates a new Consent artifact in the parent consent store.
1075
+ # @param [String] parent
1076
+ # Required. The name of the consent store this Consent artifact belongs to.
1077
+ # @param [Google::Apis::HealthcareV1::ConsentArtifact] consent_artifact_object
1078
+ # @param [String] fields
1079
+ # Selector specifying which fields to include in a partial response.
1080
+ # @param [String] quota_user
1081
+ # Available to use for quota purposes for server-side applications. Can be any
1082
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1083
+ # @param [Google::Apis::RequestOptions] options
1084
+ # Request-specific options
1085
+ #
1086
+ # @yield [result, err] Result & error if block supplied
1087
+ # @yieldparam result [Google::Apis::HealthcareV1::ConsentArtifact] parsed result object
1088
+ # @yieldparam err [StandardError] error object if request failed
1089
+ #
1090
+ # @return [Google::Apis::HealthcareV1::ConsentArtifact]
1091
+ #
1092
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1093
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1094
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1095
+ def create_project_location_dataset_consent_store_consent_artifact(parent, consent_artifact_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1096
+ command = make_simple_command(:post, 'v1/{+parent}/consentArtifacts', options)
1097
+ command.request_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
1098
+ command.request_object = consent_artifact_object
1099
+ command.response_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
1100
+ command.response_class = Google::Apis::HealthcareV1::ConsentArtifact
1101
+ command.params['parent'] = parent unless parent.nil?
1102
+ command.query['fields'] = fields unless fields.nil?
1103
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1104
+ execute_or_queue_command(command, &block)
1105
+ end
1106
+
1107
+ # Deletes the specified Consent artifact. Fails if the artifact is referenced by
1108
+ # the latest revision of any Consent.
1109
+ # @param [String] name
1110
+ # Required. The resource name of the Consent artifact to delete. To preserve
1111
+ # referential integrity, Consent artifacts referenced by the latest revision of
1112
+ # a Consent cannot be deleted.
1113
+ # @param [String] fields
1114
+ # Selector specifying which fields to include in a partial response.
1115
+ # @param [String] quota_user
1116
+ # Available to use for quota purposes for server-side applications. Can be any
1117
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1118
+ # @param [Google::Apis::RequestOptions] options
1119
+ # Request-specific options
1120
+ #
1121
+ # @yield [result, err] Result & error if block supplied
1122
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1123
+ # @yieldparam err [StandardError] error object if request failed
1124
+ #
1125
+ # @return [Google::Apis::HealthcareV1::Empty]
1126
+ #
1127
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1128
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1129
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1130
+ def delete_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil, &block)
1131
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1132
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
1133
+ command.response_class = Google::Apis::HealthcareV1::Empty
1134
+ command.params['name'] = name unless name.nil?
1135
+ command.query['fields'] = fields unless fields.nil?
1136
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1137
+ execute_or_queue_command(command, &block)
1138
+ end
1139
+
1140
+ # Gets the specified Consent artifact.
1141
+ # @param [String] name
1142
+ # Required. The resource name of the Consent artifact to retrieve.
1143
+ # @param [String] fields
1144
+ # Selector specifying which fields to include in a partial response.
1145
+ # @param [String] quota_user
1146
+ # Available to use for quota purposes for server-side applications. Can be any
1147
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1148
+ # @param [Google::Apis::RequestOptions] options
1149
+ # Request-specific options
1150
+ #
1151
+ # @yield [result, err] Result & error if block supplied
1152
+ # @yieldparam result [Google::Apis::HealthcareV1::ConsentArtifact] parsed result object
1153
+ # @yieldparam err [StandardError] error object if request failed
1154
+ #
1155
+ # @return [Google::Apis::HealthcareV1::ConsentArtifact]
1156
+ #
1157
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1158
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1159
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1160
+ def get_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil, &block)
1161
+ command = make_simple_command(:get, 'v1/{+name}', options)
1162
+ command.response_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
1163
+ command.response_class = Google::Apis::HealthcareV1::ConsentArtifact
1164
+ command.params['name'] = name unless name.nil?
1165
+ command.query['fields'] = fields unless fields.nil?
1166
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1167
+ execute_or_queue_command(command, &block)
1168
+ end
1169
+
1170
+ # Lists the Consent artifacts in the specified consent store.
1171
+ # @param [String] parent
1172
+ # Required. Name of the consent store to retrieve consent artifacts from.
1173
+ # @param [String] filter
1174
+ # Optional. Restricts the artifacts returned to those matching a filter. The
1175
+ # following syntax is available: * A string field value can be written as text
1176
+ # inside quotation marks, for example `"query text"`. The only valid relational
1177
+ # operation for text fields is equality (`=`), where text is searched within the
1178
+ # field, rather than having the field be equal to the text. For example, `"
1179
+ # Comment = great"` returns messages with `great` in the comment field. * A
1180
+ # number field value can be written as an integer, a decimal, or an exponential.
1181
+ # The valid relational operators for number fields are the equality operator (`=`
1182
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1183
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1184
+ # operator to an expression to negate it. * A date field value must be written
1185
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1186
+ # Leading zeros are required for one-digit months and days. The valid relational
1187
+ # operators for date fields are the equality operator (`=`) , along with the
1188
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1189
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1190
+ # expression to negate it. * Multiple field query expressions can be combined in
1191
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1192
+ # boolean operator appears within a quoted string, it is not treated as special,
1193
+ # it's just another part of the character string to be matched. You can prepend
1194
+ # the `NOT` operator to an expression to negate it. The fields available for
1195
+ # filtering are: - user_id. For example, `filter=user_id=\"user123\"`. -
1196
+ # consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=
1197
+ # \"value\"` or `filter=HasMetadata(\"testkey\")`.
87
1198
  # @param [Fixnum] page_size
88
- # The standard list page size.
1199
+ # Optional. Limit on the number of consent artifacts to return in a single
1200
+ # response. If not specified, 100 is used. May not be larger than 1000.
89
1201
  # @param [String] page_token
90
- # The standard list page token.
1202
+ # Optional. The next_page_token value returned from the previous List request,
1203
+ # if any.
1204
+ # @param [String] fields
1205
+ # Selector specifying which fields to include in a partial response.
1206
+ # @param [String] quota_user
1207
+ # Available to use for quota purposes for server-side applications. Can be any
1208
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1209
+ # @param [Google::Apis::RequestOptions] options
1210
+ # Request-specific options
1211
+ #
1212
+ # @yield [result, err] Result & error if block supplied
1213
+ # @yieldparam result [Google::Apis::HealthcareV1::ListConsentArtifactsResponse] parsed result object
1214
+ # @yieldparam err [StandardError] error object if request failed
1215
+ #
1216
+ # @return [Google::Apis::HealthcareV1::ListConsentArtifactsResponse]
1217
+ #
1218
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1219
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1220
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1221
+ def list_project_location_dataset_consent_store_consent_artifacts(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1222
+ command = make_simple_command(:get, 'v1/{+parent}/consentArtifacts', options)
1223
+ command.response_representation = Google::Apis::HealthcareV1::ListConsentArtifactsResponse::Representation
1224
+ command.response_class = Google::Apis::HealthcareV1::ListConsentArtifactsResponse
1225
+ command.params['parent'] = parent unless parent.nil?
1226
+ command.query['filter'] = filter unless filter.nil?
1227
+ command.query['pageSize'] = page_size unless page_size.nil?
1228
+ command.query['pageToken'] = page_token unless page_token.nil?
1229
+ command.query['fields'] = fields unless fields.nil?
1230
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1231
+ execute_or_queue_command(command, &block)
1232
+ end
1233
+
1234
+ # Activates the latest revision of the specified Consent by committing a new
1235
+ # revision with `state` updated to `ACTIVE`. If the latest revision of the
1236
+ # specified Consent is in the `ACTIVE` state, no new revision is committed. A
1237
+ # FAILED_PRECONDITION error occurs if the latest revision of the specified
1238
+ # Consent is in the `REJECTED` or `REVOKED` state.
1239
+ # @param [String] name
1240
+ # Required. The resource name of the Consent to activate, of the form `projects/`
1241
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1242
+ # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1243
+ # revision_id` is specified in the name.
1244
+ # @param [Google::Apis::HealthcareV1::ActivateConsentRequest] activate_consent_request_object
1245
+ # @param [String] fields
1246
+ # Selector specifying which fields to include in a partial response.
1247
+ # @param [String] quota_user
1248
+ # Available to use for quota purposes for server-side applications. Can be any
1249
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1250
+ # @param [Google::Apis::RequestOptions] options
1251
+ # Request-specific options
1252
+ #
1253
+ # @yield [result, err] Result & error if block supplied
1254
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
1255
+ # @yieldparam err [StandardError] error object if request failed
1256
+ #
1257
+ # @return [Google::Apis::HealthcareV1::Consent]
1258
+ #
1259
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1260
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1261
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1262
+ def activate_consent(name, activate_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1263
+ command = make_simple_command(:post, 'v1/{+name}:activate', options)
1264
+ command.request_representation = Google::Apis::HealthcareV1::ActivateConsentRequest::Representation
1265
+ command.request_object = activate_consent_request_object
1266
+ command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
1267
+ command.response_class = Google::Apis::HealthcareV1::Consent
1268
+ command.params['name'] = name unless name.nil?
1269
+ command.query['fields'] = fields unless fields.nil?
1270
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1271
+ execute_or_queue_command(command, &block)
1272
+ end
1273
+
1274
+ # Creates a new Consent in the parent consent store.
1275
+ # @param [String] parent
1276
+ # Required. Name of the consent store.
1277
+ # @param [Google::Apis::HealthcareV1::Consent] consent_object
1278
+ # @param [String] fields
1279
+ # Selector specifying which fields to include in a partial response.
1280
+ # @param [String] quota_user
1281
+ # Available to use for quota purposes for server-side applications. Can be any
1282
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1283
+ # @param [Google::Apis::RequestOptions] options
1284
+ # Request-specific options
1285
+ #
1286
+ # @yield [result, err] Result & error if block supplied
1287
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
1288
+ # @yieldparam err [StandardError] error object if request failed
1289
+ #
1290
+ # @return [Google::Apis::HealthcareV1::Consent]
1291
+ #
1292
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1293
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1294
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1295
+ def create_project_location_dataset_consent_store_consent(parent, consent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1296
+ command = make_simple_command(:post, 'v1/{+parent}/consents', options)
1297
+ command.request_representation = Google::Apis::HealthcareV1::Consent::Representation
1298
+ command.request_object = consent_object
1299
+ command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
1300
+ command.response_class = Google::Apis::HealthcareV1::Consent
1301
+ command.params['parent'] = parent unless parent.nil?
1302
+ command.query['fields'] = fields unless fields.nil?
1303
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1304
+ execute_or_queue_command(command, &block)
1305
+ end
1306
+
1307
+ # Deletes the Consent and its revisions. To keep a record of the Consent but
1308
+ # mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [
1309
+ # DeleteConsentRevision]. This operation does not delete the related Consent
1310
+ # artifact.
1311
+ # @param [String] name
1312
+ # Required. The resource name of the Consent to delete, of the form `projects/`
1313
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1314
+ # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1315
+ # revision_id` is specified in the name.
1316
+ # @param [String] fields
1317
+ # Selector specifying which fields to include in a partial response.
1318
+ # @param [String] quota_user
1319
+ # Available to use for quota purposes for server-side applications. Can be any
1320
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1321
+ # @param [Google::Apis::RequestOptions] options
1322
+ # Request-specific options
1323
+ #
1324
+ # @yield [result, err] Result & error if block supplied
1325
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1326
+ # @yieldparam err [StandardError] error object if request failed
1327
+ #
1328
+ # @return [Google::Apis::HealthcareV1::Empty]
1329
+ #
1330
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1331
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1332
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1333
+ def delete_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil, &block)
1334
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1335
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
1336
+ command.response_class = Google::Apis::HealthcareV1::Empty
1337
+ command.params['name'] = name unless name.nil?
1338
+ command.query['fields'] = fields unless fields.nil?
1339
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1340
+ execute_or_queue_command(command, &block)
1341
+ end
1342
+
1343
+ # Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs
1344
+ # if the specified revision is the latest revision.
1345
+ # @param [String] name
1346
+ # Required. The resource name of the Consent revision to delete, of the form `
1347
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1348
+ # consentStores/`consent_store_id`/consents/`consent_id`@`revision_id``. An
1349
+ # INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.
1350
+ # @param [String] fields
1351
+ # Selector specifying which fields to include in a partial response.
1352
+ # @param [String] quota_user
1353
+ # Available to use for quota purposes for server-side applications. Can be any
1354
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1355
+ # @param [Google::Apis::RequestOptions] options
1356
+ # Request-specific options
1357
+ #
1358
+ # @yield [result, err] Result & error if block supplied
1359
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1360
+ # @yieldparam err [StandardError] error object if request failed
1361
+ #
1362
+ # @return [Google::Apis::HealthcareV1::Empty]
1363
+ #
1364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1367
+ def delete_project_location_dataset_consent_store_consent_revision(name, fields: nil, quota_user: nil, options: nil, &block)
1368
+ command = make_simple_command(:delete, 'v1/{+name}:deleteRevision', options)
1369
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
1370
+ command.response_class = Google::Apis::HealthcareV1::Empty
1371
+ command.params['name'] = name unless name.nil?
1372
+ command.query['fields'] = fields unless fields.nil?
1373
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1374
+ execute_or_queue_command(command, &block)
1375
+ end
1376
+
1377
+ # Gets the specified revision of a Consent, or the latest revision if `
1378
+ # revision_id` is not specified in the resource name.
1379
+ # @param [String] name
1380
+ # Required. The resource name of the Consent to retrieve, of the form `projects/`
1381
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1382
+ # consent_store_id`/consents/`consent_id``. In order to retrieve a previous
1383
+ # revision of the Consent, also provide the revision ID: `projects/`project_id`/
1384
+ # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1385
+ # consents/`consent_id`@`revision_id``
1386
+ # @param [String] fields
1387
+ # Selector specifying which fields to include in a partial response.
1388
+ # @param [String] quota_user
1389
+ # Available to use for quota purposes for server-side applications. Can be any
1390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1391
+ # @param [Google::Apis::RequestOptions] options
1392
+ # Request-specific options
1393
+ #
1394
+ # @yield [result, err] Result & error if block supplied
1395
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
1396
+ # @yieldparam err [StandardError] error object if request failed
1397
+ #
1398
+ # @return [Google::Apis::HealthcareV1::Consent]
1399
+ #
1400
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1401
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1402
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1403
+ def get_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil, &block)
1404
+ command = make_simple_command(:get, 'v1/{+name}', options)
1405
+ command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
1406
+ command.response_class = Google::Apis::HealthcareV1::Consent
1407
+ command.params['name'] = name unless name.nil?
1408
+ command.query['fields'] = fields unless fields.nil?
1409
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1410
+ execute_or_queue_command(command, &block)
1411
+ end
1412
+
1413
+ # Lists the Consent in the given consent store, returning each Consent's latest
1414
+ # revision.
1415
+ # @param [String] parent
1416
+ # Required. Name of the consent store to retrieve Consents from.
1417
+ # @param [String] filter
1418
+ # Optional. Restricts the Consents returned to those matching a filter. The
1419
+ # following syntax is available: * A string field value can be written as text
1420
+ # inside quotation marks, for example `"query text"`. The only valid relational
1421
+ # operation for text fields is equality (`=`), where text is searched within the
1422
+ # field, rather than having the field be equal to the text. For example, `"
1423
+ # Comment = great"` returns messages with `great` in the comment field. * A
1424
+ # number field value can be written as an integer, a decimal, or an exponential.
1425
+ # The valid relational operators for number fields are the equality operator (`=`
1426
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1427
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1428
+ # operator to an expression to negate it. * A date field value must be written
1429
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1430
+ # Leading zeros are required for one-digit months and days. The valid relational
1431
+ # operators for date fields are the equality operator (`=`) , along with the
1432
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1433
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1434
+ # expression to negate it. * Multiple field query expressions can be combined in
1435
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1436
+ # boolean operator appears within a quoted string, it is not treated as special,
1437
+ # it's just another part of the character string to be matched. You can prepend
1438
+ # the `NOT` operator to an expression to negate it. The fields available for
1439
+ # filtering are: - user_id. For example, `filter='user_id="user123"'`. -
1440
+ # consent_artifact - state - revision_create_time - metadata. For example, `
1441
+ # filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
1442
+ # @param [Fixnum] page_size
1443
+ # Optional. Limit on the number of Consents to return in a single response. If
1444
+ # not specified, 100 is used. May not be larger than 1000.
1445
+ # @param [String] page_token
1446
+ # Optional. The next_page_token value returned from the previous List request,
1447
+ # if any.
1448
+ # @param [String] fields
1449
+ # Selector specifying which fields to include in a partial response.
1450
+ # @param [String] quota_user
1451
+ # Available to use for quota purposes for server-side applications. Can be any
1452
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1453
+ # @param [Google::Apis::RequestOptions] options
1454
+ # Request-specific options
1455
+ #
1456
+ # @yield [result, err] Result & error if block supplied
1457
+ # @yieldparam result [Google::Apis::HealthcareV1::ListConsentsResponse] parsed result object
1458
+ # @yieldparam err [StandardError] error object if request failed
1459
+ #
1460
+ # @return [Google::Apis::HealthcareV1::ListConsentsResponse]
1461
+ #
1462
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1463
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1464
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1465
+ def list_project_location_dataset_consent_store_consents(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1466
+ command = make_simple_command(:get, 'v1/{+parent}/consents', options)
1467
+ command.response_representation = Google::Apis::HealthcareV1::ListConsentsResponse::Representation
1468
+ command.response_class = Google::Apis::HealthcareV1::ListConsentsResponse
1469
+ command.params['parent'] = parent unless parent.nil?
1470
+ command.query['filter'] = filter unless filter.nil?
1471
+ command.query['pageSize'] = page_size unless page_size.nil?
1472
+ command.query['pageToken'] = page_token unless page_token.nil?
1473
+ command.query['fields'] = fields unless fields.nil?
1474
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1475
+ execute_or_queue_command(command, &block)
1476
+ end
1477
+
1478
+ # Lists the revisions of the specified Consent in reverse chronological order.
1479
+ # @param [String] name
1480
+ # Required. The resource name of the Consent to retrieve revisions for.
1481
+ # @param [String] filter
1482
+ # Optional. Restricts the revisions returned to those matching a filter. The
1483
+ # following syntax is available: * A string field value can be written as text
1484
+ # inside quotation marks, for example `"query text"`. The only valid relational
1485
+ # operation for text fields is equality (`=`), where text is searched within the
1486
+ # field, rather than having the field be equal to the text. For example, `"
1487
+ # Comment = great"` returns messages with `great` in the comment field. * A
1488
+ # number field value can be written as an integer, a decimal, or an exponential.
1489
+ # The valid relational operators for number fields are the equality operator (`=`
1490
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1491
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1492
+ # operator to an expression to negate it. * A date field value must be written
1493
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1494
+ # Leading zeros are required for one-digit months and days. The valid relational
1495
+ # operators for date fields are the equality operator (`=`) , along with the
1496
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1497
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1498
+ # expression to negate it. * Multiple field query expressions can be combined in
1499
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1500
+ # boolean operator appears within a quoted string, it is not treated as special,
1501
+ # it's just another part of the character string to be matched. You can prepend
1502
+ # the `NOT` operator to an expression to negate it. Fields available for
1503
+ # filtering are: - user_id. For example, `filter='user_id="user123"'`. -
1504
+ # consent_artifact - state - revision_create_time - metadata. For example, `
1505
+ # filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
1506
+ # @param [Fixnum] page_size
1507
+ # Optional. Limit on the number of revisions to return in a single response. If
1508
+ # not specified, 100 is used. May not be larger than 1000.
1509
+ # @param [String] page_token
1510
+ # Optional. Token to retrieve the next page of results or empty if there are no
1511
+ # more results in the list.
91
1512
  # @param [String] fields
92
1513
  # Selector specifying which fields to include in a partial response.
93
1514
  # @param [String] quota_user
@@ -97,18 +1518,18 @@ module Google
97
1518
  # Request-specific options
98
1519
  #
99
1520
  # @yield [result, err] Result & error if block supplied
100
- # @yieldparam result [Google::Apis::HealthcareV1::ListLocationsResponse] parsed result object
1521
+ # @yieldparam result [Google::Apis::HealthcareV1::ListConsentRevisionsResponse] parsed result object
101
1522
  # @yieldparam err [StandardError] error object if request failed
102
1523
  #
103
- # @return [Google::Apis::HealthcareV1::ListLocationsResponse]
1524
+ # @return [Google::Apis::HealthcareV1::ListConsentRevisionsResponse]
104
1525
  #
105
1526
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
106
1527
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
107
1528
  # @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
1529
+ def list_project_location_dataset_consent_store_consent_revisions(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1530
+ command = make_simple_command(:get, 'v1/{+name}:listRevisions', options)
1531
+ command.response_representation = Google::Apis::HealthcareV1::ListConsentRevisionsResponse::Representation
1532
+ command.response_class = Google::Apis::HealthcareV1::ListConsentRevisionsResponse
112
1533
  command.params['name'] = name unless name.nil?
113
1534
  command.query['filter'] = filter unless filter.nil?
114
1535
  command.query['pageSize'] = page_size unless page_size.nil?
@@ -118,16 +1539,19 @@ module Google
118
1539
  execute_or_queue_command(command, &block)
119
1540
  end
120
1541
 
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``.
1542
+ # Updates the latest revision of the specified Consent by committing a new
1543
+ # revision with the changes. A FAILED_PRECONDITION error occurs if the latest
1544
+ # revision of the specified Consent is in the `REJECTED` or `REVOKED` state.
1545
+ # @param [String] name
1546
+ # Resource name of the Consent, of the form `projects/`project_id`/locations/`
1547
+ # location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
1548
+ # consent_id``. Cannot be changed after creation.
1549
+ # @param [Google::Apis::HealthcareV1::Consent] consent_object
1550
+ # @param [String] update_mask
1551
+ # Required. The update mask to apply to the resource. For the `FieldMask`
1552
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1553
+ # google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`,
1554
+ # and `metadata` fields can be updated.
131
1555
  # @param [String] fields
132
1556
  # Selector specifying which fields to include in a partial response.
133
1557
  # @param [String] quota_user
@@ -137,39 +1561,38 @@ module Google
137
1561
  # Request-specific options
138
1562
  #
139
1563
  # @yield [result, err] Result & error if block supplied
140
- # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
1564
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
141
1565
  # @yieldparam err [StandardError] error object if request failed
142
1566
  #
143
- # @return [Google::Apis::HealthcareV1::Operation]
1567
+ # @return [Google::Apis::HealthcareV1::Consent]
144
1568
  #
145
1569
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
146
1570
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
147
1571
  # @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?
1572
+ def patch_project_location_dataset_consent_store_consent(name, consent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1573
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1574
+ command.request_representation = Google::Apis::HealthcareV1::Consent::Representation
1575
+ command.request_object = consent_object
1576
+ command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
1577
+ command.response_class = Google::Apis::HealthcareV1::Consent
1578
+ command.params['name'] = name unless name.nil?
1579
+ command.query['updateMask'] = update_mask unless update_mask.nil?
156
1580
  command.query['fields'] = fields unless fields.nil?
157
1581
  command.query['quotaUser'] = quota_user unless quota_user.nil?
158
1582
  execute_or_queue_command(command, &block)
159
1583
  end
160
1584
 
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
1585
+ # Rejects the latest revision of the specified Consent by committing a new
1586
+ # revision with `state` updated to `REJECTED`. If the latest revision of the
1587
+ # specified Consent is in the `REJECTED` state, no new revision is committed. A
1588
+ # FAILED_PRECONDITION error occurs if the latest revision of the specified
1589
+ # Consent is in the `ACTIVE` or `REVOKED` state.
1590
+ # @param [String] name
1591
+ # Required. The resource name of the Consent to reject, of the form `projects/`
1592
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1593
+ # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1594
+ # revision_id` is specified in the name.
1595
+ # @param [Google::Apis::HealthcareV1::RejectConsentRequest] reject_consent_request_object
173
1596
  # @param [String] fields
174
1597
  # Selector specifying which fields to include in a partial response.
175
1598
  # @param [String] quota_user
@@ -179,32 +1602,37 @@ module Google
179
1602
  # Request-specific options
180
1603
  #
181
1604
  # @yield [result, err] Result & error if block supplied
182
- # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
1605
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
183
1606
  # @yieldparam err [StandardError] error object if request failed
184
1607
  #
185
- # @return [Google::Apis::HealthcareV1::Operation]
1608
+ # @return [Google::Apis::HealthcareV1::Consent]
186
1609
  #
187
1610
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
188
1611
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
189
1612
  # @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?
1613
+ def reject_consent(name, reject_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1614
+ command = make_simple_command(:post, 'v1/{+name}:reject', options)
1615
+ command.request_representation = Google::Apis::HealthcareV1::RejectConsentRequest::Representation
1616
+ command.request_object = reject_consent_request_object
1617
+ command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
1618
+ command.response_class = Google::Apis::HealthcareV1::Consent
1619
+ command.params['name'] = name unless name.nil?
197
1620
  command.query['fields'] = fields unless fields.nil?
198
1621
  command.query['quotaUser'] = quota_user unless quota_user.nil?
199
1622
  execute_or_queue_command(command, &block)
200
1623
  end
201
1624
 
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).
1625
+ # Revokes the latest revision of the specified Consent by committing a new
1626
+ # revision with `state` updated to `REVOKED`. If the latest revision of the
1627
+ # specified Consent is in the `REVOKED` state, no new revision is committed. A
1628
+ # FAILED_PRECONDITION error occurs if the latest revision of the given consent
1629
+ # is in `DRAFT` or `REJECTED` state.
205
1630
  # @param [String] name
206
- # The name of the dataset to delete. For example, `projects/`project_id`/
207
- # locations/`location_id`/datasets/`dataset_id``.
1631
+ # Required. The resource name of the Consent to revoke, of the form `projects/`
1632
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1633
+ # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1634
+ # revision_id` is specified in the name.
1635
+ # @param [Google::Apis::HealthcareV1::RevokeConsentRequest] revoke_consent_request_object
208
1636
  # @param [String] fields
209
1637
  # Selector specifying which fields to include in a partial response.
210
1638
  # @param [String] quota_user
@@ -214,28 +1642,30 @@ module Google
214
1642
  # Request-specific options
215
1643
  #
216
1644
  # @yield [result, err] Result & error if block supplied
217
- # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1645
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
218
1646
  # @yieldparam err [StandardError] error object if request failed
219
1647
  #
220
- # @return [Google::Apis::HealthcareV1::Empty]
1648
+ # @return [Google::Apis::HealthcareV1::Consent]
221
1649
  #
222
1650
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
223
1651
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
224
1652
  # @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
1653
+ def revoke_consent(name, revoke_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1654
+ command = make_simple_command(:post, 'v1/{+name}:revoke', options)
1655
+ command.request_representation = Google::Apis::HealthcareV1::RevokeConsentRequest::Representation
1656
+ command.request_object = revoke_consent_request_object
1657
+ command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
1658
+ command.response_class = Google::Apis::HealthcareV1::Consent
229
1659
  command.params['name'] = name unless name.nil?
230
1660
  command.query['fields'] = fields unless fields.nil?
231
1661
  command.query['quotaUser'] = quota_user unless quota_user.nil?
232
1662
  execute_or_queue_command(command, &block)
233
1663
  end
234
1664
 
235
- # Gets any metadata associated with a dataset.
1665
+ # Archives the specified User data mapping.
236
1666
  # @param [String] name
237
- # The name of the dataset to read. For example, `projects/`project_id`/locations/
238
- # `location_id`/datasets/`dataset_id``.
1667
+ # Required. The resource name of the User data mapping to archive.
1668
+ # @param [Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest] archive_user_data_mapping_request_object
239
1669
  # @param [String] fields
240
1670
  # Selector specifying which fields to include in a partial response.
241
1671
  # @param [String] quota_user
@@ -245,37 +1675,30 @@ module Google
245
1675
  # Request-specific options
246
1676
  #
247
1677
  # @yield [result, err] Result & error if block supplied
248
- # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
1678
+ # @yieldparam result [Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse] parsed result object
249
1679
  # @yieldparam err [StandardError] error object if request failed
250
1680
  #
251
- # @return [Google::Apis::HealthcareV1::Dataset]
1681
+ # @return [Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse]
252
1682
  #
253
1683
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
254
1684
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
255
1685
  # @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
1686
+ def archive_user_data_mapping(name, archive_user_data_mapping_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1687
+ command = make_simple_command(:post, 'v1/{+name}:archive', options)
1688
+ command.request_representation = Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest::Representation
1689
+ command.request_object = archive_user_data_mapping_request_object
1690
+ command.response_representation = Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse::Representation
1691
+ command.response_class = Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse
260
1692
  command.params['name'] = name unless name.nil?
261
1693
  command.query['fields'] = fields unless fields.nil?
262
1694
  command.query['quotaUser'] = quota_user unless quota_user.nil?
263
1695
  execute_or_queue_command(command, &block)
264
1696
  end
265
1697
 
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).
1698
+ # Creates a new User data mapping in the parent consent store.
1699
+ # @param [String] parent
1700
+ # Required. Name of the consent store.
1701
+ # @param [Google::Apis::HealthcareV1::UserDataMapping] user_data_mapping_object
279
1702
  # @param [String] fields
280
1703
  # Selector specifying which fields to include in a partial response.
281
1704
  # @param [String] quota_user
@@ -285,34 +1708,29 @@ module Google
285
1708
  # Request-specific options
286
1709
  #
287
1710
  # @yield [result, err] Result & error if block supplied
288
- # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1711
+ # @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
289
1712
  # @yieldparam err [StandardError] error object if request failed
290
1713
  #
291
- # @return [Google::Apis::HealthcareV1::Policy]
1714
+ # @return [Google::Apis::HealthcareV1::UserDataMapping]
292
1715
  #
293
1716
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
294
1717
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
295
1718
  # @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?
1719
+ def create_project_location_dataset_consent_store_user_data_mapping(parent, user_data_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1720
+ command = make_simple_command(:post, 'v1/{+parent}/userDataMappings', options)
1721
+ command.request_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
1722
+ command.request_object = user_data_mapping_object
1723
+ command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
1724
+ command.response_class = Google::Apis::HealthcareV1::UserDataMapping
1725
+ command.params['parent'] = parent unless parent.nil?
302
1726
  command.query['fields'] = fields unless fields.nil?
303
1727
  command.query['quotaUser'] = quota_user unless quota_user.nil?
304
1728
  execute_or_queue_command(command, &block)
305
1729
  end
306
1730
 
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.
1731
+ # Deletes the specified User data mapping.
1732
+ # @param [String] name
1733
+ # Required. The resource name of the User data mapping to delete.
316
1734
  # @param [String] fields
317
1735
  # Selector specifying which fields to include in a partial response.
318
1736
  # @param [String] quota_user
@@ -322,35 +1740,27 @@ module Google
322
1740
  # Request-specific options
323
1741
  #
324
1742
  # @yield [result, err] Result & error if block supplied
325
- # @yieldparam result [Google::Apis::HealthcareV1::ListDatasetsResponse] parsed result object
1743
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
326
1744
  # @yieldparam err [StandardError] error object if request failed
327
1745
  #
328
- # @return [Google::Apis::HealthcareV1::ListDatasetsResponse]
1746
+ # @return [Google::Apis::HealthcareV1::Empty]
329
1747
  #
330
1748
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
1749
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
1750
  # @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?
1751
+ def delete_project_location_dataset_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil, &block)
1752
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1753
+ command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
1754
+ command.response_class = Google::Apis::HealthcareV1::Empty
1755
+ command.params['name'] = name unless name.nil?
340
1756
  command.query['fields'] = fields unless fields.nil?
341
1757
  command.query['quotaUser'] = quota_user unless quota_user.nil?
342
1758
  execute_or_queue_command(command, &block)
343
1759
  end
344
1760
 
345
- # Updates dataset metadata.
1761
+ # Gets the specified User data mapping.
346
1762
  # @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
1763
+ # Required. The resource name of the User data mapping to retrieve.
354
1764
  # @param [String] fields
355
1765
  # Selector specifying which fields to include in a partial response.
356
1766
  # @param [String] quota_user
@@ -360,34 +1770,57 @@ module Google
360
1770
  # Request-specific options
361
1771
  #
362
1772
  # @yield [result, err] Result & error if block supplied
363
- # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
1773
+ # @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
364
1774
  # @yieldparam err [StandardError] error object if request failed
365
1775
  #
366
- # @return [Google::Apis::HealthcareV1::Dataset]
1776
+ # @return [Google::Apis::HealthcareV1::UserDataMapping]
367
1777
  #
368
1778
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
369
1779
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
370
1780
  # @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
1781
+ def get_project_location_dataset_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil, &block)
1782
+ command = make_simple_command(:get, 'v1/{+name}', options)
1783
+ command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
1784
+ command.response_class = Google::Apis::HealthcareV1::UserDataMapping
377
1785
  command.params['name'] = name unless name.nil?
378
- command.query['updateMask'] = update_mask unless update_mask.nil?
379
1786
  command.query['fields'] = fields unless fields.nil?
380
1787
  command.query['quotaUser'] = quota_user unless quota_user.nil?
381
1788
  execute_or_queue_command(command, &block)
382
1789
  end
383
1790
 
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
1791
+ # Lists the User data mappings in the specified consent store.
1792
+ # @param [String] parent
1793
+ # Required. Name of the consent store to retrieve User data mappings from.
1794
+ # @param [String] filter
1795
+ # Optional. Restricts the User data mappings returned to those matching a filter.
1796
+ # The following syntax is available: * A string field value can be written as
1797
+ # text inside quotation marks, for example `"query text"`. The only valid
1798
+ # relational operation for text fields is equality (`=`), where text is searched
1799
+ # within the field, rather than having the field be equal to the text. For
1800
+ # example, `"Comment = great"` returns messages with `great` in the comment
1801
+ # field. * A number field value can be written as an integer, a decimal, or an
1802
+ # exponential. The valid relational operators for number fields are the equality
1803
+ # operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`
1804
+ # , `>=`). Note that there is no inequality (`!=`) operator. You can prepend the
1805
+ # `NOT` operator to an expression to negate it. * A date field value must be
1806
+ # written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time
1807
+ # format. Leading zeros are required for one-digit months and days. The valid
1808
+ # relational operators for date fields are the equality operator (`=`) , along
1809
+ # with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
1810
+ # there is no inequality (`!=`) operator. You can prepend the `NOT` operator to
1811
+ # an expression to negate it. * Multiple field query expressions can be combined
1812
+ # in one query by adding `AND` or `OR` operators between the expressions. If a
1813
+ # boolean operator appears within a quoted string, it is not treated as special,
1814
+ # it's just another part of the character string to be matched. You can prepend
1815
+ # the `NOT` operator to an expression to negate it. The fields available for
1816
+ # filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\"`.
1817
+ # - archived - archive_time
1818
+ # @param [Fixnum] page_size
1819
+ # Optional. Limit on the number of User data mappings to return in a single
1820
+ # response. If not specified, 100 is used. May not be larger than 1000.
1821
+ # @param [String] page_token
1822
+ # Optional. Token to retrieve the next page of results, or empty to get the
1823
+ # first page.
391
1824
  # @param [String] fields
392
1825
  # Selector specifying which fields to include in a partial response.
393
1826
  # @param [String] quota_user
@@ -397,35 +1830,38 @@ module Google
397
1830
  # Request-specific options
398
1831
  #
399
1832
  # @yield [result, err] Result & error if block supplied
400
- # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1833
+ # @yieldparam result [Google::Apis::HealthcareV1::ListUserDataMappingsResponse] parsed result object
401
1834
  # @yieldparam err [StandardError] error object if request failed
402
1835
  #
403
- # @return [Google::Apis::HealthcareV1::Policy]
1836
+ # @return [Google::Apis::HealthcareV1::ListUserDataMappingsResponse]
404
1837
  #
405
1838
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
406
1839
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
407
1840
  # @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?
1841
+ def list_project_location_dataset_consent_store_user_data_mappings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1842
+ command = make_simple_command(:get, 'v1/{+parent}/userDataMappings', options)
1843
+ command.response_representation = Google::Apis::HealthcareV1::ListUserDataMappingsResponse::Representation
1844
+ command.response_class = Google::Apis::HealthcareV1::ListUserDataMappingsResponse
1845
+ command.params['parent'] = parent unless parent.nil?
1846
+ command.query['filter'] = filter unless filter.nil?
1847
+ command.query['pageSize'] = page_size unless page_size.nil?
1848
+ command.query['pageToken'] = page_token unless page_token.nil?
415
1849
  command.query['fields'] = fields unless fields.nil?
416
1850
  command.query['quotaUser'] = quota_user unless quota_user.nil?
417
1851
  execute_or_queue_command(command, &block)
418
1852
  end
419
1853
 
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
1854
+ # Updates the specified User data mapping.
1855
+ # @param [String] name
1856
+ # Resource name of the User data mapping, of the form `projects/`project_id`/
1857
+ # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1858
+ # userDataMappings/`user_data_mapping_id``.
1859
+ # @param [Google::Apis::HealthcareV1::UserDataMapping] user_data_mapping_object
1860
+ # @param [String] update_mask
1861
+ # Required. The update mask that applies to the resource. For the `FieldMask`
1862
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1863
+ # google.protobuf#fieldmask. Only the `data_id`, `user_id` and `
1864
+ # resource_attributes` fields can be updated.
429
1865
  # @param [String] fields
430
1866
  # Selector specifying which fields to include in a partial response.
431
1867
  # @param [String] quota_user
@@ -435,21 +1871,22 @@ module Google
435
1871
  # Request-specific options
436
1872
  #
437
1873
  # @yield [result, err] Result & error if block supplied
438
- # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
1874
+ # @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
439
1875
  # @yieldparam err [StandardError] error object if request failed
440
1876
  #
441
- # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
1877
+ # @return [Google::Apis::HealthcareV1::UserDataMapping]
442
1878
  #
443
1879
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
444
1880
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
445
1881
  # @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?
1882
+ def patch_project_location_dataset_consent_store_user_data_mapping(name, user_data_mapping_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1883
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1884
+ command.request_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
1885
+ command.request_object = user_data_mapping_object
1886
+ command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
1887
+ command.response_class = Google::Apis::HealthcareV1::UserDataMapping
1888
+ command.params['name'] = name unless name.nil?
1889
+ command.query['updateMask'] = update_mask unless update_mask.nil?
453
1890
  command.query['fields'] = fields unless fields.nil?
454
1891
  command.query['quotaUser'] = quota_user unless quota_user.nil?
455
1892
  execute_or_queue_command(command, &block)
@@ -499,7 +1936,7 @@ module Google
499
1936
  # identification fails for some DICOM instances. The output DICOM store will not
500
1937
  # contain these failed resources. Failed resource totals are tracked in
501
1938
  # Operation.metadata. Error details are also logged to Cloud Logging (see [
502
- # Viewing logs](/healthcare/docs/how-tos/logging)).
1939
+ # Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging)).
503
1940
  # @param [String] source_store
504
1941
  # Source DICOM store resource name. For example, `projects/`project_id`/
505
1942
  # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
@@ -566,8 +2003,8 @@ module Google
566
2003
 
567
2004
  # Exports data to the specified destination by copying it from the DICOM store.
568
2005
  # 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.
2006
+ # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2007
+ # logging). The metadata field type is OperationMetadata.
571
2008
  # @param [String] name
572
2009
  # The DICOM store resource name from which to export the data. For example, `
573
2010
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -674,8 +2111,9 @@ module Google
674
2111
  end
675
2112
 
676
2113
  # 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.
2114
+ # Errors are logged to Cloud Logging. For more information, see [Viewing error
2115
+ # logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2116
+ # logging). The metadata field type is OperationMetadata.
679
2117
  # @param [String] name
680
2118
  # The name of the DICOM store resource into which the data is imported. For
681
2119
  # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -714,9 +2152,28 @@ module Google
714
2152
  # @param [String] parent
715
2153
  # Name of the dataset.
716
2154
  # @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`.
2155
+ # Restricts stores returned to those matching a filter. The following syntax is
2156
+ # available: * A string field value can be written as text inside quotation
2157
+ # marks, for example `"query text"`. The only valid relational operation for
2158
+ # text fields is equality (`=`), where text is searched within the field, rather
2159
+ # than having the field be equal to the text. For example, `"Comment = great"`
2160
+ # returns messages with `great` in the comment field. * A number field value can
2161
+ # be written as an integer, a decimal, or an exponential. The valid relational
2162
+ # operators for number fields are the equality operator (`=`), along with the
2163
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
2164
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
2165
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
2166
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
2167
+ # required for one-digit months and days. The valid relational operators for
2168
+ # date fields are the equality operator (`=`) , along with the less than/greater
2169
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
2170
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
2171
+ # Multiple field query expressions can be combined in one query by adding `AND`
2172
+ # or `OR` operators between the expressions. If a boolean operator appears
2173
+ # within a quoted string, it is not treated as special, it's just another part
2174
+ # of the character string to be matched. You can prepend the `NOT` operator to
2175
+ # an expression to negate it. Only filtering on labels is supported. For example,
2176
+ # `labels.key=value`.
720
2177
  # @param [Fixnum] page_size
721
2178
  # Limit on the number of DICOM stores to return in a single response. If not
722
2179
  # specified, 100 is used. May not be larger than 1000.
@@ -1778,7 +3235,8 @@ module Google
1778
3235
  # store. The metadata field type is OperationMetadata. If the request is
1779
3236
  # successful, the response field type is DeidentifyFhirStoreSummary. If errors
1780
3237
  # occur, error is set. Error details are also logged to Cloud Logging (see [
1781
- # Viewing logs](/healthcare/docs/how-tos/logging)).
3238
+ # Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/
3239
+ # how-tos/logging)).
1782
3240
  # @param [String] source_store
1783
3241
  # Source FHIR store resource name. For example, `projects/`project_id`/locations/
1784
3242
  # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
@@ -1845,10 +3303,11 @@ module Google
1845
3303
  # Export resources from the FHIR store to the specified destination. This method
1846
3304
  # returns an Operation that can be used to track the status of the export by
1847
3305
  # 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.
3306
+ # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
3307
+ # https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
3308
+ # the operation finishes, a detailed response of type ExportResourcesResponse is
3309
+ # returned in the response field. The metadata field type for this operation is
3310
+ # OperationMetadata.
1852
3311
  # @param [String] name
1853
3312
  # The name of the FHIR store to export resource from, in the format of `projects/
1854
3313
  # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
@@ -1962,7 +3421,11 @@ module Google
1962
3421
  # method is not appropriate, consider using ExecuteBundle to load data. Every
1963
3422
  # resource in the input must contain a client-supplied ID. Each resource is
1964
3423
  # 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,
3424
+ # the FHIR store. It is strongly advised not to include or encode any sensitive
3425
+ # data such as patient identifiers in client-specified resource IDs. Those IDs
3426
+ # are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/
3427
+ # Sub notifications. Those IDs can also be contained in reference fields within
3428
+ # other resources. The import process does not enforce referential integrity,
1966
3429
  # regardless of the disable_referential_integrity setting on the FHIR store.
1967
3430
  # This allows the import of resources with arbitrary interdependencies without
1968
3431
  # considering grouping or ordering, but if the input data contains invalid
@@ -1998,10 +3461,11 @@ module Google
1998
3461
  # searchset` bundles produced by a FHIR search or Patient-everything operation.
1999
3462
  # This method returns an Operation that can be used to track the status of the
2000
3463
  # 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.
3464
+ # field, errors are also logged to Cloud Logging (see [Viewing error logs in
3465
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
3466
+ # Otherwise, when the operation finishes, a detailed response of type
3467
+ # ImportResourcesResponse is returned in the response field. The metadata field
3468
+ # type for this operation is OperationMetadata.
2005
3469
  # @param [String] name
2006
3470
  # The name of the FHIR store to import FHIR resources to, in the format of `
2007
3471
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
@@ -2040,9 +3504,28 @@ module Google
2040
3504
  # @param [String] parent
2041
3505
  # Name of the dataset.
2042
3506
  # @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`.
3507
+ # Restricts stores returned to those matching a filter. The following syntax is
3508
+ # available: * A string field value can be written as text inside quotation
3509
+ # marks, for example `"query text"`. The only valid relational operation for
3510
+ # text fields is equality (`=`), where text is searched within the field, rather
3511
+ # than having the field be equal to the text. For example, `"Comment = great"`
3512
+ # returns messages with `great` in the comment field. * A number field value can
3513
+ # be written as an integer, a decimal, or an exponential. The valid relational
3514
+ # operators for number fields are the equality operator (`=`), along with the
3515
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
3516
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
3517
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
3518
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
3519
+ # required for one-digit months and days. The valid relational operators for
3520
+ # date fields are the equality operator (`=`) , along with the less than/greater
3521
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
3522
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
3523
+ # Multiple field query expressions can be combined in one query by adding `AND`
3524
+ # or `OR` operators between the expressions. If a boolean operator appears
3525
+ # within a quoted string, it is not treated as special, it's just another part
3526
+ # of the character string to be matched. You can prepend the `NOT` operator to
3527
+ # an expression to negate it. Only filtering on labels is supported, for example
3528
+ # `labels.key=value`.
2046
3529
  # @param [Fixnum] page_size
2047
3530
  # Limit on the number of FHIR stores to return in a single response. If not
2048
3531
  # specified, 100 is used. May not be larger than 1000.
@@ -2196,21 +3679,21 @@ module Google
2196
3679
  # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](
2197
3680
  # http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#
2198
3681
  # 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](/
3682
+ # operations.html#everything)). On success, the response body contains a JSON-
3683
+ # encoded representation of a `Bundle` resource of type `searchset`, containing
3684
+ # the results of the operation. Errors generated by the FHIR store contain a
3685
+ # JSON-encoded `OperationOutcome` resource describing the reason for the error.
3686
+ # If the request cannot be mapped to a valid API method on a FHIR store, a
3687
+ # generic GCP error might be returned instead. The resources in scope for the
3688
+ # response are: * The patient resource itself. * All the resources directly
3689
+ # referenced by the patient resource. * Resources directly referencing the
3690
+ # patient resource that meet the inclusion criteria. The inclusion criteria are
3691
+ # based on the membership rules in the patient compartment definition ([DSTU2](
3692
+ # http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/
3693
+ # fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/
3694
+ # compartmentdefinition-patient.html)), which details the eligible resource
3695
+ # types and referencing search parameters. For samples that show how to call `
3696
+ # Patient-everything`, see [Getting all patient compartment resources](/
2214
3697
  # healthcare/docs/how-tos/fhir-resources#
2215
3698
  # getting_all_patient_compartment_resources).
2216
3699
  # @param [String] name
@@ -2315,8 +3798,8 @@ module Google
2315
3798
  # implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/
2316
3799
  # implement/standards/fhir/R4/http.html#capabilities)), or the [conformance
2317
3800
  # 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.
3801
+ # conformance) in the DSTU2 case. On success, the response body contains a JSON-
3802
+ # encoded representation of a `CapabilityStatement` resource.
2320
3803
  # @param [String] name
2321
3804
  # Name of the FHIR store to retrieve the capabilities for.
2322
3805
  # @param [String] fields
@@ -2352,14 +3835,14 @@ module Google
2352
3835
  # hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new
2353
3836
  # resource with a server-assigned resource ID. The request body must contain a
2354
3837
  # 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).
3838
+ # application/fhir+json`. On success, the response body contains a JSON-encoded
3839
+ # representation of the resource as it was created on the server, including the
3840
+ # server-assigned resource ID and version ID. Errors generated by the FHIR store
3841
+ # contain a JSON-encoded `OperationOutcome` resource describing the reason for
3842
+ # the error. If the request cannot be mapped to a valid API method on a FHIR
3843
+ # store, a generic GCP error might be returned instead. For samples that show
3844
+ # how to call `create`, see [Creating a FHIR resource](/healthcare/docs/how-tos/
3845
+ # fhir-resources#creating_a_fhir_resource).
2363
3846
  # @param [String] parent
2364
3847
  # The name of the FHIR store this resource belongs to.
2365
3848
  # @param [String] type
@@ -2500,10 +3983,10 @@ module Google
2500
3983
  # FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/
2501
3984
  # fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/
2502
3985
  # 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
3986
+ # html#history)). On success, the response body contains a JSON-encoded
2504
3987
  # representation of a `Bundle` resource of type `history`, containing the
2505
3988
  # version history sorted from most recent to oldest versions. Errors generated
2506
- # by the FHIR store will contain a JSON-encoded `OperationOutcome` resource
3989
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
2507
3990
  # describing the reason for the error. If the request cannot be mapped to a
2508
3991
  # valid API method on a FHIR store, a generic GCP error might be returned
2509
3992
  # instead. For samples that show how to call `history`, see [Listing FHIR
@@ -2569,11 +4052,11 @@ module Google
2569
4052
  # DSTU2 doesn't define a patch method, but the server supports it in the same
2570
4053
  # way it supports STU3. The request body must contain a JSON Patch document, and
2571
4054
  # 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
4055
+ # On success, the response body contains a JSON-encoded representation of the
4056
+ # updated resource, including the server-assigned version ID. Errors generated
4057
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
4058
+ # describing the reason for the error. If the request cannot be mapped to a
4059
+ # valid API method on a FHIR store, a generic GCP error might be returned
2577
4060
  # instead. For samples that show how to call `patch`, see [Patching a FHIR
2578
4061
  # resource](/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).
2579
4062
  # @param [String] name
@@ -2617,13 +4100,13 @@ module Google
2617
4100
  # implement/standards/fhir/STU3/http.html#cread), [R4](http://hl7.org/implement/
2618
4101
  # standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-
2619
4102
  # 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).
4103
+ # value. On success, the response body contains a JSON-encoded representation of
4104
+ # the resource. Errors generated by the FHIR store contain a JSON-encoded `
4105
+ # OperationOutcome` resource describing the reason for the error. If the request
4106
+ # cannot be mapped to a valid API method on a FHIR store, a generic GCP error
4107
+ # might be returned instead. For samples that show how to call `read`, see [
4108
+ # Getting a FHIR resource](/healthcare/docs/how-tos/fhir-resources#
4109
+ # getting_a_fhir_resource).
2627
4110
  # @param [String] name
2628
4111
  # The name of the resource to retrieve.
2629
4112
  # @param [String] fields
@@ -2661,37 +4144,39 @@ module Google
2661
4144
  # described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/
2662
4145
  # standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/
2663
4146
  # 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 [
4147
+ # html)). Supports four methods of search defined by the specification: * `GET [
2665
4148
  # 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 [
4149
+ # parameters]` to search resources of a specified type. * `POST [base]/_search?[
4150
+ # parameters]` as an alternate form having the same semantics as the `GET`
4151
+ # method across all resources. * `POST [base]/[type]/_search?[parameters]` as an
4152
+ # alternate form having the same semantics as the `GET` method for the specified
4153
+ # type. The `GET` and `POST` methods do not support compartment searches. The `
4154
+ # POST` method does not support `application/x-www-form-urlencoded` search
4155
+ # parameters. On success, the response body contains a JSON-encoded
4156
+ # representation of a `Bundle` resource of type `searchset`, containing the
4157
+ # results of the search. Errors generated by the FHIR store contain a JSON-
4158
+ # encoded `OperationOutcome` resource describing the reason for the error. If
4159
+ # the request cannot be mapped to a valid API method on a FHIR store, a generic
4160
+ # GCP error might be returned instead. The server's capability statement,
4161
+ # retrieved through capabilities, indicates what search parameters are supported
4162
+ # on each FHIR resource. A list of all search parameters defined by the
4163
+ # specification can be found in the FHIR Search Parameter Registry ([STU3](http:/
4164
+ # /hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](
4165
+ # http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)).
4166
+ # FHIR search parameters for DSTU2 can be found on each resource's definition
4167
+ # page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `
4168
+ # :in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`.
4169
+ # Supported search result parameters: `_sort`, `_count`, `_include`, `
4170
+ # _revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum
4171
+ # number of search results returned defaults to 100, which can be overridden by
4172
+ # the `_count` parameter up to a maximum limit of 1000. If there are additional
4173
+ # results, the returned `Bundle` will contain pagination links. Resources with a
4174
+ # total size larger than 5MB or a field count larger than 50,000 might not be
4175
+ # fully searchable as the server might trim its generated search index in those
4176
+ # cases. Note: FHIR resources are indexed asynchronously, so there might be a
4177
+ # slight delay between the time a resource is created or changes and when the
4178
+ # change is reflected in search results. For samples and detailed information,
4179
+ # see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [
2695
4180
  # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).
2696
4181
  # @param [String] parent
2697
4182
  # Name of the FHIR store to retrieve resources from.
@@ -2725,20 +4210,105 @@ module Google
2725
4210
  execute_or_queue_command(command, &block)
2726
4211
  end
2727
4212
 
4213
+ # Searches for resources in the given FHIR store according to criteria specified
4214
+ # as query parameters. Implements the FHIR standard search interaction ([DSTU2](
4215
+ # http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://
4216
+ # hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/
4217
+ # implement/standards/fhir/R4/http.html#search)) using the search semantics
4218
+ # described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/
4219
+ # standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/
4220
+ # fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.
4221
+ # html)). Supports four methods of search defined by the specification: * `GET [
4222
+ # base]?[parameters]` to search across all resources. * `GET [base]/[type]?[
4223
+ # parameters]` to search resources of a specified type. * `POST [base]/_search?[
4224
+ # parameters]` as an alternate form having the same semantics as the `GET`
4225
+ # method across all resources. * `POST [base]/[type]/_search?[parameters]` as an
4226
+ # alternate form having the same semantics as the `GET` method for the specified
4227
+ # type. The `GET` and `POST` methods do not support compartment searches. The `
4228
+ # POST` method does not support `application/x-www-form-urlencoded` search
4229
+ # parameters. On success, the response body contains a JSON-encoded
4230
+ # representation of a `Bundle` resource of type `searchset`, containing the
4231
+ # results of the search. Errors generated by the FHIR store contain a JSON-
4232
+ # encoded `OperationOutcome` resource describing the reason for the error. If
4233
+ # the request cannot be mapped to a valid API method on a FHIR store, a generic
4234
+ # GCP error might be returned instead. The server's capability statement,
4235
+ # retrieved through capabilities, indicates what search parameters are supported
4236
+ # on each FHIR resource. A list of all search parameters defined by the
4237
+ # specification can be found in the FHIR Search Parameter Registry ([STU3](http:/
4238
+ # /hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](
4239
+ # http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)).
4240
+ # FHIR search parameters for DSTU2 can be found on each resource's definition
4241
+ # page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `
4242
+ # :in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`.
4243
+ # Supported search result parameters: `_sort`, `_count`, `_include`, `
4244
+ # _revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum
4245
+ # number of search results returned defaults to 100, which can be overridden by
4246
+ # the `_count` parameter up to a maximum limit of 1000. If there are additional
4247
+ # results, the returned `Bundle` will contain pagination links. Resources with a
4248
+ # total size larger than 5MB or a field count larger than 50,000 might not be
4249
+ # fully searchable as the server might trim its generated search index in those
4250
+ # cases. Note: FHIR resources are indexed asynchronously, so there might be a
4251
+ # slight delay between the time a resource is created or changes and when the
4252
+ # change is reflected in search results. For samples and detailed information,
4253
+ # see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [
4254
+ # Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).
4255
+ # @param [String] parent
4256
+ # Name of the FHIR store to retrieve resources from.
4257
+ # @param [String] resource_type
4258
+ # The FHIR resource type to search, such as Patient or Observation. For a
4259
+ # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
4260
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
4261
+ # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/
4262
+ # standards/fhir/R4/resourcelist.html)).
4263
+ # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
4264
+ # @param [String] fields
4265
+ # Selector specifying which fields to include in a partial response.
4266
+ # @param [String] quota_user
4267
+ # Available to use for quota purposes for server-side applications. Can be any
4268
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4269
+ # @param [Google::Apis::RequestOptions] options
4270
+ # Request-specific options
4271
+ #
4272
+ # @yield [result, err] Result & error if block supplied
4273
+ # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object
4274
+ # @yieldparam err [StandardError] error object if request failed
4275
+ #
4276
+ # @return [Google::Apis::HealthcareV1::HttpBody]
4277
+ #
4278
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4279
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4280
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4281
+ def search_project_location_dataset_fhir_store_fhir_type(parent, resource_type, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4282
+ command = make_simple_command(:post, 'v1/{+parent}/fhir/{resourceType}/_search', options)
4283
+ command.request_representation = Google::Apis::HealthcareV1::SearchResourcesRequest::Representation
4284
+ command.request_object = search_resources_request_object
4285
+ command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation
4286
+ command.response_class = Google::Apis::HealthcareV1::HttpBody
4287
+ command.params['parent'] = parent unless parent.nil?
4288
+ command.params['resourceType'] = resource_type unless resource_type.nil?
4289
+ command.query['fields'] = fields unless fields.nil?
4290
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4291
+ execute_or_queue_command(command, &block)
4292
+ end
4293
+
2728
4294
  # Updates the entire contents of a resource. Implements the FHIR standard update
2729
4295
  # interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#
2730
4296
  # update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update),
2731
4297
  # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the
2732
4298
  # 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
4299
+ # set, creates the resource with the client-specified ID. It is strongly advised
4300
+ # not to include or encode any sensitive data such as patient identifiers in
4301
+ # client-specified resource IDs. Those IDs are part of the FHIR resource path
4302
+ # recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
4303
+ # contained in reference fields within other resources. The request body must
2734
4304
  # contain a JSON-encoded FHIR resource, and the request headers must contain `
2735
4305
  # Content-Type: application/fhir+json`. The resource must contain an `id`
2736
4306
  # 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
4307
+ # On success, the response body contains a JSON-encoded representation of the
4308
+ # updated resource, including the server-assigned version ID. Errors generated
4309
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
4310
+ # describing the reason for the error. If the request cannot be mapped to a
4311
+ # valid API method on a FHIR store, a generic GCP error might be returned
2742
4312
  # instead. For samples that show how to call `update`, see [Updating a FHIR
2743
4313
  # resource](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
2744
4314
  # @param [String] name
@@ -2777,13 +4347,13 @@ module Google
2777
4347
  # version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.
2778
4348
  # org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/
2779
4349
  # 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).
4350
+ # standards/fhir/R4/http.html#vread)). On success, the response body contains a
4351
+ # JSON-encoded representation of the resource. Errors generated by the FHIR
4352
+ # store contain a JSON-encoded `OperationOutcome` resource describing the reason
4353
+ # for the error. If the request cannot be mapped to a valid API method on a FHIR
4354
+ # store, a generic GCP error might be returned instead. For samples that show
4355
+ # how to call `vread`, see [Retrieving a FHIR resource version](/healthcare/docs/
4356
+ # how-tos/fhir-resources#retrieving_a_fhir_resource_version).
2787
4357
  # @param [String] name
2788
4358
  # The name of the resource version to retrieve.
2789
4359
  # @param [String] fields
@@ -2955,9 +4525,28 @@ module Google
2955
4525
  # @param [String] parent
2956
4526
  # Name of the dataset.
2957
4527
  # @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`.
4528
+ # Restricts stores returned to those matching a filter. The following syntax is
4529
+ # available: * A string field value can be written as text inside quotation
4530
+ # marks, for example `"query text"`. The only valid relational operation for
4531
+ # text fields is equality (`=`), where text is searched within the field, rather
4532
+ # than having the field be equal to the text. For example, `"Comment = great"`
4533
+ # returns messages with `great` in the comment field. * A number field value can
4534
+ # be written as an integer, a decimal, or an exponential. The valid relational
4535
+ # operators for number fields are the equality operator (`=`), along with the
4536
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
4537
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
4538
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
4539
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
4540
+ # required for one-digit months and days. The valid relational operators for
4541
+ # date fields are the equality operator (`=`) , along with the less than/greater
4542
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
4543
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
4544
+ # Multiple field query expressions can be combined in one query by adding `AND`
4545
+ # or `OR` operators between the expressions. If a boolean operator appears
4546
+ # within a quoted string, it is not treated as special, it's just another part
4547
+ # of the character string to be matched. You can prepend the `NOT` operator to
4548
+ # an expression to negate it. Only filtering on labels is supported. For example,
4549
+ # `labels.key=value`.
2961
4550
  # @param [Fixnum] page_size
2962
4551
  # Limit on the number of HL7v2 stores to return in a single response. If not
2963
4552
  # specified, 100 is used. May not be larger than 1000.
@@ -3107,10 +4696,10 @@ module Google
3107
4696
  end
3108
4697
 
3109
4698
  # 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.
4699
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
4700
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
4701
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
4702
+ # message when a notification is received.
3114
4703
  # @param [String] parent
3115
4704
  # The name of the dataset this message belongs to.
3116
4705
  # @param [Google::Apis::HealthcareV1::CreateMessageRequest] create_message_request_object
@@ -3208,14 +4797,14 @@ module Google
3208
4797
  end
3209
4798
 
3210
4799
  # 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.
4800
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
4801
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
4802
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
4803
+ # message when a notification is received. If the method is successful, it
4804
+ # generates a response containing an HL7v2 acknowledgment (`ACK`) message. If
4805
+ # the method encounters an error, it returns a negative acknowledgment (`NACK`)
4806
+ # message. This behavior is suitable for replying to HL7v2 interface systems
4807
+ # that expect these acknowledgments.
3219
4808
  # @param [String] parent
3220
4809
  # The name of the HL7v2 store this message belongs to.
3221
4810
  # @param [Google::Apis::HealthcareV1::IngestMessageRequest] ingest_message_request_object
@@ -3255,22 +4844,43 @@ module Google
3255
4844
  # @param [String] parent
3256
4845
  # Name of the HL7v2 store to retrieve messages from.
3257
4846
  # @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":*`.
4847
+ # Restricts messages returned to those matching a filter. The following syntax
4848
+ # is available: * A string field value can be written as text inside quotation
4849
+ # marks, for example `"query text"`. The only valid relational operation for
4850
+ # text fields is equality (`=`), where text is searched within the field, rather
4851
+ # than having the field be equal to the text. For example, `"Comment = great"`
4852
+ # returns messages with `great` in the comment field. * A number field value can
4853
+ # be written as an integer, a decimal, or an exponential. The valid relational
4854
+ # operators for number fields are the equality operator (`=`), along with the
4855
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
4856
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
4857
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
4858
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
4859
+ # required for one-digit months and days. The valid relational operators for
4860
+ # date fields are the equality operator (`=`) , along with the less than/greater
4861
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
4862
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
4863
+ # Multiple field query expressions can be combined in one query by adding `AND`
4864
+ # or `OR` operators between the expressions. If a boolean operator appears
4865
+ # within a quoted string, it is not treated as special, it's just another part
4866
+ # of the character string to be matched. You can prepend the `NOT` operator to
4867
+ # an expression to negate it. Fields/functions available for filtering are: * `
4868
+ # message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`.
4869
+ # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the
4870
+ # dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-
4871
+ # 01-02"`. * `send_time`, the timestamp when the message was sent, using the
4872
+ # RFC3339 time format for comparisons, from the MSH-7 segment. For example, `
4873
+ # send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when
4874
+ # the message was created in the HL7v2 store. Use the RFC3339 time format for
4875
+ # comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `
4876
+ # send_facility`, the care center that the message came from, from the MSH-4
4877
+ # segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`,
4878
+ # which matches if the message lists a patient having an ID of the given value
4879
+ # and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("
4880
+ # 123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as
4881
+ # set using the Message.labels map. For example, `labels."priority"="high"`. The
4882
+ # operator `:*` can be used to assert the existence of a label. For example, `
4883
+ # labels."priority":*`.
3274
4884
  # @param [String] order_by
3275
4885
  # Orders messages returned by the specified order_by clause. Syntax: https://
3276
4886
  # cloud.google.com/apis/design/design_patterns#sorting_order Fields available