google-apis-healthcare_v1 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -455,6 +455,177 @@ module Google
|
|
455
455
|
execute_or_queue_command(command, &block)
|
456
456
|
end
|
457
457
|
|
458
|
+
# Checks if a particular data_id of a User data mapping in the specified consent
|
459
|
+
# store is consented for the specified use.
|
460
|
+
# @param [String] consent_store
|
461
|
+
# Required. Name of the consent store where the requested data_id is stored, of
|
462
|
+
# the form `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
463
|
+
# consentStores/`consent_store_id``.
|
464
|
+
# @param [Google::Apis::HealthcareV1::CheckDataAccessRequest] check_data_access_request_object
|
465
|
+
# @param [String] fields
|
466
|
+
# Selector specifying which fields to include in a partial response.
|
467
|
+
# @param [String] quota_user
|
468
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
469
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
470
|
+
# @param [Google::Apis::RequestOptions] options
|
471
|
+
# Request-specific options
|
472
|
+
#
|
473
|
+
# @yield [result, err] Result & error if block supplied
|
474
|
+
# @yieldparam result [Google::Apis::HealthcareV1::CheckDataAccessResponse] parsed result object
|
475
|
+
# @yieldparam err [StandardError] error object if request failed
|
476
|
+
#
|
477
|
+
# @return [Google::Apis::HealthcareV1::CheckDataAccessResponse]
|
478
|
+
#
|
479
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
480
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
481
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
482
|
+
def check_consent_store_data_access(consent_store, check_data_access_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
483
|
+
command = make_simple_command(:post, 'v1/{+consentStore}:checkDataAccess', options)
|
484
|
+
command.request_representation = Google::Apis::HealthcareV1::CheckDataAccessRequest::Representation
|
485
|
+
command.request_object = check_data_access_request_object
|
486
|
+
command.response_representation = Google::Apis::HealthcareV1::CheckDataAccessResponse::Representation
|
487
|
+
command.response_class = Google::Apis::HealthcareV1::CheckDataAccessResponse
|
488
|
+
command.params['consentStore'] = consent_store unless consent_store.nil?
|
489
|
+
command.query['fields'] = fields unless fields.nil?
|
490
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
491
|
+
execute_or_queue_command(command, &block)
|
492
|
+
end
|
493
|
+
|
494
|
+
# Creates a new consent store in the parent dataset. Attempting to create a
|
495
|
+
# consent store with the same ID as an existing store fails with an
|
496
|
+
# ALREADY_EXISTS error.
|
497
|
+
# @param [String] parent
|
498
|
+
# Required. The name of the dataset this consent store belongs to.
|
499
|
+
# @param [Google::Apis::HealthcareV1::ConsentStore] consent_store_object
|
500
|
+
# @param [String] consent_store_id
|
501
|
+
# Required. The ID of the consent store to create. The string must match the
|
502
|
+
# following regex: `[\p`L`\p`N`_\-\.]`1,256``. Cannot be changed after creation.
|
503
|
+
# @param [String] fields
|
504
|
+
# Selector specifying which fields to include in a partial response.
|
505
|
+
# @param [String] quota_user
|
506
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
507
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
508
|
+
# @param [Google::Apis::RequestOptions] options
|
509
|
+
# Request-specific options
|
510
|
+
#
|
511
|
+
# @yield [result, err] Result & error if block supplied
|
512
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ConsentStore] parsed result object
|
513
|
+
# @yieldparam err [StandardError] error object if request failed
|
514
|
+
#
|
515
|
+
# @return [Google::Apis::HealthcareV1::ConsentStore]
|
516
|
+
#
|
517
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
518
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
519
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
520
|
+
def create_project_location_dataset_consent_store(parent, consent_store_object = nil, consent_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
521
|
+
command = make_simple_command(:post, 'v1/{+parent}/consentStores', options)
|
522
|
+
command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
|
523
|
+
command.request_object = consent_store_object
|
524
|
+
command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
|
525
|
+
command.response_class = Google::Apis::HealthcareV1::ConsentStore
|
526
|
+
command.params['parent'] = parent unless parent.nil?
|
527
|
+
command.query['consentStoreId'] = consent_store_id unless consent_store_id.nil?
|
528
|
+
command.query['fields'] = fields unless fields.nil?
|
529
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
530
|
+
execute_or_queue_command(command, &block)
|
531
|
+
end
|
532
|
+
|
533
|
+
# Deletes the specified consent store and removes all the consent store's data.
|
534
|
+
# @param [String] name
|
535
|
+
# Required. The resource name of the consent store to delete.
|
536
|
+
# @param [String] fields
|
537
|
+
# Selector specifying which fields to include in a partial response.
|
538
|
+
# @param [String] quota_user
|
539
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
540
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
541
|
+
# @param [Google::Apis::RequestOptions] options
|
542
|
+
# Request-specific options
|
543
|
+
#
|
544
|
+
# @yield [result, err] Result & error if block supplied
|
545
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
|
546
|
+
# @yieldparam err [StandardError] error object if request failed
|
547
|
+
#
|
548
|
+
# @return [Google::Apis::HealthcareV1::Empty]
|
549
|
+
#
|
550
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
551
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
552
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
553
|
+
def delete_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
554
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
555
|
+
command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
|
556
|
+
command.response_class = Google::Apis::HealthcareV1::Empty
|
557
|
+
command.params['name'] = name unless name.nil?
|
558
|
+
command.query['fields'] = fields unless fields.nil?
|
559
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
560
|
+
execute_or_queue_command(command, &block)
|
561
|
+
end
|
562
|
+
|
563
|
+
# Evaluates the user's Consents for all matching User data mappings. Note: User
|
564
|
+
# data mappings are indexed asynchronously, which can cause a slight delay
|
565
|
+
# between the time mappings are created or updated and when they are included in
|
566
|
+
# EvaluateUserConsents results.
|
567
|
+
# @param [String] consent_store
|
568
|
+
# Required. Name of the consent store to retrieve User data mappings from.
|
569
|
+
# @param [Google::Apis::HealthcareV1::EvaluateUserConsentsRequest] evaluate_user_consents_request_object
|
570
|
+
# @param [String] fields
|
571
|
+
# Selector specifying which fields to include in a partial response.
|
572
|
+
# @param [String] quota_user
|
573
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
574
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
575
|
+
# @param [Google::Apis::RequestOptions] options
|
576
|
+
# Request-specific options
|
577
|
+
#
|
578
|
+
# @yield [result, err] Result & error if block supplied
|
579
|
+
# @yieldparam result [Google::Apis::HealthcareV1::EvaluateUserConsentsResponse] parsed result object
|
580
|
+
# @yieldparam err [StandardError] error object if request failed
|
581
|
+
#
|
582
|
+
# @return [Google::Apis::HealthcareV1::EvaluateUserConsentsResponse]
|
583
|
+
#
|
584
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
585
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
586
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
587
|
+
def evaluate_consent_store_user_consents(consent_store, evaluate_user_consents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
588
|
+
command = make_simple_command(:post, 'v1/{+consentStore}:evaluateUserConsents', options)
|
589
|
+
command.request_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsRequest::Representation
|
590
|
+
command.request_object = evaluate_user_consents_request_object
|
591
|
+
command.response_representation = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse::Representation
|
592
|
+
command.response_class = Google::Apis::HealthcareV1::EvaluateUserConsentsResponse
|
593
|
+
command.params['consentStore'] = consent_store unless consent_store.nil?
|
594
|
+
command.query['fields'] = fields unless fields.nil?
|
595
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
596
|
+
execute_or_queue_command(command, &block)
|
597
|
+
end
|
598
|
+
|
599
|
+
# Gets the specified consent store.
|
600
|
+
# @param [String] name
|
601
|
+
# Required. The resource name of the consent store to get.
|
602
|
+
# @param [String] fields
|
603
|
+
# Selector specifying which fields to include in a partial response.
|
604
|
+
# @param [String] quota_user
|
605
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
606
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
607
|
+
# @param [Google::Apis::RequestOptions] options
|
608
|
+
# Request-specific options
|
609
|
+
#
|
610
|
+
# @yield [result, err] Result & error if block supplied
|
611
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ConsentStore] parsed result object
|
612
|
+
# @yieldparam err [StandardError] error object if request failed
|
613
|
+
#
|
614
|
+
# @return [Google::Apis::HealthcareV1::ConsentStore]
|
615
|
+
#
|
616
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
617
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
618
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
619
|
+
def get_project_location_dataset_consent_store(name, fields: nil, quota_user: nil, options: nil, &block)
|
620
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
621
|
+
command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
|
622
|
+
command.response_class = Google::Apis::HealthcareV1::ConsentStore
|
623
|
+
command.params['name'] = name unless name.nil?
|
624
|
+
command.query['fields'] = fields unless fields.nil?
|
625
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
626
|
+
execute_or_queue_command(command, &block)
|
627
|
+
end
|
628
|
+
|
458
629
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
459
630
|
# resource exists and does not have a policy set.
|
460
631
|
# @param [String] resource
|
@@ -496,6 +667,141 @@ module Google
|
|
496
667
|
execute_or_queue_command(command, &block)
|
497
668
|
end
|
498
669
|
|
670
|
+
# Lists the consent stores in the specified dataset.
|
671
|
+
# @param [String] parent
|
672
|
+
# Required. Name of the dataset.
|
673
|
+
# @param [String] filter
|
674
|
+
# Optional. Restricts the stores returned to those matching a filter. Only
|
675
|
+
# filtering on labels is supported. For example, `filter=labels.key=value`.
|
676
|
+
# @param [Fixnum] page_size
|
677
|
+
# Optional. Limit on the number of consent stores to return in a single response.
|
678
|
+
# If not specified, 100 is used. May not be larger than 1000.
|
679
|
+
# @param [String] page_token
|
680
|
+
# Optional. Token to retrieve the next page of results, or empty to get the
|
681
|
+
# first page.
|
682
|
+
# @param [String] fields
|
683
|
+
# Selector specifying which fields to include in a partial response.
|
684
|
+
# @param [String] quota_user
|
685
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
686
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
687
|
+
# @param [Google::Apis::RequestOptions] options
|
688
|
+
# Request-specific options
|
689
|
+
#
|
690
|
+
# @yield [result, err] Result & error if block supplied
|
691
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ListConsentStoresResponse] parsed result object
|
692
|
+
# @yieldparam err [StandardError] error object if request failed
|
693
|
+
#
|
694
|
+
# @return [Google::Apis::HealthcareV1::ListConsentStoresResponse]
|
695
|
+
#
|
696
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
697
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
698
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
699
|
+
def list_project_location_dataset_consent_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
700
|
+
command = make_simple_command(:get, 'v1/{+parent}/consentStores', options)
|
701
|
+
command.response_representation = Google::Apis::HealthcareV1::ListConsentStoresResponse::Representation
|
702
|
+
command.response_class = Google::Apis::HealthcareV1::ListConsentStoresResponse
|
703
|
+
command.params['parent'] = parent unless parent.nil?
|
704
|
+
command.query['filter'] = filter unless filter.nil?
|
705
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
706
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
707
|
+
command.query['fields'] = fields unless fields.nil?
|
708
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
709
|
+
execute_or_queue_command(command, &block)
|
710
|
+
end
|
711
|
+
|
712
|
+
# Updates the specified consent store.
|
713
|
+
# @param [String] name
|
714
|
+
# Resource name of the consent store, of the form `projects/`project_id`/
|
715
|
+
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id``
|
716
|
+
# . Cannot be changed after creation.
|
717
|
+
# @param [Google::Apis::HealthcareV1::ConsentStore] consent_store_object
|
718
|
+
# @param [String] update_mask
|
719
|
+
# Required. The update mask that applies to the resource. For the `FieldMask`
|
720
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
721
|
+
# google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `
|
722
|
+
# enable_consent_create_on_update` fields are allowed to be updated.
|
723
|
+
# @param [String] fields
|
724
|
+
# Selector specifying which fields to include in a partial response.
|
725
|
+
# @param [String] quota_user
|
726
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
727
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
728
|
+
# @param [Google::Apis::RequestOptions] options
|
729
|
+
# Request-specific options
|
730
|
+
#
|
731
|
+
# @yield [result, err] Result & error if block supplied
|
732
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ConsentStore] parsed result object
|
733
|
+
# @yieldparam err [StandardError] error object if request failed
|
734
|
+
#
|
735
|
+
# @return [Google::Apis::HealthcareV1::ConsentStore]
|
736
|
+
#
|
737
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
738
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
739
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
740
|
+
def patch_project_location_dataset_consent_store(name, consent_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
741
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
742
|
+
command.request_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
|
743
|
+
command.request_object = consent_store_object
|
744
|
+
command.response_representation = Google::Apis::HealthcareV1::ConsentStore::Representation
|
745
|
+
command.response_class = Google::Apis::HealthcareV1::ConsentStore
|
746
|
+
command.params['name'] = name unless name.nil?
|
747
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
748
|
+
command.query['fields'] = fields unless fields.nil?
|
749
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
750
|
+
execute_or_queue_command(command, &block)
|
751
|
+
end
|
752
|
+
|
753
|
+
# Queries all data_ids that are consented for a specified use in the given
|
754
|
+
# consent store and writes them to a specified destination. The returned
|
755
|
+
# Operation includes a progress counter for the number of User data mappings
|
756
|
+
# processed. Errors are logged to Cloud Logging (see [Viewing logs] (cloud.
|
757
|
+
# google.com/healthcare/docs/how-tos/logging)). For example, the following
|
758
|
+
# sample log entry shows a `failed to evaluate consent policy` error that
|
759
|
+
# occurred during a QueryAccessibleData call to consent store `projects/`
|
760
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
761
|
+
# consent_store_id``. ```json jsonPayload: ` @type: "type.googleapis.com/google.
|
762
|
+
# cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: ` code: 9 message:
|
763
|
+
# "failed to evaluate consent policy" ` resourceName: "projects/`project_id`/
|
764
|
+
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
765
|
+
# consents/`consent_id`" ` logName: "projects/`project_id`/logs/healthcare.
|
766
|
+
# googleapis.com%2Fquery_accessible_data" operation: ` id: "projects/`project_id`
|
767
|
+
# /locations/`location_id`/datasets/`dataset_id`/operations/`operation_id`"
|
768
|
+
# producer: "healthcare.googleapis.com/QueryAccessibleData" ` receiveTimestamp: "
|
769
|
+
# TIMESTAMP" resource: ` labels: ` consent_store_id: "`consent_store_id`"
|
770
|
+
# dataset_id: "`dataset_id`" location: "`location_id`" project_id: "`project_id`"
|
771
|
+
# ` type: "healthcare_consent_store" ` severity: "ERROR" timestamp: "TIMESTAMP"
|
772
|
+
# ```
|
773
|
+
# @param [String] consent_store
|
774
|
+
# Required. Name of the consent store to retrieve User data mappings from.
|
775
|
+
# @param [Google::Apis::HealthcareV1::QueryAccessibleDataRequest] query_accessible_data_request_object
|
776
|
+
# @param [String] fields
|
777
|
+
# Selector specifying which fields to include in a partial response.
|
778
|
+
# @param [String] quota_user
|
779
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
780
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
781
|
+
# @param [Google::Apis::RequestOptions] options
|
782
|
+
# Request-specific options
|
783
|
+
#
|
784
|
+
# @yield [result, err] Result & error if block supplied
|
785
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
|
786
|
+
# @yieldparam err [StandardError] error object if request failed
|
787
|
+
#
|
788
|
+
# @return [Google::Apis::HealthcareV1::Operation]
|
789
|
+
#
|
790
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
791
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
792
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
793
|
+
def query_consent_store_accessible_data(consent_store, query_accessible_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
794
|
+
command = make_simple_command(:post, 'v1/{+consentStore}:queryAccessibleData', options)
|
795
|
+
command.request_representation = Google::Apis::HealthcareV1::QueryAccessibleDataRequest::Representation
|
796
|
+
command.request_object = query_accessible_data_request_object
|
797
|
+
command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
|
798
|
+
command.response_class = Google::Apis::HealthcareV1::Operation
|
799
|
+
command.params['consentStore'] = consent_store unless consent_store.nil?
|
800
|
+
command.query['fields'] = fields unless fields.nil?
|
801
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
802
|
+
execute_or_queue_command(command, &block)
|
803
|
+
end
|
804
|
+
|
499
805
|
# Sets the access control policy on the specified resource. Replaces any
|
500
806
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
501
807
|
# PERMISSION_DENIED` errors.
|
@@ -570,6 +876,1017 @@ module Google
|
|
570
876
|
execute_or_queue_command(command, &block)
|
571
877
|
end
|
572
878
|
|
879
|
+
# Creates a new Attribute definition in the parent consent store.
|
880
|
+
# @param [String] parent
|
881
|
+
# Required. The name of the consent store that this Attribute definition belongs
|
882
|
+
# to.
|
883
|
+
# @param [Google::Apis::HealthcareV1::AttributeDefinition] attribute_definition_object
|
884
|
+
# @param [String] attribute_definition_id
|
885
|
+
# Required. The ID of the Attribute definition to create. The string must match
|
886
|
+
# the following regex: `_a-zA-Z`0,255`` and must not be a reserved keyword
|
887
|
+
# within the Common Expression Language as listed on https://github.com/google/
|
888
|
+
# cel-spec/blob/master/doc/langdef.md.
|
889
|
+
# @param [String] fields
|
890
|
+
# Selector specifying which fields to include in a partial response.
|
891
|
+
# @param [String] quota_user
|
892
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
893
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
894
|
+
# @param [Google::Apis::RequestOptions] options
|
895
|
+
# Request-specific options
|
896
|
+
#
|
897
|
+
# @yield [result, err] Result & error if block supplied
|
898
|
+
# @yieldparam result [Google::Apis::HealthcareV1::AttributeDefinition] parsed result object
|
899
|
+
# @yieldparam err [StandardError] error object if request failed
|
900
|
+
#
|
901
|
+
# @return [Google::Apis::HealthcareV1::AttributeDefinition]
|
902
|
+
#
|
903
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
904
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
905
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
906
|
+
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)
|
907
|
+
command = make_simple_command(:post, 'v1/{+parent}/attributeDefinitions', options)
|
908
|
+
command.request_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
|
909
|
+
command.request_object = attribute_definition_object
|
910
|
+
command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
|
911
|
+
command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
|
912
|
+
command.params['parent'] = parent unless parent.nil?
|
913
|
+
command.query['attributeDefinitionId'] = attribute_definition_id unless attribute_definition_id.nil?
|
914
|
+
command.query['fields'] = fields unless fields.nil?
|
915
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
916
|
+
execute_or_queue_command(command, &block)
|
917
|
+
end
|
918
|
+
|
919
|
+
# Deletes the specified Attribute definition. Fails if the Attribute definition
|
920
|
+
# is referenced by any User data mapping, or the latest revision of any Consent.
|
921
|
+
# @param [String] name
|
922
|
+
# Required. The resource name of the Attribute definition to delete. To preserve
|
923
|
+
# referential integrity, Attribute definitions referenced by a User data mapping
|
924
|
+
# or the latest revision of a Consent cannot be deleted.
|
925
|
+
# @param [String] fields
|
926
|
+
# Selector specifying which fields to include in a partial response.
|
927
|
+
# @param [String] quota_user
|
928
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
929
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
930
|
+
# @param [Google::Apis::RequestOptions] options
|
931
|
+
# Request-specific options
|
932
|
+
#
|
933
|
+
# @yield [result, err] Result & error if block supplied
|
934
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
|
935
|
+
# @yieldparam err [StandardError] error object if request failed
|
936
|
+
#
|
937
|
+
# @return [Google::Apis::HealthcareV1::Empty]
|
938
|
+
#
|
939
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
940
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
941
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
942
|
+
def delete_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil, &block)
|
943
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
944
|
+
command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
|
945
|
+
command.response_class = Google::Apis::HealthcareV1::Empty
|
946
|
+
command.params['name'] = name unless name.nil?
|
947
|
+
command.query['fields'] = fields unless fields.nil?
|
948
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
949
|
+
execute_or_queue_command(command, &block)
|
950
|
+
end
|
951
|
+
|
952
|
+
# Gets the specified Attribute definition.
|
953
|
+
# @param [String] name
|
954
|
+
# Required. The resource name of the Attribute definition to get.
|
955
|
+
# @param [String] fields
|
956
|
+
# Selector specifying which fields to include in a partial response.
|
957
|
+
# @param [String] quota_user
|
958
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
959
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
960
|
+
# @param [Google::Apis::RequestOptions] options
|
961
|
+
# Request-specific options
|
962
|
+
#
|
963
|
+
# @yield [result, err] Result & error if block supplied
|
964
|
+
# @yieldparam result [Google::Apis::HealthcareV1::AttributeDefinition] parsed result object
|
965
|
+
# @yieldparam err [StandardError] error object if request failed
|
966
|
+
#
|
967
|
+
# @return [Google::Apis::HealthcareV1::AttributeDefinition]
|
968
|
+
#
|
969
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
970
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
971
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
972
|
+
def get_project_location_dataset_consent_store_attribute_definition(name, fields: nil, quota_user: nil, options: nil, &block)
|
973
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
974
|
+
command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
|
975
|
+
command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
|
976
|
+
command.params['name'] = name unless name.nil?
|
977
|
+
command.query['fields'] = fields unless fields.nil?
|
978
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
979
|
+
execute_or_queue_command(command, &block)
|
980
|
+
end
|
981
|
+
|
982
|
+
# Lists the Attribute definitions in the specified consent store.
|
983
|
+
# @param [String] parent
|
984
|
+
# Required. Name of the consent store to retrieve Attribute definitions from.
|
985
|
+
# @param [String] filter
|
986
|
+
# Optional. Restricts the attributes returned to those matching a filter. The
|
987
|
+
# only field available for filtering is `category`. For example, `filter=
|
988
|
+
# category=\"REQUEST\"`.
|
989
|
+
# @param [Fixnum] page_size
|
990
|
+
# Optional. Limit on the number of Attribute definitions to return in a single
|
991
|
+
# response. If not specified, 100 is used. May not be larger than 1000.
|
992
|
+
# @param [String] page_token
|
993
|
+
# Optional. Token to retrieve the next page of results or empty to get the first
|
994
|
+
# page.
|
995
|
+
# @param [String] fields
|
996
|
+
# Selector specifying which fields to include in a partial response.
|
997
|
+
# @param [String] quota_user
|
998
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
999
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1000
|
+
# @param [Google::Apis::RequestOptions] options
|
1001
|
+
# Request-specific options
|
1002
|
+
#
|
1003
|
+
# @yield [result, err] Result & error if block supplied
|
1004
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse] parsed result object
|
1005
|
+
# @yieldparam err [StandardError] error object if request failed
|
1006
|
+
#
|
1007
|
+
# @return [Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse]
|
1008
|
+
#
|
1009
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1010
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1011
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1012
|
+
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)
|
1013
|
+
command = make_simple_command(:get, 'v1/{+parent}/attributeDefinitions', options)
|
1014
|
+
command.response_representation = Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse::Representation
|
1015
|
+
command.response_class = Google::Apis::HealthcareV1::ListAttributeDefinitionsResponse
|
1016
|
+
command.params['parent'] = parent unless parent.nil?
|
1017
|
+
command.query['filter'] = filter unless filter.nil?
|
1018
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1019
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1020
|
+
command.query['fields'] = fields unless fields.nil?
|
1021
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1022
|
+
execute_or_queue_command(command, &block)
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# Updates the specified Attribute definition.
|
1026
|
+
# @param [String] name
|
1027
|
+
# Resource name of the Attribute definition, of the form `projects/`project_id`/
|
1028
|
+
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
1029
|
+
# attributeDefinitions/`attribute_definition_id``. Cannot be changed after
|
1030
|
+
# creation.
|
1031
|
+
# @param [Google::Apis::HealthcareV1::AttributeDefinition] attribute_definition_object
|
1032
|
+
# @param [String] update_mask
|
1033
|
+
# Required. The update mask that applies to the resource. For the `FieldMask`
|
1034
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
1035
|
+
# google.protobuf#fieldmask. Only the `description`, `allowed_values`, `
|
1036
|
+
# consent_default_values` and `data_mapping_default_value` fields can be updated.
|
1037
|
+
# The updated `allowed_values` must contain all values from the previous `
|
1038
|
+
# allowed_values`.
|
1039
|
+
# @param [String] fields
|
1040
|
+
# Selector specifying which fields to include in a partial response.
|
1041
|
+
# @param [String] quota_user
|
1042
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1043
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1044
|
+
# @param [Google::Apis::RequestOptions] options
|
1045
|
+
# Request-specific options
|
1046
|
+
#
|
1047
|
+
# @yield [result, err] Result & error if block supplied
|
1048
|
+
# @yieldparam result [Google::Apis::HealthcareV1::AttributeDefinition] parsed result object
|
1049
|
+
# @yieldparam err [StandardError] error object if request failed
|
1050
|
+
#
|
1051
|
+
# @return [Google::Apis::HealthcareV1::AttributeDefinition]
|
1052
|
+
#
|
1053
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1054
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1055
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1056
|
+
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)
|
1057
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1058
|
+
command.request_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
|
1059
|
+
command.request_object = attribute_definition_object
|
1060
|
+
command.response_representation = Google::Apis::HealthcareV1::AttributeDefinition::Representation
|
1061
|
+
command.response_class = Google::Apis::HealthcareV1::AttributeDefinition
|
1062
|
+
command.params['name'] = name unless name.nil?
|
1063
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1064
|
+
command.query['fields'] = fields unless fields.nil?
|
1065
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1066
|
+
execute_or_queue_command(command, &block)
|
1067
|
+
end
|
1068
|
+
|
1069
|
+
# Creates a new Consent artifact in the parent consent store.
|
1070
|
+
# @param [String] parent
|
1071
|
+
# Required. The name of the consent store this Consent artifact belongs to.
|
1072
|
+
# @param [Google::Apis::HealthcareV1::ConsentArtifact] consent_artifact_object
|
1073
|
+
# @param [String] fields
|
1074
|
+
# Selector specifying which fields to include in a partial response.
|
1075
|
+
# @param [String] quota_user
|
1076
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1077
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1078
|
+
# @param [Google::Apis::RequestOptions] options
|
1079
|
+
# Request-specific options
|
1080
|
+
#
|
1081
|
+
# @yield [result, err] Result & error if block supplied
|
1082
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ConsentArtifact] parsed result object
|
1083
|
+
# @yieldparam err [StandardError] error object if request failed
|
1084
|
+
#
|
1085
|
+
# @return [Google::Apis::HealthcareV1::ConsentArtifact]
|
1086
|
+
#
|
1087
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1088
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1089
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1090
|
+
def create_project_location_dataset_consent_store_consent_artifact(parent, consent_artifact_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1091
|
+
command = make_simple_command(:post, 'v1/{+parent}/consentArtifacts', options)
|
1092
|
+
command.request_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
|
1093
|
+
command.request_object = consent_artifact_object
|
1094
|
+
command.response_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
|
1095
|
+
command.response_class = Google::Apis::HealthcareV1::ConsentArtifact
|
1096
|
+
command.params['parent'] = parent unless parent.nil?
|
1097
|
+
command.query['fields'] = fields unless fields.nil?
|
1098
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1099
|
+
execute_or_queue_command(command, &block)
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# Deletes the specified Consent artifact. Fails if the artifact is referenced by
|
1103
|
+
# the latest revision of any Consent.
|
1104
|
+
# @param [String] name
|
1105
|
+
# Required. The resource name of the Consent artifact to delete. To preserve
|
1106
|
+
# referential integrity, Consent artifacts referenced by the latest revision of
|
1107
|
+
# a Consent cannot be deleted.
|
1108
|
+
# @param [String] fields
|
1109
|
+
# Selector specifying which fields to include in a partial response.
|
1110
|
+
# @param [String] quota_user
|
1111
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1112
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1113
|
+
# @param [Google::Apis::RequestOptions] options
|
1114
|
+
# Request-specific options
|
1115
|
+
#
|
1116
|
+
# @yield [result, err] Result & error if block supplied
|
1117
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
|
1118
|
+
# @yieldparam err [StandardError] error object if request failed
|
1119
|
+
#
|
1120
|
+
# @return [Google::Apis::HealthcareV1::Empty]
|
1121
|
+
#
|
1122
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1123
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1124
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1125
|
+
def delete_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil, &block)
|
1126
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
1127
|
+
command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
|
1128
|
+
command.response_class = Google::Apis::HealthcareV1::Empty
|
1129
|
+
command.params['name'] = name unless name.nil?
|
1130
|
+
command.query['fields'] = fields unless fields.nil?
|
1131
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1132
|
+
execute_or_queue_command(command, &block)
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# Gets the specified Consent artifact.
|
1136
|
+
# @param [String] name
|
1137
|
+
# Required. The resource name of the Consent artifact to retrieve.
|
1138
|
+
# @param [String] fields
|
1139
|
+
# Selector specifying which fields to include in a partial response.
|
1140
|
+
# @param [String] quota_user
|
1141
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1142
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1143
|
+
# @param [Google::Apis::RequestOptions] options
|
1144
|
+
# Request-specific options
|
1145
|
+
#
|
1146
|
+
# @yield [result, err] Result & error if block supplied
|
1147
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ConsentArtifact] parsed result object
|
1148
|
+
# @yieldparam err [StandardError] error object if request failed
|
1149
|
+
#
|
1150
|
+
# @return [Google::Apis::HealthcareV1::ConsentArtifact]
|
1151
|
+
#
|
1152
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1153
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1154
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1155
|
+
def get_project_location_dataset_consent_store_consent_artifact(name, fields: nil, quota_user: nil, options: nil, &block)
|
1156
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1157
|
+
command.response_representation = Google::Apis::HealthcareV1::ConsentArtifact::Representation
|
1158
|
+
command.response_class = Google::Apis::HealthcareV1::ConsentArtifact
|
1159
|
+
command.params['name'] = name unless name.nil?
|
1160
|
+
command.query['fields'] = fields unless fields.nil?
|
1161
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1162
|
+
execute_or_queue_command(command, &block)
|
1163
|
+
end
|
1164
|
+
|
1165
|
+
# Lists the Consent artifacts in the specified consent store.
|
1166
|
+
# @param [String] parent
|
1167
|
+
# Required. Name of the consent store to retrieve consent artifacts from.
|
1168
|
+
# @param [String] filter
|
1169
|
+
# Optional. Restricts the artifacts returned to those matching a filter. The
|
1170
|
+
# following syntax is available: * A string field value can be written as text
|
1171
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
1172
|
+
# operation for text fields is equality (`=`), where text is searched within the
|
1173
|
+
# field, rather than having the field be equal to the text. For example, `"
|
1174
|
+
# Comment = great"` returns messages with `great` in the comment field. * A
|
1175
|
+
# number field value can be written as an integer, a decimal, or an exponential.
|
1176
|
+
# The valid relational operators for number fields are the equality operator (`=`
|
1177
|
+
# ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
|
1178
|
+
# Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
|
1179
|
+
# operator to an expression to negate it. * A date field value must be written
|
1180
|
+
# in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
|
1181
|
+
# Leading zeros are required for one-digit months and days. The valid relational
|
1182
|
+
# operators for date fields are the equality operator (`=`) , along with the
|
1183
|
+
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
1184
|
+
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
1185
|
+
# expression to negate it. * Multiple field query expressions can be combined in
|
1186
|
+
# one query by adding `AND` or `OR` operators between the expressions. If a
|
1187
|
+
# boolean operator appears within a quoted string, it is not treated as special,
|
1188
|
+
# it's just another part of the character string to be matched. You can prepend
|
1189
|
+
# the `NOT` operator to an expression to negate it. The fields available for
|
1190
|
+
# filtering are: - user_id. For example, `filter=user_id=\"user123\"`. -
|
1191
|
+
# consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=
|
1192
|
+
# \"value\"` or `filter=HasMetadata(\"testkey\")`.
|
1193
|
+
# @param [Fixnum] page_size
|
1194
|
+
# Optional. Limit on the number of consent artifacts to return in a single
|
1195
|
+
# response. If not specified, 100 is used. May not be larger than 1000.
|
1196
|
+
# @param [String] page_token
|
1197
|
+
# Optional. The next_page_token value returned from the previous List request,
|
1198
|
+
# if any.
|
1199
|
+
# @param [String] fields
|
1200
|
+
# Selector specifying which fields to include in a partial response.
|
1201
|
+
# @param [String] quota_user
|
1202
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1203
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1204
|
+
# @param [Google::Apis::RequestOptions] options
|
1205
|
+
# Request-specific options
|
1206
|
+
#
|
1207
|
+
# @yield [result, err] Result & error if block supplied
|
1208
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ListConsentArtifactsResponse] parsed result object
|
1209
|
+
# @yieldparam err [StandardError] error object if request failed
|
1210
|
+
#
|
1211
|
+
# @return [Google::Apis::HealthcareV1::ListConsentArtifactsResponse]
|
1212
|
+
#
|
1213
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1214
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1215
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1216
|
+
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)
|
1217
|
+
command = make_simple_command(:get, 'v1/{+parent}/consentArtifacts', options)
|
1218
|
+
command.response_representation = Google::Apis::HealthcareV1::ListConsentArtifactsResponse::Representation
|
1219
|
+
command.response_class = Google::Apis::HealthcareV1::ListConsentArtifactsResponse
|
1220
|
+
command.params['parent'] = parent unless parent.nil?
|
1221
|
+
command.query['filter'] = filter unless filter.nil?
|
1222
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1223
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1224
|
+
command.query['fields'] = fields unless fields.nil?
|
1225
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1226
|
+
execute_or_queue_command(command, &block)
|
1227
|
+
end
|
1228
|
+
|
1229
|
+
# Activates the latest revision of the specified Consent by committing a new
|
1230
|
+
# revision with `state` updated to `ACTIVE`. If the latest revision of the
|
1231
|
+
# specified Consent is in the `ACTIVE` state, no new revision is committed. A
|
1232
|
+
# FAILED_PRECONDITION error occurs if the latest revision of the specified
|
1233
|
+
# Consent is in the `REJECTED` or `REVOKED` state.
|
1234
|
+
# @param [String] name
|
1235
|
+
# Required. The resource name of the Consent to activate, of the form `projects/`
|
1236
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1237
|
+
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
1238
|
+
# revision_id` is specified in the name.
|
1239
|
+
# @param [Google::Apis::HealthcareV1::ActivateConsentRequest] activate_consent_request_object
|
1240
|
+
# @param [String] fields
|
1241
|
+
# Selector specifying which fields to include in a partial response.
|
1242
|
+
# @param [String] quota_user
|
1243
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1244
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1245
|
+
# @param [Google::Apis::RequestOptions] options
|
1246
|
+
# Request-specific options
|
1247
|
+
#
|
1248
|
+
# @yield [result, err] Result & error if block supplied
|
1249
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
|
1250
|
+
# @yieldparam err [StandardError] error object if request failed
|
1251
|
+
#
|
1252
|
+
# @return [Google::Apis::HealthcareV1::Consent]
|
1253
|
+
#
|
1254
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1255
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1256
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1257
|
+
def activate_consent(name, activate_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1258
|
+
command = make_simple_command(:post, 'v1/{+name}:activate', options)
|
1259
|
+
command.request_representation = Google::Apis::HealthcareV1::ActivateConsentRequest::Representation
|
1260
|
+
command.request_object = activate_consent_request_object
|
1261
|
+
command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1262
|
+
command.response_class = Google::Apis::HealthcareV1::Consent
|
1263
|
+
command.params['name'] = name unless name.nil?
|
1264
|
+
command.query['fields'] = fields unless fields.nil?
|
1265
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1266
|
+
execute_or_queue_command(command, &block)
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# Creates a new Consent in the parent consent store.
|
1270
|
+
# @param [String] parent
|
1271
|
+
# Required. Name of the consent store.
|
1272
|
+
# @param [Google::Apis::HealthcareV1::Consent] consent_object
|
1273
|
+
# @param [String] fields
|
1274
|
+
# Selector specifying which fields to include in a partial response.
|
1275
|
+
# @param [String] quota_user
|
1276
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1277
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1278
|
+
# @param [Google::Apis::RequestOptions] options
|
1279
|
+
# Request-specific options
|
1280
|
+
#
|
1281
|
+
# @yield [result, err] Result & error if block supplied
|
1282
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
|
1283
|
+
# @yieldparam err [StandardError] error object if request failed
|
1284
|
+
#
|
1285
|
+
# @return [Google::Apis::HealthcareV1::Consent]
|
1286
|
+
#
|
1287
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1288
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1289
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1290
|
+
def create_project_location_dataset_consent_store_consent(parent, consent_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1291
|
+
command = make_simple_command(:post, 'v1/{+parent}/consents', options)
|
1292
|
+
command.request_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1293
|
+
command.request_object = consent_object
|
1294
|
+
command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1295
|
+
command.response_class = Google::Apis::HealthcareV1::Consent
|
1296
|
+
command.params['parent'] = parent unless parent.nil?
|
1297
|
+
command.query['fields'] = fields unless fields.nil?
|
1298
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1299
|
+
execute_or_queue_command(command, &block)
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
# Deletes the Consent and its revisions. To keep a record of the Consent but
|
1303
|
+
# mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [
|
1304
|
+
# DeleteConsentRevision]. This operation does not delete the related Consent
|
1305
|
+
# artifact.
|
1306
|
+
# @param [String] name
|
1307
|
+
# Required. The resource name of the Consent to delete, of the form `projects/`
|
1308
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1309
|
+
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
1310
|
+
# revision_id` is specified in the name.
|
1311
|
+
# @param [String] fields
|
1312
|
+
# Selector specifying which fields to include in a partial response.
|
1313
|
+
# @param [String] quota_user
|
1314
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1315
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1316
|
+
# @param [Google::Apis::RequestOptions] options
|
1317
|
+
# Request-specific options
|
1318
|
+
#
|
1319
|
+
# @yield [result, err] Result & error if block supplied
|
1320
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
|
1321
|
+
# @yieldparam err [StandardError] error object if request failed
|
1322
|
+
#
|
1323
|
+
# @return [Google::Apis::HealthcareV1::Empty]
|
1324
|
+
#
|
1325
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1326
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1327
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1328
|
+
def delete_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil, &block)
|
1329
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
1330
|
+
command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
|
1331
|
+
command.response_class = Google::Apis::HealthcareV1::Empty
|
1332
|
+
command.params['name'] = name unless name.nil?
|
1333
|
+
command.query['fields'] = fields unless fields.nil?
|
1334
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1335
|
+
execute_or_queue_command(command, &block)
|
1336
|
+
end
|
1337
|
+
|
1338
|
+
# Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs
|
1339
|
+
# if the specified revision is the latest revision.
|
1340
|
+
# @param [String] name
|
1341
|
+
# Required. The resource name of the Consent revision to delete, of the form `
|
1342
|
+
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
1343
|
+
# consentStores/`consent_store_id`/consents/`consent_id`@`revision_id``. An
|
1344
|
+
# INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.
|
1345
|
+
# @param [String] fields
|
1346
|
+
# Selector specifying which fields to include in a partial response.
|
1347
|
+
# @param [String] quota_user
|
1348
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1349
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1350
|
+
# @param [Google::Apis::RequestOptions] options
|
1351
|
+
# Request-specific options
|
1352
|
+
#
|
1353
|
+
# @yield [result, err] Result & error if block supplied
|
1354
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
|
1355
|
+
# @yieldparam err [StandardError] error object if request failed
|
1356
|
+
#
|
1357
|
+
# @return [Google::Apis::HealthcareV1::Empty]
|
1358
|
+
#
|
1359
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1360
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1361
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1362
|
+
def delete_project_location_dataset_consent_store_consent_revision(name, fields: nil, quota_user: nil, options: nil, &block)
|
1363
|
+
command = make_simple_command(:delete, 'v1/{+name}:deleteRevision', options)
|
1364
|
+
command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
|
1365
|
+
command.response_class = Google::Apis::HealthcareV1::Empty
|
1366
|
+
command.params['name'] = name unless name.nil?
|
1367
|
+
command.query['fields'] = fields unless fields.nil?
|
1368
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1369
|
+
execute_or_queue_command(command, &block)
|
1370
|
+
end
|
1371
|
+
|
1372
|
+
# Gets the specified revision of a Consent, or the latest revision if `
|
1373
|
+
# revision_id` is not specified in the resource name.
|
1374
|
+
# @param [String] name
|
1375
|
+
# Required. The resource name of the Consent to retrieve, of the form `projects/`
|
1376
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1377
|
+
# consent_store_id`/consents/`consent_id``. In order to retrieve a previous
|
1378
|
+
# revision of the Consent, also provide the revision ID: `projects/`project_id`/
|
1379
|
+
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
1380
|
+
# consents/`consent_id`@`revision_id``
|
1381
|
+
# @param [String] fields
|
1382
|
+
# Selector specifying which fields to include in a partial response.
|
1383
|
+
# @param [String] quota_user
|
1384
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1385
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1386
|
+
# @param [Google::Apis::RequestOptions] options
|
1387
|
+
# Request-specific options
|
1388
|
+
#
|
1389
|
+
# @yield [result, err] Result & error if block supplied
|
1390
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
|
1391
|
+
# @yieldparam err [StandardError] error object if request failed
|
1392
|
+
#
|
1393
|
+
# @return [Google::Apis::HealthcareV1::Consent]
|
1394
|
+
#
|
1395
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1396
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1397
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1398
|
+
def get_project_location_dataset_consent_store_consent(name, fields: nil, quota_user: nil, options: nil, &block)
|
1399
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1400
|
+
command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1401
|
+
command.response_class = Google::Apis::HealthcareV1::Consent
|
1402
|
+
command.params['name'] = name unless name.nil?
|
1403
|
+
command.query['fields'] = fields unless fields.nil?
|
1404
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1405
|
+
execute_or_queue_command(command, &block)
|
1406
|
+
end
|
1407
|
+
|
1408
|
+
# Lists the Consent in the given consent store, returning each Consent's latest
|
1409
|
+
# revision.
|
1410
|
+
# @param [String] parent
|
1411
|
+
# Required. Name of the consent store to retrieve Consents from.
|
1412
|
+
# @param [String] filter
|
1413
|
+
# Optional. Restricts the Consents returned to those matching a filter. The
|
1414
|
+
# following syntax is available: * A string field value can be written as text
|
1415
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
1416
|
+
# operation for text fields is equality (`=`), where text is searched within the
|
1417
|
+
# field, rather than having the field be equal to the text. For example, `"
|
1418
|
+
# Comment = great"` returns messages with `great` in the comment field. * A
|
1419
|
+
# number field value can be written as an integer, a decimal, or an exponential.
|
1420
|
+
# The valid relational operators for number fields are the equality operator (`=`
|
1421
|
+
# ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
|
1422
|
+
# Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
|
1423
|
+
# operator to an expression to negate it. * A date field value must be written
|
1424
|
+
# in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
|
1425
|
+
# Leading zeros are required for one-digit months and days. The valid relational
|
1426
|
+
# operators for date fields are the equality operator (`=`) , along with the
|
1427
|
+
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
1428
|
+
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
1429
|
+
# expression to negate it. * Multiple field query expressions can be combined in
|
1430
|
+
# one query by adding `AND` or `OR` operators between the expressions. If a
|
1431
|
+
# boolean operator appears within a quoted string, it is not treated as special,
|
1432
|
+
# it's just another part of the character string to be matched. You can prepend
|
1433
|
+
# the `NOT` operator to an expression to negate it. The fields available for
|
1434
|
+
# filtering are: - user_id. For example, `filter='user_id="user123"'`. -
|
1435
|
+
# consent_artifact - state - revision_create_time - metadata. For example, `
|
1436
|
+
# filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
|
1437
|
+
# @param [Fixnum] page_size
|
1438
|
+
# Optional. Limit on the number of Consents to return in a single response. If
|
1439
|
+
# not specified, 100 is used. May not be larger than 1000.
|
1440
|
+
# @param [String] page_token
|
1441
|
+
# Optional. The next_page_token value returned from the previous List request,
|
1442
|
+
# if any.
|
1443
|
+
# @param [String] fields
|
1444
|
+
# Selector specifying which fields to include in a partial response.
|
1445
|
+
# @param [String] quota_user
|
1446
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1447
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1448
|
+
# @param [Google::Apis::RequestOptions] options
|
1449
|
+
# Request-specific options
|
1450
|
+
#
|
1451
|
+
# @yield [result, err] Result & error if block supplied
|
1452
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ListConsentsResponse] parsed result object
|
1453
|
+
# @yieldparam err [StandardError] error object if request failed
|
1454
|
+
#
|
1455
|
+
# @return [Google::Apis::HealthcareV1::ListConsentsResponse]
|
1456
|
+
#
|
1457
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1458
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1459
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1460
|
+
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)
|
1461
|
+
command = make_simple_command(:get, 'v1/{+parent}/consents', options)
|
1462
|
+
command.response_representation = Google::Apis::HealthcareV1::ListConsentsResponse::Representation
|
1463
|
+
command.response_class = Google::Apis::HealthcareV1::ListConsentsResponse
|
1464
|
+
command.params['parent'] = parent unless parent.nil?
|
1465
|
+
command.query['filter'] = filter unless filter.nil?
|
1466
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1467
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1468
|
+
command.query['fields'] = fields unless fields.nil?
|
1469
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1470
|
+
execute_or_queue_command(command, &block)
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# Lists the revisions of the specified Consent in reverse chronological order.
|
1474
|
+
# @param [String] name
|
1475
|
+
# Required. The resource name of the Consent to retrieve revisions for.
|
1476
|
+
# @param [String] filter
|
1477
|
+
# Optional. Restricts the revisions returned to those matching a filter. The
|
1478
|
+
# following syntax is available: * A string field value can be written as text
|
1479
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
1480
|
+
# operation for text fields is equality (`=`), where text is searched within the
|
1481
|
+
# field, rather than having the field be equal to the text. For example, `"
|
1482
|
+
# Comment = great"` returns messages with `great` in the comment field. * A
|
1483
|
+
# number field value can be written as an integer, a decimal, or an exponential.
|
1484
|
+
# The valid relational operators for number fields are the equality operator (`=`
|
1485
|
+
# ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
|
1486
|
+
# Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
|
1487
|
+
# operator to an expression to negate it. * A date field value must be written
|
1488
|
+
# in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
|
1489
|
+
# Leading zeros are required for one-digit months and days. The valid relational
|
1490
|
+
# operators for date fields are the equality operator (`=`) , along with the
|
1491
|
+
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
1492
|
+
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
1493
|
+
# expression to negate it. * Multiple field query expressions can be combined in
|
1494
|
+
# one query by adding `AND` or `OR` operators between the expressions. If a
|
1495
|
+
# boolean operator appears within a quoted string, it is not treated as special,
|
1496
|
+
# it's just another part of the character string to be matched. You can prepend
|
1497
|
+
# the `NOT` operator to an expression to negate it. Fields available for
|
1498
|
+
# filtering are: - user_id. For example, `filter='user_id="user123"'`. -
|
1499
|
+
# consent_artifact - state - revision_create_time - metadata. For example, `
|
1500
|
+
# filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
|
1501
|
+
# @param [Fixnum] page_size
|
1502
|
+
# Optional. Limit on the number of revisions to return in a single response. If
|
1503
|
+
# not specified, 100 is used. May not be larger than 1000.
|
1504
|
+
# @param [String] page_token
|
1505
|
+
# Optional. Token to retrieve the next page of results or empty if there are no
|
1506
|
+
# more results in the list.
|
1507
|
+
# @param [String] fields
|
1508
|
+
# Selector specifying which fields to include in a partial response.
|
1509
|
+
# @param [String] quota_user
|
1510
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1511
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1512
|
+
# @param [Google::Apis::RequestOptions] options
|
1513
|
+
# Request-specific options
|
1514
|
+
#
|
1515
|
+
# @yield [result, err] Result & error if block supplied
|
1516
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ListConsentRevisionsResponse] parsed result object
|
1517
|
+
# @yieldparam err [StandardError] error object if request failed
|
1518
|
+
#
|
1519
|
+
# @return [Google::Apis::HealthcareV1::ListConsentRevisionsResponse]
|
1520
|
+
#
|
1521
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1522
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1523
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1524
|
+
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)
|
1525
|
+
command = make_simple_command(:get, 'v1/{+name}:listRevisions', options)
|
1526
|
+
command.response_representation = Google::Apis::HealthcareV1::ListConsentRevisionsResponse::Representation
|
1527
|
+
command.response_class = Google::Apis::HealthcareV1::ListConsentRevisionsResponse
|
1528
|
+
command.params['name'] = name unless name.nil?
|
1529
|
+
command.query['filter'] = filter unless filter.nil?
|
1530
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1531
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1532
|
+
command.query['fields'] = fields unless fields.nil?
|
1533
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1534
|
+
execute_or_queue_command(command, &block)
|
1535
|
+
end
|
1536
|
+
|
1537
|
+
# Updates the latest revision of the specified Consent by committing a new
|
1538
|
+
# revision with the changes. A FAILED_PRECONDITION error occurs if the latest
|
1539
|
+
# revision of the specified Consent is in the `REJECTED` or `REVOKED` state.
|
1540
|
+
# @param [String] name
|
1541
|
+
# Resource name of the Consent, of the form `projects/`project_id`/locations/`
|
1542
|
+
# location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
|
1543
|
+
# consent_id``. Cannot be changed after creation.
|
1544
|
+
# @param [Google::Apis::HealthcareV1::Consent] consent_object
|
1545
|
+
# @param [String] update_mask
|
1546
|
+
# Required. The update mask to apply to the resource. For the `FieldMask`
|
1547
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
1548
|
+
# google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`,
|
1549
|
+
# and `metadata` fields can be updated.
|
1550
|
+
# @param [String] fields
|
1551
|
+
# Selector specifying which fields to include in a partial response.
|
1552
|
+
# @param [String] quota_user
|
1553
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1554
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1555
|
+
# @param [Google::Apis::RequestOptions] options
|
1556
|
+
# Request-specific options
|
1557
|
+
#
|
1558
|
+
# @yield [result, err] Result & error if block supplied
|
1559
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
|
1560
|
+
# @yieldparam err [StandardError] error object if request failed
|
1561
|
+
#
|
1562
|
+
# @return [Google::Apis::HealthcareV1::Consent]
|
1563
|
+
#
|
1564
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1565
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1566
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1567
|
+
def patch_project_location_dataset_consent_store_consent(name, consent_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1568
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1569
|
+
command.request_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1570
|
+
command.request_object = consent_object
|
1571
|
+
command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1572
|
+
command.response_class = Google::Apis::HealthcareV1::Consent
|
1573
|
+
command.params['name'] = name unless name.nil?
|
1574
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1575
|
+
command.query['fields'] = fields unless fields.nil?
|
1576
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1577
|
+
execute_or_queue_command(command, &block)
|
1578
|
+
end
|
1579
|
+
|
1580
|
+
# Rejects the latest revision of the specified Consent by committing a new
|
1581
|
+
# revision with `state` updated to `REJECTED`. If the latest revision of the
|
1582
|
+
# specified Consent is in the `REJECTED` state, no new revision is committed. A
|
1583
|
+
# FAILED_PRECONDITION error occurs if the latest revision of the specified
|
1584
|
+
# Consent is in the `ACTIVE` or `REVOKED` state.
|
1585
|
+
# @param [String] name
|
1586
|
+
# Required. The resource name of the Consent to reject, of the form `projects/`
|
1587
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1588
|
+
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
1589
|
+
# revision_id` is specified in the name.
|
1590
|
+
# @param [Google::Apis::HealthcareV1::RejectConsentRequest] reject_consent_request_object
|
1591
|
+
# @param [String] fields
|
1592
|
+
# Selector specifying which fields to include in a partial response.
|
1593
|
+
# @param [String] quota_user
|
1594
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1595
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1596
|
+
# @param [Google::Apis::RequestOptions] options
|
1597
|
+
# Request-specific options
|
1598
|
+
#
|
1599
|
+
# @yield [result, err] Result & error if block supplied
|
1600
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
|
1601
|
+
# @yieldparam err [StandardError] error object if request failed
|
1602
|
+
#
|
1603
|
+
# @return [Google::Apis::HealthcareV1::Consent]
|
1604
|
+
#
|
1605
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1606
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1607
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1608
|
+
def reject_consent(name, reject_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1609
|
+
command = make_simple_command(:post, 'v1/{+name}:reject', options)
|
1610
|
+
command.request_representation = Google::Apis::HealthcareV1::RejectConsentRequest::Representation
|
1611
|
+
command.request_object = reject_consent_request_object
|
1612
|
+
command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1613
|
+
command.response_class = Google::Apis::HealthcareV1::Consent
|
1614
|
+
command.params['name'] = name unless name.nil?
|
1615
|
+
command.query['fields'] = fields unless fields.nil?
|
1616
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1617
|
+
execute_or_queue_command(command, &block)
|
1618
|
+
end
|
1619
|
+
|
1620
|
+
# Revokes the latest revision of the specified Consent by committing a new
|
1621
|
+
# revision with `state` updated to `REVOKED`. If the latest revision of the
|
1622
|
+
# specified Consent is in the `REVOKED` state, no new revision is committed. A
|
1623
|
+
# FAILED_PRECONDITION error occurs if the latest revision of the given consent
|
1624
|
+
# is in `DRAFT` or `REJECTED` state.
|
1625
|
+
# @param [String] name
|
1626
|
+
# Required. The resource name of the Consent to revoke, of the form `projects/`
|
1627
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1628
|
+
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
1629
|
+
# revision_id` is specified in the name.
|
1630
|
+
# @param [Google::Apis::HealthcareV1::RevokeConsentRequest] revoke_consent_request_object
|
1631
|
+
# @param [String] fields
|
1632
|
+
# Selector specifying which fields to include in a partial response.
|
1633
|
+
# @param [String] quota_user
|
1634
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1635
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1636
|
+
# @param [Google::Apis::RequestOptions] options
|
1637
|
+
# Request-specific options
|
1638
|
+
#
|
1639
|
+
# @yield [result, err] Result & error if block supplied
|
1640
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Consent] parsed result object
|
1641
|
+
# @yieldparam err [StandardError] error object if request failed
|
1642
|
+
#
|
1643
|
+
# @return [Google::Apis::HealthcareV1::Consent]
|
1644
|
+
#
|
1645
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1646
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1647
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1648
|
+
def revoke_consent(name, revoke_consent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1649
|
+
command = make_simple_command(:post, 'v1/{+name}:revoke', options)
|
1650
|
+
command.request_representation = Google::Apis::HealthcareV1::RevokeConsentRequest::Representation
|
1651
|
+
command.request_object = revoke_consent_request_object
|
1652
|
+
command.response_representation = Google::Apis::HealthcareV1::Consent::Representation
|
1653
|
+
command.response_class = Google::Apis::HealthcareV1::Consent
|
1654
|
+
command.params['name'] = name unless name.nil?
|
1655
|
+
command.query['fields'] = fields unless fields.nil?
|
1656
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1657
|
+
execute_or_queue_command(command, &block)
|
1658
|
+
end
|
1659
|
+
|
1660
|
+
# Archives the specified User data mapping.
|
1661
|
+
# @param [String] name
|
1662
|
+
# Required. The resource name of the User data mapping to archive.
|
1663
|
+
# @param [Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest] archive_user_data_mapping_request_object
|
1664
|
+
# @param [String] fields
|
1665
|
+
# Selector specifying which fields to include in a partial response.
|
1666
|
+
# @param [String] quota_user
|
1667
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1668
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1669
|
+
# @param [Google::Apis::RequestOptions] options
|
1670
|
+
# Request-specific options
|
1671
|
+
#
|
1672
|
+
# @yield [result, err] Result & error if block supplied
|
1673
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse] parsed result object
|
1674
|
+
# @yieldparam err [StandardError] error object if request failed
|
1675
|
+
#
|
1676
|
+
# @return [Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse]
|
1677
|
+
#
|
1678
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1679
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1680
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1681
|
+
def archive_user_data_mapping(name, archive_user_data_mapping_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1682
|
+
command = make_simple_command(:post, 'v1/{+name}:archive', options)
|
1683
|
+
command.request_representation = Google::Apis::HealthcareV1::ArchiveUserDataMappingRequest::Representation
|
1684
|
+
command.request_object = archive_user_data_mapping_request_object
|
1685
|
+
command.response_representation = Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse::Representation
|
1686
|
+
command.response_class = Google::Apis::HealthcareV1::ArchiveUserDataMappingResponse
|
1687
|
+
command.params['name'] = name unless name.nil?
|
1688
|
+
command.query['fields'] = fields unless fields.nil?
|
1689
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1690
|
+
execute_or_queue_command(command, &block)
|
1691
|
+
end
|
1692
|
+
|
1693
|
+
# Creates a new User data mapping in the parent consent store.
|
1694
|
+
# @param [String] parent
|
1695
|
+
# Required. Name of the consent store.
|
1696
|
+
# @param [Google::Apis::HealthcareV1::UserDataMapping] user_data_mapping_object
|
1697
|
+
# @param [String] fields
|
1698
|
+
# Selector specifying which fields to include in a partial response.
|
1699
|
+
# @param [String] quota_user
|
1700
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1701
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1702
|
+
# @param [Google::Apis::RequestOptions] options
|
1703
|
+
# Request-specific options
|
1704
|
+
#
|
1705
|
+
# @yield [result, err] Result & error if block supplied
|
1706
|
+
# @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
|
1707
|
+
# @yieldparam err [StandardError] error object if request failed
|
1708
|
+
#
|
1709
|
+
# @return [Google::Apis::HealthcareV1::UserDataMapping]
|
1710
|
+
#
|
1711
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1712
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1713
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1714
|
+
def create_project_location_dataset_consent_store_user_data_mapping(parent, user_data_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1715
|
+
command = make_simple_command(:post, 'v1/{+parent}/userDataMappings', options)
|
1716
|
+
command.request_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
|
1717
|
+
command.request_object = user_data_mapping_object
|
1718
|
+
command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
|
1719
|
+
command.response_class = Google::Apis::HealthcareV1::UserDataMapping
|
1720
|
+
command.params['parent'] = parent unless parent.nil?
|
1721
|
+
command.query['fields'] = fields unless fields.nil?
|
1722
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1723
|
+
execute_or_queue_command(command, &block)
|
1724
|
+
end
|
1725
|
+
|
1726
|
+
# Deletes the specified User data mapping.
|
1727
|
+
# @param [String] name
|
1728
|
+
# Required. The resource name of the User data mapping to delete.
|
1729
|
+
# @param [String] fields
|
1730
|
+
# Selector specifying which fields to include in a partial response.
|
1731
|
+
# @param [String] quota_user
|
1732
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1733
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1734
|
+
# @param [Google::Apis::RequestOptions] options
|
1735
|
+
# Request-specific options
|
1736
|
+
#
|
1737
|
+
# @yield [result, err] Result & error if block supplied
|
1738
|
+
# @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object
|
1739
|
+
# @yieldparam err [StandardError] error object if request failed
|
1740
|
+
#
|
1741
|
+
# @return [Google::Apis::HealthcareV1::Empty]
|
1742
|
+
#
|
1743
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1744
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1745
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1746
|
+
def delete_project_location_dataset_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil, &block)
|
1747
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
1748
|
+
command.response_representation = Google::Apis::HealthcareV1::Empty::Representation
|
1749
|
+
command.response_class = Google::Apis::HealthcareV1::Empty
|
1750
|
+
command.params['name'] = name unless name.nil?
|
1751
|
+
command.query['fields'] = fields unless fields.nil?
|
1752
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1753
|
+
execute_or_queue_command(command, &block)
|
1754
|
+
end
|
1755
|
+
|
1756
|
+
# Gets the specified User data mapping.
|
1757
|
+
# @param [String] name
|
1758
|
+
# Required. The resource name of the User data mapping to retrieve.
|
1759
|
+
# @param [String] fields
|
1760
|
+
# Selector specifying which fields to include in a partial response.
|
1761
|
+
# @param [String] quota_user
|
1762
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1763
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1764
|
+
# @param [Google::Apis::RequestOptions] options
|
1765
|
+
# Request-specific options
|
1766
|
+
#
|
1767
|
+
# @yield [result, err] Result & error if block supplied
|
1768
|
+
# @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
|
1769
|
+
# @yieldparam err [StandardError] error object if request failed
|
1770
|
+
#
|
1771
|
+
# @return [Google::Apis::HealthcareV1::UserDataMapping]
|
1772
|
+
#
|
1773
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1774
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1775
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1776
|
+
def get_project_location_dataset_consent_store_user_data_mapping(name, fields: nil, quota_user: nil, options: nil, &block)
|
1777
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1778
|
+
command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
|
1779
|
+
command.response_class = Google::Apis::HealthcareV1::UserDataMapping
|
1780
|
+
command.params['name'] = name unless name.nil?
|
1781
|
+
command.query['fields'] = fields unless fields.nil?
|
1782
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1783
|
+
execute_or_queue_command(command, &block)
|
1784
|
+
end
|
1785
|
+
|
1786
|
+
# Lists the User data mappings in the specified consent store.
|
1787
|
+
# @param [String] parent
|
1788
|
+
# Required. Name of the consent store to retrieve User data mappings from.
|
1789
|
+
# @param [String] filter
|
1790
|
+
# Optional. Restricts the User data mappings returned to those matching a filter.
|
1791
|
+
# The following syntax is available: * A string field value can be written as
|
1792
|
+
# text inside quotation marks, for example `"query text"`. The only valid
|
1793
|
+
# relational operation for text fields is equality (`=`), where text is searched
|
1794
|
+
# within the field, rather than having the field be equal to the text. For
|
1795
|
+
# example, `"Comment = great"` returns messages with `great` in the comment
|
1796
|
+
# field. * A number field value can be written as an integer, a decimal, or an
|
1797
|
+
# exponential. The valid relational operators for number fields are the equality
|
1798
|
+
# operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`
|
1799
|
+
# , `>=`). Note that there is no inequality (`!=`) operator. You can prepend the
|
1800
|
+
# `NOT` operator to an expression to negate it. * A date field value must be
|
1801
|
+
# written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time
|
1802
|
+
# format. Leading zeros are required for one-digit months and days. The valid
|
1803
|
+
# relational operators for date fields are the equality operator (`=`) , along
|
1804
|
+
# with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
|
1805
|
+
# there is no inequality (`!=`) operator. You can prepend the `NOT` operator to
|
1806
|
+
# an expression to negate it. * Multiple field query expressions can be combined
|
1807
|
+
# in one query by adding `AND` or `OR` operators between the expressions. If a
|
1808
|
+
# boolean operator appears within a quoted string, it is not treated as special,
|
1809
|
+
# it's just another part of the character string to be matched. You can prepend
|
1810
|
+
# the `NOT` operator to an expression to negate it. The fields available for
|
1811
|
+
# filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\"`.
|
1812
|
+
# - archived - archive_time
|
1813
|
+
# @param [Fixnum] page_size
|
1814
|
+
# Optional. Limit on the number of User data mappings to return in a single
|
1815
|
+
# response. If not specified, 100 is used. May not be larger than 1000.
|
1816
|
+
# @param [String] page_token
|
1817
|
+
# Optional. Token to retrieve the next page of results, or empty to get the
|
1818
|
+
# first page.
|
1819
|
+
# @param [String] fields
|
1820
|
+
# Selector specifying which fields to include in a partial response.
|
1821
|
+
# @param [String] quota_user
|
1822
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1823
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1824
|
+
# @param [Google::Apis::RequestOptions] options
|
1825
|
+
# Request-specific options
|
1826
|
+
#
|
1827
|
+
# @yield [result, err] Result & error if block supplied
|
1828
|
+
# @yieldparam result [Google::Apis::HealthcareV1::ListUserDataMappingsResponse] parsed result object
|
1829
|
+
# @yieldparam err [StandardError] error object if request failed
|
1830
|
+
#
|
1831
|
+
# @return [Google::Apis::HealthcareV1::ListUserDataMappingsResponse]
|
1832
|
+
#
|
1833
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1834
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1835
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1836
|
+
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)
|
1837
|
+
command = make_simple_command(:get, 'v1/{+parent}/userDataMappings', options)
|
1838
|
+
command.response_representation = Google::Apis::HealthcareV1::ListUserDataMappingsResponse::Representation
|
1839
|
+
command.response_class = Google::Apis::HealthcareV1::ListUserDataMappingsResponse
|
1840
|
+
command.params['parent'] = parent unless parent.nil?
|
1841
|
+
command.query['filter'] = filter unless filter.nil?
|
1842
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1843
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1844
|
+
command.query['fields'] = fields unless fields.nil?
|
1845
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1846
|
+
execute_or_queue_command(command, &block)
|
1847
|
+
end
|
1848
|
+
|
1849
|
+
# Updates the specified User data mapping.
|
1850
|
+
# @param [String] name
|
1851
|
+
# Resource name of the User data mapping, of the form `projects/`project_id`/
|
1852
|
+
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
1853
|
+
# userDataMappings/`user_data_mapping_id``.
|
1854
|
+
# @param [Google::Apis::HealthcareV1::UserDataMapping] user_data_mapping_object
|
1855
|
+
# @param [String] update_mask
|
1856
|
+
# Required. The update mask that applies to the resource. For the `FieldMask`
|
1857
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
1858
|
+
# google.protobuf#fieldmask. Only the `data_id`, `user_id` and `
|
1859
|
+
# resource_attributes` fields can be updated.
|
1860
|
+
# @param [String] fields
|
1861
|
+
# Selector specifying which fields to include in a partial response.
|
1862
|
+
# @param [String] quota_user
|
1863
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1864
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1865
|
+
# @param [Google::Apis::RequestOptions] options
|
1866
|
+
# Request-specific options
|
1867
|
+
#
|
1868
|
+
# @yield [result, err] Result & error if block supplied
|
1869
|
+
# @yieldparam result [Google::Apis::HealthcareV1::UserDataMapping] parsed result object
|
1870
|
+
# @yieldparam err [StandardError] error object if request failed
|
1871
|
+
#
|
1872
|
+
# @return [Google::Apis::HealthcareV1::UserDataMapping]
|
1873
|
+
#
|
1874
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1875
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1876
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1877
|
+
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)
|
1878
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1879
|
+
command.request_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
|
1880
|
+
command.request_object = user_data_mapping_object
|
1881
|
+
command.response_representation = Google::Apis::HealthcareV1::UserDataMapping::Representation
|
1882
|
+
command.response_class = Google::Apis::HealthcareV1::UserDataMapping
|
1883
|
+
command.params['name'] = name unless name.nil?
|
1884
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1885
|
+
command.query['fields'] = fields unless fields.nil?
|
1886
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1887
|
+
execute_or_queue_command(command, &block)
|
1888
|
+
end
|
1889
|
+
|
573
1890
|
# Creates a new DICOM store within the parent dataset.
|
574
1891
|
# @param [String] parent
|
575
1892
|
# The name of the dataset this DICOM store belongs to.
|