google-apis-healthcare_v1 0.2.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -83,11 +83,15 @@ 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).
87
89
  # @param [Fixnum] page_size
88
- # The standard list page size.
90
+ # The maximum number of results to return. If not set, the service selects a
91
+ # default.
89
92
  # @param [String] page_token
90
- # The standard list 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.
91
95
  # @param [String] fields
92
96
  # Selector specifying which fields to include in a partial response.
93
97
  # @param [String] quota_user
@@ -165,7 +169,8 @@ module Google
165
169
  # DICOM instances. The new de-identified dataset will not contain these failed
166
170
  # resources. Failed resource totals are tracked in Operation.metadata. Error
167
171
  # details are also logged to Cloud Logging. For more information, see [Viewing
168
- # logs](/healthcare/docs/how-tos/logging).
172
+ # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
173
+ # logging).
169
174
  # @param [String] source_dataset
170
175
  # Source dataset resource name. For example, `projects/`project_id`/locations/`
171
176
  # location_id`/datasets/`dataset_id``.
@@ -179,32 +184,1331 @@ module Google
179
184
  # Request-specific options
180
185
  #
181
186
  # @yield [result, err] Result & error if block supplied
182
- # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
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\")`.
1198
+ # @param [Fixnum] 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.
1201
+ # @param [String] 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
183
1458
  # @yieldparam err [StandardError] error object if request failed
184
1459
  #
185
- # @return [Google::Apis::HealthcareV1::Operation]
1460
+ # @return [Google::Apis::HealthcareV1::ListConsentsResponse]
186
1461
  #
187
1462
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
188
1463
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
189
1464
  # @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?
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?
197
1473
  command.query['fields'] = fields unless fields.nil?
198
1474
  command.query['quotaUser'] = quota_user unless quota_user.nil?
199
1475
  execute_or_queue_command(command, &block)
200
1476
  end
201
1477
 
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).
1478
+ # Lists the revisions of the specified Consent in reverse chronological order.
205
1479
  # @param [String] name
206
- # The name of the dataset to delete. For example, `projects/`project_id`/
207
- # locations/`location_id`/datasets/`dataset_id``.
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.
208
1512
  # @param [String] fields
209
1513
  # Selector specifying which fields to include in a partial response.
210
1514
  # @param [String] quota_user
@@ -214,28 +1518,40 @@ module Google
214
1518
  # Request-specific options
215
1519
  #
216
1520
  # @yield [result, err] Result & error if block supplied
217
- # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
1521
+ # @yieldparam result [Google::Apis::HealthcareV1::ListConsentRevisionsResponse] parsed result object
218
1522
  # @yieldparam err [StandardError] error object if request failed
219
1523
  #
220
- # @return [Google::Apis::HealthcareV1::Empty]
1524
+ # @return [Google::Apis::HealthcareV1::ListConsentRevisionsResponse]
221
1525
  #
222
1526
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
223
1527
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
224
1528
  # @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
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
229
1533
  command.params['name'] = name unless name.nil?
1534
+ command.query['filter'] = filter unless filter.nil?
1535
+ command.query['pageSize'] = page_size unless page_size.nil?
1536
+ command.query['pageToken'] = page_token unless page_token.nil?
230
1537
  command.query['fields'] = fields unless fields.nil?
231
1538
  command.query['quotaUser'] = quota_user unless quota_user.nil?
232
1539
  execute_or_queue_command(command, &block)
233
1540
  end
234
1541
 
235
- # Gets any metadata associated with a dataset.
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.
236
1545
  # @param [String] name
237
- # The name of the dataset to read. For example, `projects/`project_id`/locations/
238
- # `location_id`/datasets/`dataset_id``.
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.
239
1555
  # @param [String] fields
240
1556
  # Selector specifying which fields to include in a partial response.
241
1557
  # @param [String] quota_user
@@ -245,37 +1561,38 @@ module Google
245
1561
  # Request-specific options
246
1562
  #
247
1563
  # @yield [result, err] Result & error if block supplied
248
- # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
1564
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
249
1565
  # @yieldparam err [StandardError] error object if request failed
250
1566
  #
251
- # @return [Google::Apis::HealthcareV1::Dataset]
1567
+ # @return [Google::Apis::HealthcareV1::Consent]
252
1568
  #
253
1569
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
254
1570
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
255
1571
  # @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
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
260
1578
  command.params['name'] = name unless name.nil?
1579
+ command.query['updateMask'] = update_mask unless update_mask.nil?
261
1580
  command.query['fields'] = fields unless fields.nil?
262
1581
  command.query['quotaUser'] = quota_user unless quota_user.nil?
263
1582
  execute_or_queue_command(command, &block)
264
1583
  end
265
1584
 
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).
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
279
1596
  # @param [String] fields
280
1597
  # Selector specifying which fields to include in a partial response.
281
1598
  # @param [String] quota_user
@@ -285,34 +1602,37 @@ module Google
285
1602
  # Request-specific options
286
1603
  #
287
1604
  # @yield [result, err] Result & error if block supplied
288
- # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1605
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
289
1606
  # @yieldparam err [StandardError] error object if request failed
290
1607
  #
291
- # @return [Google::Apis::HealthcareV1::Policy]
1608
+ # @return [Google::Apis::HealthcareV1::Consent]
292
1609
  #
293
1610
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
294
1611
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
295
1612
  # @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?
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?
302
1620
  command.query['fields'] = fields unless fields.nil?
303
1621
  command.query['quotaUser'] = quota_user unless quota_user.nil?
304
1622
  execute_or_queue_command(command, &block)
305
1623
  end
306
1624
 
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.
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.
1630
+ # @param [String] name
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
316
1636
  # @param [String] fields
317
1637
  # Selector specifying which fields to include in a partial response.
318
1638
  # @param [String] quota_user
@@ -322,35 +1642,30 @@ module Google
322
1642
  # Request-specific options
323
1643
  #
324
1644
  # @yield [result, err] Result & error if block supplied
325
- # @yieldparam result [Google::Apis::HealthcareV1::ListDatasetsResponse] parsed result object
1645
+ # @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
326
1646
  # @yieldparam err [StandardError] error object if request failed
327
1647
  #
328
- # @return [Google::Apis::HealthcareV1::ListDatasetsResponse]
1648
+ # @return [Google::Apis::HealthcareV1::Consent]
329
1649
  #
330
1650
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
331
1651
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
332
1652
  # @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?
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
1659
+ command.params['name'] = name unless name.nil?
340
1660
  command.query['fields'] = fields unless fields.nil?
341
1661
  command.query['quotaUser'] = quota_user unless quota_user.nil?
342
1662
  execute_or_queue_command(command, &block)
343
1663
  end
344
1664
 
345
- # Updates dataset metadata.
1665
+ # Archives the specified User data mapping.
346
1666
  # @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
1667
+ # Required. The resource name of the User data mapping to archive.
1668
+ # @param [Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest] archive_user_data_mapping_request_object
354
1669
  # @param [String] fields
355
1670
  # Selector specifying which fields to include in a partial response.
356
1671
  # @param [String] quota_user
@@ -360,34 +1675,30 @@ module Google
360
1675
  # Request-specific options
361
1676
  #
362
1677
  # @yield [result, err] Result & error if block supplied
363
- # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object
1678
+ # @yieldparam result [Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse] parsed result object
364
1679
  # @yieldparam err [StandardError] error object if request failed
365
1680
  #
366
- # @return [Google::Apis::HealthcareV1::Dataset]
1681
+ # @return [Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse]
367
1682
  #
368
1683
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
369
1684
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
370
1685
  # @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
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
377
1692
  command.params['name'] = name unless name.nil?
378
- command.query['updateMask'] = update_mask unless update_mask.nil?
379
1693
  command.query['fields'] = fields unless fields.nil?
380
1694
  command.query['quotaUser'] = quota_user unless quota_user.nil?
381
1695
  execute_or_queue_command(command, &block)
382
1696
  end
383
1697
 
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
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
391
1702
  # @param [String] fields
392
1703
  # Selector specifying which fields to include in a partial response.
393
1704
  # @param [String] quota_user
@@ -397,35 +1708,29 @@ module Google
397
1708
  # Request-specific options
398
1709
  #
399
1710
  # @yield [result, err] Result & error if block supplied
400
- # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1711
+ # @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
401
1712
  # @yieldparam err [StandardError] error object if request failed
402
1713
  #
403
- # @return [Google::Apis::HealthcareV1::Policy]
1714
+ # @return [Google::Apis::HealthcareV1::UserDataMapping]
404
1715
  #
405
1716
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
406
1717
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
407
1718
  # @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?
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?
415
1726
  command.query['fields'] = fields unless fields.nil?
416
1727
  command.query['quotaUser'] = quota_user unless quota_user.nil?
417
1728
  execute_or_queue_command(command, &block)
418
1729
  end
419
1730
 
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
1731
+ # Deletes the specified User data mapping.
1732
+ # @param [String] name
1733
+ # Required. The resource name of the User data mapping to delete.
429
1734
  # @param [String] fields
430
1735
  # Selector specifying which fields to include in a partial response.
431
1736
  # @param [String] quota_user
@@ -435,39 +1740,27 @@ module Google
435
1740
  # Request-specific options
436
1741
  #
437
1742
  # @yield [result, err] Result & error if block supplied
438
- # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
1743
+ # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
439
1744
  # @yieldparam err [StandardError] error object if request failed
440
1745
  #
441
- # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
1746
+ # @return [Google::Apis::HealthcareV1::Empty]
442
1747
  #
443
1748
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
444
1749
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
445
1750
  # @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?
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?
453
1756
  command.query['fields'] = fields unless fields.nil?
454
1757
  command.query['quotaUser'] = quota_user unless quota_user.nil?
455
1758
  execute_or_queue_command(command, &block)
456
1759
  end
457
1760
 
458
- # Gets the access control policy for a resource. Returns an empty policy if the
459
- # resource exists and does not have a policy set.
460
- # @param [String] resource
461
- # REQUIRED: The resource for which the policy is being requested. See the
462
- # operation documentation for the appropriate value for this field.
463
- # @param [Fixnum] options_requested_policy_version
464
- # Optional. The policy format version to be returned. Valid values are 0, 1, and
465
- # 3. Requests specifying an invalid value will be rejected. Requests for
466
- # policies with any conditional bindings must specify version 3. Policies
467
- # without any conditional bindings may specify any valid value or leave the
468
- # field unset. To learn which resources support conditions in their IAM policies,
469
- # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
470
- # resource-policies).
1761
+ # Gets the specified User data mapping.
1762
+ # @param [String] name
1763
+ # Required. The resource name of the User data mapping to retrieve.
471
1764
  # @param [String] fields
472
1765
  # Selector specifying which fields to include in a partial response.
473
1766
  # @param [String] quota_user
@@ -477,32 +1770,57 @@ module Google
477
1770
  # Request-specific options
478
1771
  #
479
1772
  # @yield [result, err] Result & error if block supplied
480
- # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1773
+ # @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
481
1774
  # @yieldparam err [StandardError] error object if request failed
482
1775
  #
483
- # @return [Google::Apis::HealthcareV1::Policy]
1776
+ # @return [Google::Apis::HealthcareV1::UserDataMapping]
484
1777
  #
485
1778
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
486
1779
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
487
1780
  # @raise [Google::Apis::AuthorizationError] Authorization is required
488
- def get_project_location_dataset_consent_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
489
- command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
490
- command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
491
- command.response_class = Google::Apis::HealthcareV1::Policy
492
- command.params['resource'] = resource unless resource.nil?
493
- command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
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
1785
+ command.params['name'] = name unless name.nil?
494
1786
  command.query['fields'] = fields unless fields.nil?
495
1787
  command.query['quotaUser'] = quota_user unless quota_user.nil?
496
1788
  execute_or_queue_command(command, &block)
497
1789
  end
498
1790
 
499
- # Sets the access control policy on the specified resource. Replaces any
500
- # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
501
- # PERMISSION_DENIED` errors.
502
- # @param [String] resource
503
- # REQUIRED: The resource for which the policy is being specified. See the
504
- # operation documentation for the appropriate value for this field.
505
- # @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.
506
1824
  # @param [String] fields
507
1825
  # Selector specifying which fields to include in a partial response.
508
1826
  # @param [String] quota_user
@@ -512,35 +1830,38 @@ module Google
512
1830
  # Request-specific options
513
1831
  #
514
1832
  # @yield [result, err] Result & error if block supplied
515
- # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object
1833
+ # @yieldparam result [Google::Apis::HealthcareV1::ListUserDataMappingsResponse] parsed result object
516
1834
  # @yieldparam err [StandardError] error object if request failed
517
1835
  #
518
- # @return [Google::Apis::HealthcareV1::Policy]
1836
+ # @return [Google::Apis::HealthcareV1::ListUserDataMappingsResponse]
519
1837
  #
520
1838
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
521
1839
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
522
1840
  # @raise [Google::Apis::AuthorizationError] Authorization is required
523
- def set_consent_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
524
- command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
525
- command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation
526
- command.request_object = set_iam_policy_request_object
527
- command.response_representation = Google::Apis::HealthcareV1::Policy::Representation
528
- command.response_class = Google::Apis::HealthcareV1::Policy
529
- 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?
530
1849
  command.query['fields'] = fields unless fields.nil?
531
1850
  command.query['quotaUser'] = quota_user unless quota_user.nil?
532
1851
  execute_or_queue_command(command, &block)
533
1852
  end
534
1853
 
535
- # Returns permissions that a caller has on the specified resource. If the
536
- # resource does not exist, this will return an empty set of permissions, not a `
537
- # NOT_FOUND` error. Note: This operation is designed to be used for building
538
- # permission-aware UIs and command-line tools, not for authorization checking.
539
- # This operation may "fail open" without warning.
540
- # @param [String] resource
541
- # REQUIRED: The resource for which the policy detail is being requested. See the
542
- # operation documentation for the appropriate value for this field.
543
- # @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.
544
1865
  # @param [String] fields
545
1866
  # Selector specifying which fields to include in a partial response.
546
1867
  # @param [String] quota_user
@@ -550,21 +1871,22 @@ module Google
550
1871
  # Request-specific options
551
1872
  #
552
1873
  # @yield [result, err] Result & error if block supplied
553
- # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object
1874
+ # @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
554
1875
  # @yieldparam err [StandardError] error object if request failed
555
1876
  #
556
- # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse]
1877
+ # @return [Google::Apis::HealthcareV1::UserDataMapping]
557
1878
  #
558
1879
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
559
1880
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
560
1881
  # @raise [Google::Apis::AuthorizationError] Authorization is required
561
- def test_consent_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
562
- command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
563
- command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation
564
- command.request_object = test_iam_permissions_request_object
565
- command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation
566
- command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse
567
- 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?
568
1890
  command.query['fields'] = fields unless fields.nil?
569
1891
  command.query['quotaUser'] = quota_user unless quota_user.nil?
570
1892
  execute_or_queue_command(command, &block)
@@ -614,7 +1936,7 @@ module Google
614
1936
  # identification fails for some DICOM instances. The output DICOM store will not
615
1937
  # contain these failed resources. Failed resource totals are tracked in
616
1938
  # Operation.metadata. Error details are also logged to Cloud Logging (see [
617
- # Viewing logs](/healthcare/docs/how-tos/logging)).
1939
+ # Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging)).
618
1940
  # @param [String] source_store
619
1941
  # Source DICOM store resource name. For example, `projects/`project_id`/
620
1942
  # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
@@ -681,8 +2003,8 @@ module Google
681
2003
 
682
2004
  # Exports data to the specified destination by copying it from the DICOM store.
683
2005
  # Errors are also logged to Cloud Logging. For more information, see [Viewing
684
- # logs](/healthcare/docs/how-tos/logging). The metadata field type is
685
- # OperationMetadata.
2006
+ # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2007
+ # logging). The metadata field type is OperationMetadata.
686
2008
  # @param [String] name
687
2009
  # The DICOM store resource name from which to export the data. For example, `
688
2010
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -789,8 +2111,9 @@ module Google
789
2111
  end
790
2112
 
791
2113
  # Imports data into the DICOM store by copying it from the specified source.
792
- # Errors are logged to Cloud Logging. For more information, see [Viewing logs](/
793
- # 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.
794
2117
  # @param [String] name
795
2118
  # The name of the DICOM store resource into which the data is imported. For
796
2119
  # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -829,9 +2152,28 @@ module Google
829
2152
  # @param [String] parent
830
2153
  # Name of the dataset.
831
2154
  # @param [String] filter
832
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
833
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
834
- # 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`.
835
2177
  # @param [Fixnum] page_size
836
2178
  # Limit on the number of DICOM stores to return in a single response. If not
837
2179
  # specified, 100 is used. May not be larger than 1000.
@@ -1158,11 +2500,10 @@ module Google
1158
2500
  # DeleteStudy deletes all instances within the given study. Delete requests are
1159
2501
  # equivalent to the GET requests specified in the Retrieve transaction. The
1160
2502
  # method returns an Operation which will be marked successful when the deletion
1161
- # is complete. Warning: Inserting instances into a study while a delete
1162
- # operation is running for that study could result in the new instances not
1163
- # appearing in search results until the deletion operation finishes. For samples
1164
- # that show how to call DeleteStudy, see [Deleting a study, series, or instance](
1165
- # https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
2503
+ # is complete. Warning: Instances cannot be inserted into a study that is being
2504
+ # deleted by an operation until the operation completes. For samples that show
2505
+ # how to call DeleteStudy, see [Deleting a study, series, or instance](https://
2506
+ # cloud.google.com/healthcare/docs/how-tos/dicomweb#
1166
2507
  # deleting_a_study_series_or_instance).
1167
2508
  # @param [String] parent
1168
2509
  # @param [String] dicom_web_path
@@ -1417,12 +2758,11 @@ module Google
1417
2758
  # DeleteSeries deletes all instances within the given study and series. Delete
1418
2759
  # requests are equivalent to the GET requests specified in the Retrieve
1419
2760
  # transaction. The method returns an Operation which will be marked successful
1420
- # when the deletion is complete. Warning: Inserting instances into a series
1421
- # while a delete operation is running for that series could result in the new
1422
- # instances not appearing in search results until the deletion operation
1423
- # finishes. For samples that show how to call DeleteSeries, see [Deleting a
1424
- # study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/
1425
- # dicomweb#deleting_a_study_series_or_instance).
2761
+ # when the deletion is complete. Warning: Instances cannot be inserted into a
2762
+ # series that is being deleted by an operation until the operation completes.
2763
+ # For samples that show how to call DeleteSeries, see [Deleting a study, series,
2764
+ # or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
2765
+ # deleting_a_study_series_or_instance).
1426
2766
  # @param [String] parent
1427
2767
  # The name of the DICOM store that is being accessed. For example, `projects/`
1428
2768
  # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
@@ -1893,7 +3233,8 @@ module Google
1893
3233
  # store. The metadata field type is OperationMetadata. If the request is
1894
3234
  # successful, the response field type is DeidentifyFhirStoreSummary. If errors
1895
3235
  # occur, error is set. Error details are also logged to Cloud Logging (see [
1896
- # Viewing logs](/healthcare/docs/how-tos/logging)).
3236
+ # Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/
3237
+ # how-tos/logging)).
1897
3238
  # @param [String] source_store
1898
3239
  # Source FHIR store resource name. For example, `projects/`project_id`/locations/
1899
3240
  # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
@@ -1960,10 +3301,11 @@ module Google
1960
3301
  # Export resources from the FHIR store to the specified destination. This method
1961
3302
  # returns an Operation that can be used to track the status of the export by
1962
3303
  # calling GetOperation. Immediate fatal errors appear in the error field, errors
1963
- # are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/
1964
- # logging)). Otherwise, when the operation finishes, a detailed response of type
1965
- # ExportResourcesResponse is returned in the response field. The metadata field
1966
- # type for this operation is OperationMetadata.
3304
+ # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
3305
+ # https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
3306
+ # the operation finishes, a detailed response of type ExportResourcesResponse is
3307
+ # returned in the response field. The metadata field type for this operation is
3308
+ # OperationMetadata.
1967
3309
  # @param [String] name
1968
3310
  # The name of the FHIR store to export resource from, in the format of `projects/
1969
3311
  # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
@@ -2079,7 +3421,7 @@ module Google
2079
3421
  # stored using the supplied ID regardless of the enable_update_create setting on
2080
3422
  # the FHIR store. It is strongly advised not to include or encode any sensitive
2081
3423
  # data such as patient identifiers in client-specified resource IDs. Those IDs
2082
- # are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/
3424
+ # are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/
2083
3425
  # Sub notifications. Those IDs can also be contained in reference fields within
2084
3426
  # other resources. The import process does not enforce referential integrity,
2085
3427
  # regardless of the disable_referential_integrity setting on the FHIR store.
@@ -2117,10 +3459,11 @@ module Google
2117
3459
  # searchset` bundles produced by a FHIR search or Patient-everything operation.
2118
3460
  # This method returns an Operation that can be used to track the status of the
2119
3461
  # import by calling GetOperation. Immediate fatal errors appear in the error
2120
- # field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/
2121
- # docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed
2122
- # response of type ImportResourcesResponse is returned in the response field.
2123
- # The metadata field type for this operation is OperationMetadata.
3462
+ # field, errors are also logged to Cloud Logging (see [Viewing error logs in
3463
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
3464
+ # Otherwise, when the operation finishes, a detailed response of type
3465
+ # ImportResourcesResponse is returned in the response field. The metadata field
3466
+ # type for this operation is OperationMetadata.
2124
3467
  # @param [String] name
2125
3468
  # The name of the FHIR store to import FHIR resources to, in the format of `
2126
3469
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
@@ -2159,9 +3502,28 @@ module Google
2159
3502
  # @param [String] parent
2160
3503
  # Name of the dataset.
2161
3504
  # @param [String] filter
2162
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
2163
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
2164
- # on labels is supported, for example `labels.key=value`.
3505
+ # Restricts stores returned to those matching a filter. The following syntax is
3506
+ # available: * A string field value can be written as text inside quotation
3507
+ # marks, for example `"query text"`. The only valid relational operation for
3508
+ # text fields is equality (`=`), where text is searched within the field, rather
3509
+ # than having the field be equal to the text. For example, `"Comment = great"`
3510
+ # returns messages with `great` in the comment field. * A number field value can
3511
+ # be written as an integer, a decimal, or an exponential. The valid relational
3512
+ # operators for number fields are the equality operator (`=`), along with the
3513
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
3514
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
3515
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
3516
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
3517
+ # required for one-digit months and days. The valid relational operators for
3518
+ # date fields are the equality operator (`=`) , along with the less than/greater
3519
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
3520
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
3521
+ # Multiple field query expressions can be combined in one query by adding `AND`
3522
+ # or `OR` operators between the expressions. If a boolean operator appears
3523
+ # within a quoted string, it is not treated as special, it's just another part
3524
+ # of the character string to be matched. You can prepend the `NOT` operator to
3525
+ # an expression to negate it. Only filtering on labels is supported, for example
3526
+ # `labels.key=value`.
2165
3527
  # @param [Fixnum] page_size
2166
3528
  # Limit on the number of FHIR stores to return in a single response. If not
2167
3529
  # specified, 100 is used. May not be larger than 1000.
@@ -2315,21 +3677,21 @@ module Google
2315
3677
  # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](
2316
3678
  # http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#
2317
3679
  # everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-
2318
- # operations.html#everything)). On success, the response body will contain a
2319
- # JSON-encoded representation of a `Bundle` resource of type `searchset`,
2320
- # containing the results of the operation. Errors generated by the FHIR store
2321
- # will contain a JSON-encoded `OperationOutcome` resource describing the reason
2322
- # for the error. If the request cannot be mapped to a valid API method on a FHIR
2323
- # store, a generic GCP error might be returned instead. The resources in scope
2324
- # for the response are: * The patient resource itself. * All the resources
2325
- # directly referenced by the patient resource. * Resources directly referencing
2326
- # the patient resource that meet the inclusion criteria. The inclusion criteria
2327
- # are based on the membership rules in the patient compartment definition ([
2328
- # DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.
2329
- # hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/
2330
- # fhir/R4/compartmentdefinition-patient.html)), which details the eligible
2331
- # resource types and referencing search parameters. For samples that show how to
2332
- # call `Patient-everything`, see [Getting all patient compartment resources](/
3680
+ # operations.html#everything)). On success, the response body contains a JSON-
3681
+ # encoded representation of a `Bundle` resource of type `searchset`, containing
3682
+ # the results of the operation. Errors generated by the FHIR store contain a
3683
+ # JSON-encoded `OperationOutcome` resource describing the reason for the error.
3684
+ # If the request cannot be mapped to a valid API method on a FHIR store, a
3685
+ # generic GCP error might be returned instead. The resources in scope for the
3686
+ # response are: * The patient resource itself. * All the resources directly
3687
+ # referenced by the patient resource. * Resources directly referencing the
3688
+ # patient resource that meet the inclusion criteria. The inclusion criteria are
3689
+ # based on the membership rules in the patient compartment definition ([DSTU2](
3690
+ # http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/
3691
+ # fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/
3692
+ # compartmentdefinition-patient.html)), which details the eligible resource
3693
+ # types and referencing search parameters. For samples that show how to call `
3694
+ # Patient-everything`, see [Getting all patient compartment resources](/
2333
3695
  # healthcare/docs/how-tos/fhir-resources#
2334
3696
  # getting_all_patient_compartment_resources).
2335
3697
  # @param [String] name
@@ -2434,8 +3796,8 @@ module Google
2434
3796
  # implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/
2435
3797
  # implement/standards/fhir/R4/http.html#capabilities)), or the [conformance
2436
3798
  # interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#
2437
- # conformance) in the DSTU2 case. On success, the response body will contain a
2438
- # JSON-encoded representation of a `CapabilityStatement` resource.
3799
+ # conformance) in the DSTU2 case. On success, the response body contains a JSON-
3800
+ # encoded representation of a `CapabilityStatement` resource.
2439
3801
  # @param [String] name
2440
3802
  # Name of the FHIR store to retrieve the capabilities for.
2441
3803
  # @param [String] fields
@@ -2471,14 +3833,14 @@ module Google
2471
3833
  # hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new
2472
3834
  # resource with a server-assigned resource ID. The request body must contain a
2473
3835
  # JSON-encoded FHIR resource, and the request headers must contain `Content-Type:
2474
- # application/fhir+json`. On success, the response body will contain a JSON-
2475
- # encoded representation of the resource as it was created on the server,
2476
- # including the server-assigned resource ID and version ID. Errors generated by
2477
- # the FHIR store will contain a JSON-encoded `OperationOutcome` resource
2478
- # describing the reason for the error. If the request cannot be mapped to a
2479
- # valid API method on a FHIR store, a generic GCP error might be returned
2480
- # instead. For samples that show how to call `create`, see [Creating a FHIR
2481
- # resource](/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).
3836
+ # application/fhir+json`. On success, the response body contains a JSON-encoded
3837
+ # representation of the resource as it was created on the server, including the
3838
+ # server-assigned resource ID and version ID. Errors generated by the FHIR store
3839
+ # contain a JSON-encoded `OperationOutcome` resource describing the reason for
3840
+ # the error. If the request cannot be mapped to a valid API method on a FHIR
3841
+ # store, a generic GCP error might be returned instead. For samples that show
3842
+ # how to call `create`, see [Creating a FHIR resource](/healthcare/docs/how-tos/
3843
+ # fhir-resources#creating_a_fhir_resource).
2482
3844
  # @param [String] parent
2483
3845
  # The name of the FHIR store this resource belongs to.
2484
3846
  # @param [String] type
@@ -2619,10 +3981,10 @@ module Google
2619
3981
  # FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/
2620
3982
  # fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/
2621
3983
  # STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.
2622
- # html#history)). On success, the response body will contain a JSON-encoded
3984
+ # html#history)). On success, the response body contains a JSON-encoded
2623
3985
  # representation of a `Bundle` resource of type `history`, containing the
2624
3986
  # version history sorted from most recent to oldest versions. Errors generated
2625
- # by the FHIR store will contain a JSON-encoded `OperationOutcome` resource
3987
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
2626
3988
  # describing the reason for the error. If the request cannot be mapped to a
2627
3989
  # valid API method on a FHIR store, a generic GCP error might be returned
2628
3990
  # instead. For samples that show how to call `history`, see [Listing FHIR
@@ -2688,11 +4050,11 @@ module Google
2688
4050
  # DSTU2 doesn't define a patch method, but the server supports it in the same
2689
4051
  # way it supports STU3. The request body must contain a JSON Patch document, and
2690
4052
  # the request headers must contain `Content-Type: application/json-patch+json`.
2691
- # On success, the response body will contain a JSON-encoded representation of
2692
- # the updated resource, including the server-assigned version ID. Errors
2693
- # generated by the FHIR store will contain a JSON-encoded `OperationOutcome`
2694
- # resource describing the reason for the error. If the request cannot be mapped
2695
- # to a valid API method on a FHIR store, a generic GCP error might be returned
4053
+ # On success, the response body contains a JSON-encoded representation of the
4054
+ # updated resource, including the server-assigned version ID. Errors generated
4055
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
4056
+ # describing the reason for the error. If the request cannot be mapped to a
4057
+ # valid API method on a FHIR store, a generic GCP error might be returned
2696
4058
  # instead. For samples that show how to call `patch`, see [Patching a FHIR
2697
4059
  # resource](/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).
2698
4060
  # @param [String] name
@@ -2736,13 +4098,13 @@ module Google
2736
4098
  # implement/standards/fhir/STU3/http.html#cread), [R4](http://hl7.org/implement/
2737
4099
  # standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-
2738
4100
  # Since` header with a date/time value or an `If-None-Match` header with an ETag
2739
- # value. On success, the response body will contain a JSON-encoded
2740
- # representation of the resource. Errors generated by the FHIR store will
2741
- # contain a JSON-encoded `OperationOutcome` resource describing the reason for
2742
- # the error. If the request cannot be mapped to a valid API method on a FHIR
2743
- # store, a generic GCP error might be returned instead. For samples that show
2744
- # how to call `read`, see [Getting a FHIR resource](/healthcare/docs/how-tos/
2745
- # fhir-resources#getting_a_fhir_resource).
4101
+ # value. On success, the response body contains a JSON-encoded representation of
4102
+ # the resource. Errors generated by the FHIR store contain a JSON-encoded `
4103
+ # OperationOutcome` resource describing the reason for the error. If the request
4104
+ # cannot be mapped to a valid API method on a FHIR store, a generic GCP error
4105
+ # might be returned instead. For samples that show how to call `read`, see [
4106
+ # Getting a FHIR resource](/healthcare/docs/how-tos/fhir-resources#
4107
+ # getting_a_fhir_resource).
2746
4108
  # @param [String] name
2747
4109
  # The name of the resource to retrieve.
2748
4110
  # @param [String] fields
@@ -2788,9 +4150,9 @@ module Google
2788
4150
  # alternate form having the same semantics as the `GET` method for the specified
2789
4151
  # type. The `GET` and `POST` methods do not support compartment searches. The `
2790
4152
  # POST` method does not support `application/x-www-form-urlencoded` search
2791
- # parameters. On success, the response body will contain a JSON-encoded
4153
+ # parameters. On success, the response body contains a JSON-encoded
2792
4154
  # representation of a `Bundle` resource of type `searchset`, containing the
2793
- # results of the search. Errors generated by the FHIR store will contain a JSON-
4155
+ # results of the search. Errors generated by the FHIR store contain a JSON-
2794
4156
  # encoded `OperationOutcome` resource describing the reason for the error. If
2795
4157
  # the request cannot be mapped to a valid API method on a FHIR store, a generic
2796
4158
  # GCP error might be returned instead. The server's capability statement,
@@ -2862,9 +4224,9 @@ module Google
2862
4224
  # alternate form having the same semantics as the `GET` method for the specified
2863
4225
  # type. The `GET` and `POST` methods do not support compartment searches. The `
2864
4226
  # POST` method does not support `application/x-www-form-urlencoded` search
2865
- # parameters. On success, the response body will contain a JSON-encoded
4227
+ # parameters. On success, the response body contains a JSON-encoded
2866
4228
  # representation of a `Bundle` resource of type `searchset`, containing the
2867
- # results of the search. Errors generated by the FHIR store will contain a JSON-
4229
+ # results of the search. Errors generated by the FHIR store contain a JSON-
2868
4230
  # encoded `OperationOutcome` resource describing the reason for the error. If
2869
4231
  # the request cannot be mapped to a valid API method on a FHIR store, a generic
2870
4232
  # GCP error might be returned instead. The server's capability statement,
@@ -2935,19 +4297,18 @@ module Google
2935
4297
  # set, creates the resource with the client-specified ID. It is strongly advised
2936
4298
  # not to include or encode any sensitive data such as patient identifiers in
2937
4299
  # client-specified resource IDs. Those IDs are part of the FHIR resource path
2938
- # recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can
2939
- # also be contained in reference fields within other resources. The request body
2940
- # must contain a JSON-encoded FHIR resource, and the request headers must
2941
- # contain `Content-Type: application/fhir+json`. The resource must contain an `
2942
- # id` element having an identical value to the ID in the REST path of the
2943
- # request. On success, the response body will contain a JSON-encoded
2944
- # representation of the updated resource, including the server-assigned version
2945
- # ID. Errors generated by the FHIR store will contain a JSON-encoded `
2946
- # OperationOutcome` resource describing the reason for the error. If the request
2947
- # cannot be mapped to a valid API method on a FHIR store, a generic GCP error
2948
- # might be returned instead. For samples that show how to call `update`, see [
2949
- # Updating a FHIR resource](/healthcare/docs/how-tos/fhir-resources#
2950
- # updating_a_fhir_resource).
4300
+ # recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
4301
+ # contained in reference fields within other resources. The request body must
4302
+ # contain a JSON-encoded FHIR resource, and the request headers must contain `
4303
+ # Content-Type: application/fhir+json`. The resource must contain an `id`
4304
+ # element having an identical value to the ID in the REST path of the request.
4305
+ # On success, the response body contains a JSON-encoded representation of the
4306
+ # updated resource, including the server-assigned version ID. Errors generated
4307
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
4308
+ # describing the reason for the error. If the request cannot be mapped to a
4309
+ # valid API method on a FHIR store, a generic GCP error might be returned
4310
+ # instead. For samples that show how to call `update`, see [Updating a FHIR
4311
+ # resource](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
2951
4312
  # @param [String] name
2952
4313
  # The name of the resource to update.
2953
4314
  # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
@@ -2984,13 +4345,13 @@ module Google
2984
4345
  # version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.
2985
4346
  # org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/
2986
4347
  # implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/
2987
- # standards/fhir/R4/http.html#vread)). On success, the response body will
2988
- # contain a JSON-encoded representation of the resource. Errors generated by the
2989
- # FHIR store will contain a JSON-encoded `OperationOutcome` resource describing
2990
- # the reason for the error. If the request cannot be mapped to a valid API
2991
- # method on a FHIR store, a generic GCP error might be returned instead. For
2992
- # samples that show how to call `vread`, see [Retrieving a FHIR resource version]
2993
- # (/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).
4348
+ # standards/fhir/R4/http.html#vread)). On success, the response body contains a
4349
+ # JSON-encoded representation of the resource. Errors generated by the FHIR
4350
+ # store contain a JSON-encoded `OperationOutcome` resource describing the reason
4351
+ # for the error. If the request cannot be mapped to a valid API method on a FHIR
4352
+ # store, a generic GCP error might be returned instead. For samples that show
4353
+ # how to call `vread`, see [Retrieving a FHIR resource version](/healthcare/docs/
4354
+ # how-tos/fhir-resources#retrieving_a_fhir_resource_version).
2994
4355
  # @param [String] name
2995
4356
  # The name of the resource version to retrieve.
2996
4357
  # @param [String] fields
@@ -3162,9 +4523,28 @@ module Google
3162
4523
  # @param [String] parent
3163
4524
  # Name of the dataset.
3164
4525
  # @param [String] filter
3165
- # Restricts stores returned to those matching a filter. Syntax: https://cloud.
3166
- # google.com/appengine/docs/standard/python/search/query_strings Only filtering
3167
- # on labels is supported. For example, `labels.key=value`.
4526
+ # Restricts stores returned to those matching a filter. The following syntax is
4527
+ # available: * A string field value can be written as text inside quotation
4528
+ # marks, for example `"query text"`. The only valid relational operation for
4529
+ # text fields is equality (`=`), where text is searched within the field, rather
4530
+ # than having the field be equal to the text. For example, `"Comment = great"`
4531
+ # returns messages with `great` in the comment field. * A number field value can
4532
+ # be written as an integer, a decimal, or an exponential. The valid relational
4533
+ # operators for number fields are the equality operator (`=`), along with the
4534
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
4535
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
4536
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
4537
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
4538
+ # required for one-digit months and days. The valid relational operators for
4539
+ # date fields are the equality operator (`=`) , along with the less than/greater
4540
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
4541
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
4542
+ # Multiple field query expressions can be combined in one query by adding `AND`
4543
+ # or `OR` operators between the expressions. If a boolean operator appears
4544
+ # within a quoted string, it is not treated as special, it's just another part
4545
+ # of the character string to be matched. You can prepend the `NOT` operator to
4546
+ # an expression to negate it. Only filtering on labels is supported. For example,
4547
+ # `labels.key=value`.
3168
4548
  # @param [Fixnum] page_size
3169
4549
  # Limit on the number of HL7v2 stores to return in a single response. If not
3170
4550
  # specified, 100 is used. May not be larger than 1000.
@@ -3314,10 +4694,10 @@ module Google
3314
4694
  end
3315
4695
 
3316
4696
  # Parses and stores an HL7v2 message. This method triggers an asynchronous
3317
- # notification to any Cloud Pub/Sub topic configured in projects.locations.
3318
- # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
3319
- # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
3320
- # the adapter transmits the message when a notification is received.
4697
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
4698
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
4699
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
4700
+ # message when a notification is received.
3321
4701
  # @param [String] parent
3322
4702
  # The name of the dataset this message belongs to.
3323
4703
  # @param [Google::Apis::HealthcareV1::CreateMessageRequest] create_message_request_object
@@ -3415,14 +4795,14 @@ module Google
3415
4795
  end
3416
4796
 
3417
4797
  # Parses and stores an HL7v2 message. This method triggers an asynchronous
3418
- # notification to any Cloud Pub/Sub topic configured in projects.locations.
3419
- # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
3420
- # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
3421
- # the adapter transmits the message when a notification is received. This method
3422
- # also generates a response containing an HL7v2 acknowledgement (`ACK`) message
3423
- # when successful or a negative acknowledgement (`NACK`) message in case of
3424
- # error, suitable for replying to HL7v2 interface systems that expect these
3425
- # acknowledgements.
4798
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
4799
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
4800
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
4801
+ # message when a notification is received. If the method is successful, it
4802
+ # generates a response containing an HL7v2 acknowledgment (`ACK`) message. If
4803
+ # the method encounters an error, it returns a negative acknowledgment (`NACK`)
4804
+ # message. This behavior is suitable for replying to HL7v2 interface systems
4805
+ # that expect these acknowledgments.
3426
4806
  # @param [String] parent
3427
4807
  # The name of the HL7v2 store this message belongs to.
3428
4808
  # @param [Google::Apis::HealthcareV1::IngestMessageRequest] ingest_message_request_object
@@ -3462,22 +4842,43 @@ module Google
3462
4842
  # @param [String] parent
3463
4843
  # Name of the HL7v2 store to retrieve messages from.
3464
4844
  # @param [String] filter
3465
- # Restricts messages returned to those matching a filter. Syntax: https://cloud.
3466
- # google.com/appengine/docs/standard/python/search/query_strings Fields/
3467
- # functions available for filtering are: * `message_type`, from the MSH-9.1
3468
- # field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`,
3469
- # the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the
3470
- # MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the
3471
- # timestamp when the message was sent, using the RFC3339 time format for
3472
- # comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:
3473
- # 00:00-05:00"`. * `send_facility`, the care center that the message came from,
3474
- # from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(
3475
- # value, type)`, which matches if the message lists a patient having an ID of
3476
- # the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `
3477
- # PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with
3478
- # key `x` as set using the Message.labels map. For example, `labels."priority"="
3479
- # high"`. The operator `:*` can be used to assert the existence of a label. For
3480
- # example, `labels."priority":*`.
4845
+ # Restricts messages returned to those matching a filter. The following syntax
4846
+ # is available: * A string field value can be written as text inside quotation
4847
+ # marks, for example `"query text"`. The only valid relational operation for
4848
+ # text fields is equality (`=`), where text is searched within the field, rather
4849
+ # than having the field be equal to the text. For example, `"Comment = great"`
4850
+ # returns messages with `great` in the comment field. * A number field value can
4851
+ # be written as an integer, a decimal, or an exponential. The valid relational
4852
+ # operators for number fields are the equality operator (`=`), along with the
4853
+ # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
4854
+ # inequality (`!=`) operator. You can prepend the `NOT` operator to an
4855
+ # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
4856
+ # form. Fields with date and time use the RFC3339 time format. Leading zeros are
4857
+ # required for one-digit months and days. The valid relational operators for
4858
+ # date fields are the equality operator (`=`) , along with the less than/greater
4859
+ # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
4860
+ # operator. You can prepend the `NOT` operator to an expression to negate it. *
4861
+ # Multiple field query expressions can be combined in one query by adding `AND`
4862
+ # or `OR` operators between the expressions. If a boolean operator appears
4863
+ # within a quoted string, it is not treated as special, it's just another part
4864
+ # of the character string to be matched. You can prepend the `NOT` operator to
4865
+ # an expression to negate it. Fields/functions available for filtering are: * `
4866
+ # message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`.
4867
+ # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the
4868
+ # dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-
4869
+ # 01-02"`. * `send_time`, the timestamp when the message was sent, using the
4870
+ # RFC3339 time format for comparisons, from the MSH-7 segment. For example, `
4871
+ # send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when
4872
+ # the message was created in the HL7v2 store. Use the RFC3339 time format for
4873
+ # comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `
4874
+ # send_facility`, the care center that the message came from, from the MSH-4
4875
+ # segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`,
4876
+ # which matches if the message lists a patient having an ID of the given value
4877
+ # and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("
4878
+ # 123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as
4879
+ # set using the Message.labels map. For example, `labels."priority"="high"`. The
4880
+ # operator `:*` can be used to assert the existence of a label. For example, `
4881
+ # labels."priority":*`.
3481
4882
  # @param [String] order_by
3482
4883
  # Orders messages returned by the specified order_by clause. Syntax: https://
3483
4884
  # cloud.google.com/apis/design/design_patterns#sorting_order Fields available