google-apis-healthcare_v1beta1 0.3.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 874d0251e05c116179a2de7d4d86e545e31eb851ce128a74816a3775a315710b
4
- data.tar.gz: 5c2a77ad2c37a7ed73a0100391e7ac57389c070f0caab1e5fcf0f107d5ec902b
3
+ metadata.gz: b5b1b508f859dd4d5a41f9eb2ef1ac1cd1de41089d54fcf8597a6bdf944e1153
4
+ data.tar.gz: e389ffeda475cb53656de5c3172d58432726eca49fe4a1998e373c3982840931
5
5
  SHA512:
6
- metadata.gz: 2816543ab74c918a0ea26a5c974385438a7f7f28b4a31e9e810755b5d528f6dc83f07a2eae4fd65e807c3b76f73619bf291c22db76f51117584912b8d62577b1
7
- data.tar.gz: 551312e4b456c413e4117ff4ffc806683813cae71846a3b90407a479d4fc4cd00740fa1a52585b17301fdf63145a65e8fc43afaaffcbfd6037297612be23a49e
6
+ metadata.gz: aaad37344e62f6b75cf6732917021ce44ab51f27c5ec75bff1a338d7b5d7872a77e03e5e4eeb7be1bb70a8bc5b41f740a128c313faaab6f4b7b82799186cc375
7
+ data.tar.gz: 4f1d8c15e092e8c2d2341b751111337d6f4435939327e8606c371b7b4853819e2a24446482efab6607030b341a4bb4a21f2b119c70c92c304e505cd3f3b62d13
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-healthcare_v1beta1
2
2
 
3
+ ### v0.4.0 (2021-03-04)
4
+
5
+ * Regenerated from discovery document revision 20210217
6
+
3
7
  ### v0.3.0 (2021-02-18)
4
8
 
5
9
  * Regenerated from discovery document revision 20210205
@@ -24,25 +24,27 @@ module Google
24
24
 
25
25
  # Activates the latest revision of the specified Consent by committing a new
26
26
  # revision with `state` updated to `ACTIVE`. If the latest revision of the given
27
- # consent is in the `ACTIVE` state, no new revision is committed.
27
+ # Consent is in the `ACTIVE` state, no new revision is committed. A
28
+ # FAILED_PRECONDITION error occurs if the latest revision of the given consent
29
+ # is in the `REJECTED` or `REVOKED` state.
28
30
  class ActivateConsentRequest
29
31
  include Google::Apis::Core::Hashable
30
32
 
31
- # Required. The resource name of the consent artifact that contains proof of the
32
- # end user's consent, of the form `projects/`project_id`/locations/`location_id`/
33
- # datasets/`dataset_id`/consentStores/`consent_store_id`/consentArtifacts/`
34
- # consent_artifact_id``. If the draft consent had a consent artifact, this
35
- # consent artifact overwrites it.
33
+ # Required. The resource name of the Consent artifact that contains
34
+ # documentation of the user's consent, of the form `projects/`project_id`/
35
+ # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
36
+ # consentArtifacts/`consent_artifact_id``. If the draft Consent had a Consent
37
+ # artifact, this Consent artifact overwrites it.
36
38
  # Corresponds to the JSON property `consentArtifact`
37
39
  # @return [String]
38
40
  attr_accessor :consent_artifact
39
41
 
40
- # Timestamp in UTC of when this consent is considered expired.
42
+ # Timestamp in UTC of when this Consent is considered expired.
41
43
  # Corresponds to the JSON property `expireTime`
42
44
  # @return [String]
43
45
  attr_accessor :expire_time
44
46
 
45
- # The time to live for this consent from when it is marked as active.
47
+ # The time to live for this Consent from when it is marked as active.
46
48
  # Corresponds to the JSON property `ttl`
47
49
  # @return [String]
48
50
  attr_accessor :ttl
@@ -88,7 +90,7 @@ module Google
88
90
  # @return [Array<Google::Apis::HealthcareV1beta1::Entity>]
89
91
  attr_accessor :entities
90
92
 
91
- # entity_mentions contains all the annotated medical entities that were were
93
+ # entity_mentions contains all the annotated medical entities that were
92
94
  # mentioned in the provided document.
93
95
  # Corresponds to the JSON property `entityMentions`
94
96
  # @return [Array<Google::Apis::HealthcareV1beta1::EntityMention>]
@@ -276,13 +278,13 @@ module Google
276
278
  end
277
279
  end
278
280
 
279
- # An attribute value for a consent or data mapping. Each Attribute must have a
280
- # corresponding AttributeDefinition in the consent store that defines the
281
+ # An attribute value for a Consent or User data mapping. Each Attribute must
282
+ # have a corresponding AttributeDefinition in the consent store that defines the
281
283
  # default and allowed values.
282
284
  class Attribute
283
285
  include Google::Apis::Core::Hashable
284
286
 
285
- # Indicates the name of an attribute defined at the consent store.
287
+ # Indicates the name of an attribute defined in the consent store.
286
288
  # Corresponds to the JSON property `attributeDefinitionId`
287
289
  # @return [String]
288
290
  attr_accessor :attribute_definition_id
@@ -323,27 +325,28 @@ module Google
323
325
  # @return [String]
324
326
  attr_accessor :category
325
327
 
326
- # Default values of the attribute in consents. If no default values are
327
- # specified, it defaults to an empty value.
328
+ # Optional. Default values of the attribute in Consents. If no default values
329
+ # are specified, it defaults to an empty value.
328
330
  # Corresponds to the JSON property `consentDefaultValues`
329
331
  # @return [Array<String>]
330
332
  attr_accessor :consent_default_values
331
333
 
332
- # Default value of the attribute in user data mappings. If no default value is
333
- # specified, it defaults to an empty value. This field is only applicable to
334
- # attributes of the category `RESOURCE`.
334
+ # Optional. Default value of the attribute in User data mappings. If no default
335
+ # value is specified, it defaults to an empty value. This field is only
336
+ # applicable to attributes of the category `RESOURCE`.
335
337
  # Corresponds to the JSON property `dataMappingDefaultValue`
336
338
  # @return [String]
337
339
  attr_accessor :data_mapping_default_value
338
340
 
339
- # A description of the attribute.
341
+ # Optional. A description of the attribute.
340
342
  # Corresponds to the JSON property `description`
341
343
  # @return [String]
342
344
  attr_accessor :description
343
345
 
344
- # Resource name of the attribute definition, of the form `projects/`project_id`/
346
+ # Resource name of the Attribute definition, of the form `projects/`project_id`/
345
347
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
346
- # attributeDefinitions/`attribute_definition_id``.
348
+ # attributeDefinitions/`attribute_definition_id``. Cannot be changed after
349
+ # creation.
347
350
  # Corresponds to the JSON property `name`
348
351
  # @return [String]
349
352
  attr_accessor :name
@@ -581,7 +584,7 @@ module Google
581
584
  end
582
585
  end
583
586
 
584
- # Checks if a particular data_id of a User data mapping in the given Consent
587
+ # Checks if a particular data_id of a User data mapping in the given consent
585
588
  # store is consented for a given use.
586
589
  class CheckDataAccessRequest
587
590
  include Google::Apis::Core::Hashable
@@ -591,8 +594,8 @@ module Google
591
594
  # @return [Google::Apis::HealthcareV1beta1::ConsentList]
592
595
  attr_accessor :consent_list
593
596
 
594
- # The unique identifier of the data to check access for. It must exist in the
595
- # given `consent_store`.
597
+ # Required. The unique identifier of the resource to check access for. This
598
+ # identifier must correspond to a User data mapping in the given consent store.
596
599
  # Corresponds to the JSON property `dataId`
597
600
  # @return [String]
598
601
  attr_accessor :data_id
@@ -602,8 +605,8 @@ module Google
602
605
  # @return [Hash<String,String>]
603
606
  attr_accessor :request_attributes
604
607
 
605
- # The view for CheckDataAccessResponse. If unspecified, defaults to `BASIC` and
606
- # returns `consented` as `TRUE` or `FALSE`.
608
+ # Optional. The view for CheckDataAccessResponse. If unspecified, defaults to `
609
+ # BASIC` and returns `consented` as `TRUE` or `FALSE`.
607
610
  # Corresponds to the JSON property `responseView`
608
611
  # @return [String]
609
612
  attr_accessor :response_view
@@ -621,7 +624,7 @@ module Google
621
624
  end
622
625
  end
623
626
 
624
- # Checks if a particular data_id of a User data mapping in the given Consent
627
+ # Checks if a particular data_id of a User data mapping in the given consent
625
628
  # store is consented for a given use.
626
629
  class CheckDataAccessResponse
627
630
  include Google::Apis::Core::Hashable
@@ -631,7 +634,7 @@ module Google
631
634
  # @return [Hash<String,Google::Apis::HealthcareV1beta1::ConsentEvaluation>]
632
635
  attr_accessor :consent_details
633
636
 
634
- # Whether the requested data is consented for the given use.
637
+ # Whether the requested resource is consented for the given use.
635
638
  # Corresponds to the JSON property `consented`
636
639
  # @return [Boolean]
637
640
  attr_accessor :consented
@@ -667,11 +670,11 @@ module Google
667
670
  end
668
671
  end
669
672
 
670
- # Represents an end user's consent.
673
+ # Represents a user's consent.
671
674
  class Consent
672
675
  include Google::Apis::Core::Hashable
673
676
 
674
- # Required. The resource name of the consent artifact that contains proof of the
677
+ # Required. The resource name of the Consent artifact that contains proof of the
675
678
  # end user's consent, of the form `projects/`project_id`/locations/`location_id`/
676
679
  # datasets/`dataset_id`/consentStores/`consent_store_id`/consentArtifacts/`
677
680
  # consent_artifact_id``.
@@ -679,17 +682,17 @@ module Google
679
682
  # @return [String]
680
683
  attr_accessor :consent_artifact
681
684
 
682
- # Timestamp in UTC of when this consent is considered expired.
685
+ # Timestamp in UTC of when this Consent is considered expired.
683
686
  # Corresponds to the JSON property `expireTime`
684
687
  # @return [String]
685
688
  attr_accessor :expire_time
686
689
 
687
- # User-supplied key-value pairs used to organize consent resources. Metadata
688
- # keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of
689
- # maximum 128 bytes - begin with a letter - consist of up to 63 characters
690
- # including lowercase letters, numeric characters, underscores, and dashes
691
- # Metadata values must be: - be between 1 and 63 characters long - have a UTF-8
692
- # encoding of maximum 128 bytes - consist of up to 63 characters including
690
+ # Optional. User-supplied key-value pairs used to organize Consent resources.
691
+ # Metadata keys must: - be between 1 and 63 characters long - have a UTF-8
692
+ # encoding of maximum 128 bytes - begin with a letter - consist of up to 63
693
+ # characters including lowercase letters, numeric characters, underscores, and
694
+ # dashes Metadata values must be: - be between 1 and 63 characters long - have a
695
+ # UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including
693
696
  # lowercase letters, numeric characters, underscores, and dashes No more than 64
694
697
  # metadata entries can be associated with a given consent.
695
698
  # Corresponds to the JSON property `metadata`
@@ -698,12 +701,12 @@ module Google
698
701
 
699
702
  # Resource name of the Consent, of the form `projects/`project_id`/locations/`
700
703
  # location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
701
- # consent_id``.
704
+ # consent_id``. Cannot be changed after creation.
702
705
  # Corresponds to the JSON property `name`
703
706
  # @return [String]
704
707
  attr_accessor :name
705
708
 
706
- # Represents an end user's consent in terms of the resources that can be
709
+ # Optional. Represents a user's consent in terms of the resources that can be
707
710
  # accessed and under what conditions.
708
711
  # Corresponds to the JSON property `policies`
709
712
  # @return [Array<Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1ConsentPolicy>]
@@ -714,19 +717,19 @@ module Google
714
717
  # @return [String]
715
718
  attr_accessor :revision_create_time
716
719
 
717
- # Output only. The revision ID of the consent. The format is an 8-character
720
+ # Output only. The revision ID of the Consent. The format is an 8-character
718
721
  # hexadecimal string. Refer to a specific revision of a Consent by appending `@`
719
722
  # revision_id`` to the Consent's resource name.
720
723
  # Corresponds to the JSON property `revisionId`
721
724
  # @return [String]
722
725
  attr_accessor :revision_id
723
726
 
724
- # Indicates the current state of this consent.
727
+ # Required. Indicates the current state of this Consent.
725
728
  # Corresponds to the JSON property `state`
726
729
  # @return [String]
727
730
  attr_accessor :state
728
731
 
729
- # Input only. The time to live for this consent from when it is created.
732
+ # Input only. The time to live for this Consent from when it is created.
730
733
  # Corresponds to the JSON property `ttl`
731
734
  # @return [String]
732
735
  attr_accessor :ttl
@@ -755,16 +758,18 @@ module Google
755
758
  end
756
759
  end
757
760
 
758
- # Proof of an end user's consent.
761
+ # Documentation of a user's consent.
759
762
  class ConsentArtifact
760
763
  include Google::Apis::Core::Hashable
761
764
 
762
- # Screenshots of the consent content.
765
+ # Optional. Screenshots, PDFs, or other binary information documenting the user'
766
+ # s consent.
763
767
  # Corresponds to the JSON property `consentContentScreenshots`
764
768
  # @return [Array<Google::Apis::HealthcareV1beta1::Image>]
765
769
  attr_accessor :consent_content_screenshots
766
770
 
767
- # An string indicating the version of the consent content.
771
+ # Optional. An string indicating the version of the consent information shown to
772
+ # the user.
768
773
  # Corresponds to the JSON property `consentContentVersion`
769
774
  # @return [String]
770
775
  attr_accessor :consent_content_version
@@ -774,15 +779,15 @@ module Google
774
779
  # @return [Google::Apis::HealthcareV1beta1::Signature]
775
780
  attr_accessor :guardian_signature
776
781
 
777
- # Metadata associated with the consent artifact. For example, the consent locale
778
- # or user agent version.
782
+ # Optional. Metadata associated with the Consent artifact. For example, the
783
+ # consent locale or user agent version.
779
784
  # Corresponds to the JSON property `metadata`
780
785
  # @return [Hash<String,String>]
781
786
  attr_accessor :metadata
782
787
 
783
788
  # Resource name of the Consent artifact, of the form `projects/`project_id`/
784
789
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
785
- # consentArtifacts/`consent_artifact_id``.
790
+ # consentArtifacts/`consent_artifact_id``. Cannot be changed after creation.
786
791
  # Corresponds to the JSON property `name`
787
792
  # @return [String]
788
793
  attr_accessor :name
@@ -859,36 +864,39 @@ module Google
859
864
  end
860
865
  end
861
866
 
862
- # Represents a Consent store.
867
+ # Represents a consent store.
863
868
  class ConsentStore
864
869
  include Google::Apis::Core::Hashable
865
870
 
866
- # Default time to live for consents in this store. Must be at least 24 hours.
867
- # Updating this field will not affect the expiration time of existing consents.
871
+ # Optional. Default time to live for Consents created in this store. Must be at
872
+ # least 24 hours. Updating this field will not affect the expiration time of
873
+ # existing consents.
868
874
  # Corresponds to the JSON property `defaultConsentTtl`
869
875
  # @return [String]
870
876
  attr_accessor :default_consent_ttl
871
877
 
872
- # If true, UpdateConsent creates the consent if it does not already exist.
878
+ # Optional. If `true`, UpdateConsent creates the Consent if it does not already
879
+ # exist. If unspecified, defaults to `false`.
873
880
  # Corresponds to the JSON property `enableConsentCreateOnUpdate`
874
881
  # @return [Boolean]
875
882
  attr_accessor :enable_consent_create_on_update
876
883
  alias_method :enable_consent_create_on_update?, :enable_consent_create_on_update
877
884
 
878
- # User-supplied key-value pairs used to organize Consent stores. Label keys must
879
- # be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128
880
- # bytes, and must conform to the following PCRE regular expression: \p`Ll`\p`Lo``
881
- # 0,62` Label values must be between 1 and 63 characters long, have a UTF-8
882
- # encoding of maximum 128 bytes, and must conform to the following PCRE regular
883
- # expression: [\p`Ll`\p`Lo`\p`N`_-]`0,63` No more than 64 labels can be
884
- # associated with a given store.
885
+ # Optional. User-supplied key-value pairs used to organize consent stores. Label
886
+ # keys must be between 1 and 63 characters long, have a UTF-8 encoding of
887
+ # maximum 128 bytes, and must conform to the following PCRE regular expression: \
888
+ # p`Ll`\p`Lo``0,62`. Label values must be between 1 and 63 characters long, have
889
+ # a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE
890
+ # regular expression: [\p`Ll`\p`Lo`\p`N`_-]`0,63`. No more than 64 labels can be
891
+ # associated with a given store. For more information: https://cloud.google.com/
892
+ # healthcare/docs/how-tos/labeling-resources
885
893
  # Corresponds to the JSON property `labels`
886
894
  # @return [Hash<String,String>]
887
895
  attr_accessor :labels
888
896
 
889
- # Resource name of the Consent store, of the form `projects/`project_id`/
897
+ # Resource name of the consent store, of the form `projects/`project_id`/
890
898
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id``
891
- # .
899
+ # . Cannot be changed after creation.
892
900
  # Corresponds to the JSON property `name`
893
901
  # @return [String]
894
902
  attr_accessor :name
@@ -1535,7 +1543,10 @@ module Google
1535
1543
  end
1536
1544
  end
1537
1545
 
1538
- # Evaluate an end user's Consents for all matching User data mappings.
1546
+ # Evaluate a user's Consents for all matching User data mappings. Note: User
1547
+ # data mappings are indexed asynchronously, causing slight delays between the
1548
+ # time mappings are created or updated and when they are included in
1549
+ # EvaluateUserConsents results.
1539
1550
  class EvaluateUserConsentsRequest
1540
1551
  include Google::Apis::Core::Hashable
1541
1552
 
@@ -1544,30 +1555,31 @@ module Google
1544
1555
  # @return [Google::Apis::HealthcareV1beta1::ConsentList]
1545
1556
  attr_accessor :consent_list
1546
1557
 
1547
- # Limit on the number of user data mappings to return in a single response. If
1548
- # not specified, 100 is used. May not be larger than 1000.
1558
+ # Optional. Limit on the number of User data mappings to return in a single
1559
+ # response. If not specified, 100 is used. May not be larger than 1000.
1549
1560
  # Corresponds to the JSON property `pageSize`
1550
1561
  # @return [Fixnum]
1551
1562
  attr_accessor :page_size
1552
1563
 
1553
- # Token to retrieve the next page of results to get the first page.
1564
+ # Optional. Token to retrieve the next page of results, or empty to get the
1565
+ # first page.
1554
1566
  # Corresponds to the JSON property `pageToken`
1555
1567
  # @return [String]
1556
1568
  attr_accessor :page_token
1557
1569
 
1558
- # The values of request attributes associated with this access request.
1570
+ # Required. The values of request attributes associated with this access request.
1559
1571
  # Corresponds to the JSON property `requestAttributes`
1560
1572
  # @return [Hash<String,String>]
1561
1573
  attr_accessor :request_attributes
1562
1574
 
1563
- # The values of resources attributes associated with the type of data being
1564
- # requested. If no values are specified, then all data types are queried.
1575
+ # Optional. The values of resource attributes associated with the resources
1576
+ # being requested. If no values are specified, then all resources are queried.
1565
1577
  # Corresponds to the JSON property `resourceAttributes`
1566
1578
  # @return [Hash<String,String>]
1567
1579
  attr_accessor :resource_attributes
1568
1580
 
1569
- # The view for EvaluateUserConsentsResponse. If unspecified, defaults to `BASIC`
1570
- # and returns `consented` as `TRUE` or `FALSE`.
1581
+ # Optional. The view for EvaluateUserConsentsResponse. If unspecified, defaults
1582
+ # to `BASIC` and returns `consented` as `TRUE` or `FALSE`.
1571
1583
  # Corresponds to the JSON property `responseView`
1572
1584
  # @return [String]
1573
1585
  attr_accessor :response_view
@@ -1593,11 +1605,11 @@ module Google
1593
1605
  end
1594
1606
  end
1595
1607
 
1596
- # Evaluate an end user's Consents for all matching User data mappings.
1608
+ #
1597
1609
  class EvaluateUserConsentsResponse
1598
1610
  include Google::Apis::Core::Hashable
1599
1611
 
1600
- # Token to retrieve the next page of results or empty if there are no more
1612
+ # Token to retrieve the next page of results, or empty if there are no more
1601
1613
  # results in the list. This token is valid for 72 hours after it is created.
1602
1614
  # Corresponds to the JSON property `nextPageToken`
1603
1615
  # @return [String]
@@ -2361,8 +2373,8 @@ module Google
2361
2373
  end
2362
2374
  end
2363
2375
 
2364
- # Represents an end user's consent in terms of the resources that can be
2365
- # accessed and under what conditions.
2376
+ # Represents a user's consent in terms of the resources that can be accessed and
2377
+ # under what conditions.
2366
2378
  class GoogleCloudHealthcareV1beta1ConsentPolicy
2367
2379
  include Google::Apis::Core::Hashable
2368
2380
 
@@ -2385,8 +2397,9 @@ module Google
2385
2397
  # @return [Google::Apis::HealthcareV1beta1::Expr]
2386
2398
  attr_accessor :authorization_rule
2387
2399
 
2388
- # The data resources that this policy applies to. A data resource is a match if
2389
- # it matches all the attributes listed here.
2400
+ # The resources that this policy applies to. A resource is a match if it matches
2401
+ # all the attributes listed here. If empty, this policy applies to all User data
2402
+ # mappings for the given user.
2390
2403
  # Corresponds to the JSON property `resourceAttributes`
2391
2404
  # @return [Array<Google::Apis::HealthcareV1beta1::Attribute>]
2392
2405
  attr_accessor :resource_attributes
@@ -3384,17 +3397,17 @@ module Google
3384
3397
  end
3385
3398
  end
3386
3399
 
3387
- # Lists the Attribute definitions in the given Consent store.
3400
+ #
3388
3401
  class ListAttributeDefinitionsResponse
3389
3402
  include Google::Apis::Core::Hashable
3390
3403
 
3391
- # The returned attribute definitions. The maximum number of attributes returned
3404
+ # The returned Attribute definitions. The maximum number of attributes returned
3392
3405
  # is determined by the value of page_size in the ListAttributeDefinitionsRequest.
3393
3406
  # Corresponds to the JSON property `attributeDefinitions`
3394
3407
  # @return [Array<Google::Apis::HealthcareV1beta1::AttributeDefinition>]
3395
3408
  attr_accessor :attribute_definitions
3396
3409
 
3397
- # Token to retrieve the next page of results or empty if there are no more
3410
+ # Token to retrieve the next page of results, or empty if there are no more
3398
3411
  # results in the list.
3399
3412
  # Corresponds to the JSON property `nextPageToken`
3400
3413
  # @return [String]
@@ -3411,17 +3424,17 @@ module Google
3411
3424
  end
3412
3425
  end
3413
3426
 
3414
- # Lists the Consent artifacts in the given Consent store.
3427
+ #
3415
3428
  class ListConsentArtifactsResponse
3416
3429
  include Google::Apis::Core::Hashable
3417
3430
 
3418
- # The returned consent artifacts. The maximum number of artifacts returned is
3431
+ # The returned Consent artifacts. The maximum number of artifacts returned is
3419
3432
  # determined by the value of page_size in the ListConsentArtifactsRequest.
3420
3433
  # Corresponds to the JSON property `consentArtifacts`
3421
3434
  # @return [Array<Google::Apis::HealthcareV1beta1::ConsentArtifact>]
3422
3435
  attr_accessor :consent_artifacts
3423
3436
 
3424
- # Token to retrieve the next page of results or empty if there are no more
3437
+ # Token to retrieve the next page of results, or empty if there are no more
3425
3438
  # results in the list.
3426
3439
  # Corresponds to the JSON property `nextPageToken`
3427
3440
  # @return [String]
@@ -3438,17 +3451,17 @@ module Google
3438
3451
  end
3439
3452
  end
3440
3453
 
3441
- # Lists the revisions of the given Consent in reverse chronological order.
3454
+ #
3442
3455
  class ListConsentRevisionsResponse
3443
3456
  include Google::Apis::Core::Hashable
3444
3457
 
3445
- # The returned consent revisions. The maximum number of revisions returned is
3458
+ # The returned Consent revisions. The maximum number of revisions returned is
3446
3459
  # determined by the value of `page_size` in the ListConsentRevisionsRequest.
3447
3460
  # Corresponds to the JSON property `consents`
3448
3461
  # @return [Array<Google::Apis::HealthcareV1beta1::Consent>]
3449
3462
  attr_accessor :consents
3450
3463
 
3451
- # Token to retrieve the next page of results or empty if there are no more
3464
+ # Token to retrieve the next page of results, or empty if there are no more
3452
3465
  # results in the list.
3453
3466
  # Corresponds to the JSON property `nextPageToken`
3454
3467
  # @return [String]
@@ -3465,17 +3478,17 @@ module Google
3465
3478
  end
3466
3479
  end
3467
3480
 
3468
- # Lists the Consent stores in the given dataset.
3481
+ #
3469
3482
  class ListConsentStoresResponse
3470
3483
  include Google::Apis::Core::Hashable
3471
3484
 
3472
- # The returned Consent stores. The maximum number of stores returned is
3485
+ # The returned consent stores. The maximum number of stores returned is
3473
3486
  # determined by the value of page_size in the ListConsentStoresRequest.
3474
3487
  # Corresponds to the JSON property `consentStores`
3475
3488
  # @return [Array<Google::Apis::HealthcareV1beta1::ConsentStore>]
3476
3489
  attr_accessor :consent_stores
3477
3490
 
3478
- # Token to retrieve the next page of results or empty if there are no more
3491
+ # Token to retrieve the next page of results, or empty if there are no more
3479
3492
  # results in the list.
3480
3493
  # Corresponds to the JSON property `nextPageToken`
3481
3494
  # @return [String]
@@ -3492,17 +3505,17 @@ module Google
3492
3505
  end
3493
3506
  end
3494
3507
 
3495
- # Lists the Consents in the given Consent store.
3508
+ #
3496
3509
  class ListConsentsResponse
3497
3510
  include Google::Apis::Core::Hashable
3498
3511
 
3499
- # The returned consents. The maximum number of consents returned is determined
3512
+ # The returned Consents. The maximum number of Consents returned is determined
3500
3513
  # by the value of page_size in the ListConsentsRequest.
3501
3514
  # Corresponds to the JSON property `consents`
3502
3515
  # @return [Array<Google::Apis::HealthcareV1beta1::Consent>]
3503
3516
  attr_accessor :consents
3504
3517
 
3505
- # Token to retrieve the next page of results or empty if there are no more
3518
+ # Token to retrieve the next page of results, or empty if there are no more
3506
3519
  # results in the list.
3507
3520
  # Corresponds to the JSON property `nextPageToken`
3508
3521
  # @return [String]
@@ -3703,17 +3716,17 @@ module Google
3703
3716
  end
3704
3717
  end
3705
3718
 
3706
- # Lists the User data mappings in the given Consent store.
3719
+ #
3707
3720
  class ListUserDataMappingsResponse
3708
3721
  include Google::Apis::Core::Hashable
3709
3722
 
3710
- # Token to retrieve the next page of results or empty if there are no more
3723
+ # Token to retrieve the next page of results, or empty if there are no more
3711
3724
  # results in the list.
3712
3725
  # Corresponds to the JSON property `nextPageToken`
3713
3726
  # @return [String]
3714
3727
  attr_accessor :next_page_token
3715
3728
 
3716
- # The returned user data mappings. The maximum number of user data mappings
3729
+ # The returned User data mappings. The maximum number of User data mappings
3717
3730
  # returned is determined by the value of page_size in the
3718
3731
  # ListUserDataMappingsRequest.
3719
3732
  # Corresponds to the JSON property `userDataMappings`
@@ -4217,7 +4230,7 @@ module Google
4217
4230
  end
4218
4231
  end
4219
4232
 
4220
- # Queries all data_ids that are consented for a given use in the given Consent
4233
+ # Queries all data_ids that are consented for a given use in the given consent
4221
4234
  # store and writes them to a specified destination. The returned Operation
4222
4235
  # includes a progress counter for the number of User data mappings processed.
4223
4236
  # Errors are logged to Cloud Logging (see [Viewing logs] (/healthcare/docs/how-
@@ -4235,9 +4248,9 @@ module Google
4235
4248
  # @return [Hash<String,String>]
4236
4249
  attr_accessor :request_attributes
4237
4250
 
4238
- # The values of resources attributes associated with the type of data being
4239
- # requested. If no values are specified, then all data types are included in the
4240
- # output.
4251
+ # Optional. The values of resource attributes associated with the type of
4252
+ # resources being requested. If no values are specified, then all resource types
4253
+ # are included in the output.
4241
4254
  # Corresponds to the JSON property `resourceAttributes`
4242
4255
  # @return [Hash<String,String>]
4243
4256
  attr_accessor :resource_attributes
@@ -4270,15 +4283,15 @@ module Google
4270
4283
 
4271
4284
  # Rejects the latest revision of the specified Consent by committing a new
4272
4285
  # revision with `state` updated to `REJECTED`. If the latest revision of the
4273
- # given consent is in the `REJECTED` state, no new revision is committed.
4286
+ # given Consent is in the `REJECTED` state, no new revision is committed.
4274
4287
  class RejectConsentRequest
4275
4288
  include Google::Apis::Core::Hashable
4276
4289
 
4277
- # The resource name of the consent artifact that contains proof of the end user'
4278
- # s rejection of the draft consent, of the form `projects/`project_id`/locations/
4279
- # `location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
4280
- # consentArtifacts/`consent_artifact_id``. If the draft consent had a consent
4281
- # artifact, this consent artifact overwrites it.
4290
+ # Optional. The resource name of the Consent artifact that contains
4291
+ # documentation of the user's rejection of the draft Consent, of the form `
4292
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
4293
+ # consentStores/`consent_store_id`/consentArtifacts/`consent_artifact_id``. If
4294
+ # the draft Consent had a Consent artifact, this Consent artifact overwrites it.
4282
4295
  # Corresponds to the JSON property `consentArtifact`
4283
4296
  # @return [String]
4284
4297
  attr_accessor :consent_artifact
@@ -4355,13 +4368,13 @@ module Google
4355
4368
  # @return [Hash<String,Google::Apis::HealthcareV1beta1::ConsentEvaluation>]
4356
4369
  attr_accessor :consent_details
4357
4370
 
4358
- # Whether the requested data is consented for the given use.
4371
+ # Whether the resource is consented for the given use.
4359
4372
  # Corresponds to the JSON property `consented`
4360
4373
  # @return [Boolean]
4361
4374
  attr_accessor :consented
4362
4375
  alias_method :consented?, :consented
4363
4376
 
4364
- # The unique identifier of the data the consents were checked for.
4377
+ # The unique identifier of the evaluated resource.
4365
4378
  # Corresponds to the JSON property `dataId`
4366
4379
  # @return [String]
4367
4380
  attr_accessor :data_id
@@ -4380,13 +4393,13 @@ module Google
4380
4393
 
4381
4394
  # Revokes the latest revision of the specified Consent by committing a new
4382
4395
  # revision with `state` updated to `REVOKED`. If the latest revision of the
4383
- # given consent is in the `REVOKED` state, no new revision is committed.
4396
+ # given Consent is in the `REVOKED` state, no new revision is committed.
4384
4397
  class RevokeConsentRequest
4385
4398
  include Google::Apis::Core::Hashable
4386
4399
 
4387
- # The resource name of the consent artifact that contains proof of the end user'
4388
- # s revocation of the consent, of the form `projects/`project_id`/locations/`
4389
- # location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
4400
+ # Optional. The resource name of the Consent artifact that contains proof of the
4401
+ # user's revocation of the Consent, of the form `projects/`project_id`/locations/
4402
+ # `location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
4390
4403
  # consentArtifacts/`consent_artifact_id``.
4391
4404
  # Corresponds to the JSON property `consentArtifact`
4392
4405
  # @return [String]
@@ -4735,18 +4748,18 @@ module Google
4735
4748
  # @return [Google::Apis::HealthcareV1beta1::Image]
4736
4749
  attr_accessor :image
4737
4750
 
4738
- # Metadata associated with the user's signature. For example, the user's name or
4739
- # the user's title.
4751
+ # Optional. Metadata associated with the user's signature. For example, the user'
4752
+ # s name or the user's title.
4740
4753
  # Corresponds to the JSON property `metadata`
4741
4754
  # @return [Hash<String,String>]
4742
4755
  attr_accessor :metadata
4743
4756
 
4744
- # Timestamp of the signature.
4757
+ # Optional. Timestamp of the signature.
4745
4758
  # Corresponds to the JSON property `signatureTime`
4746
4759
  # @return [String]
4747
4760
  attr_accessor :signature_time
4748
4761
 
4749
- # User's UUID provided by the client.
4762
+ # Required. User's UUID provided by the client.
4750
4763
  # Corresponds to the JSON property `userId`
4751
4764
  # @return [String]
4752
4765
  attr_accessor :user_id
@@ -4970,22 +4983,22 @@ module Google
4970
4983
  end
4971
4984
  end
4972
4985
 
4973
- # Maps a user data entry to its end user and Attributes.
4986
+ # Maps a resource to the associated user and Attributes.
4974
4987
  class UserDataMapping
4975
4988
  include Google::Apis::Core::Hashable
4976
4989
 
4977
- # Output only. Indicates the time when this data mapping was archived.
4990
+ # Output only. Indicates the time when this mapping was archived.
4978
4991
  # Corresponds to the JSON property `archiveTime`
4979
4992
  # @return [String]
4980
4993
  attr_accessor :archive_time
4981
4994
 
4982
- # Output only. Indicates whether this data mapping is archived.
4995
+ # Output only. Indicates whether this mapping is archived.
4983
4996
  # Corresponds to the JSON property `archived`
4984
4997
  # @return [Boolean]
4985
4998
  attr_accessor :archived
4986
4999
  alias_method :archived?, :archived
4987
5000
 
4988
- # Required. A unique identifier for the mapped data.
5001
+ # Required. A unique identifier for the mapped resource.
4989
5002
  # Corresponds to the JSON property `dataId`
4990
5003
  # @return [String]
4991
5004
  attr_accessor :data_id
@@ -4997,11 +5010,10 @@ module Google
4997
5010
  # @return [String]
4998
5011
  attr_accessor :name
4999
5012
 
5000
- # Attributes of end user data. Each attribute can have exactly one value
5001
- # specified. Only explicitly set attributes are displayed here. Attribute
5002
- # definitions with defaults set implicitly apply to these User data mappings.
5003
- # Attributes listed here must be single valued, that is, exactly one value is
5004
- # specified for the field "values" in each Attribute.
5013
+ # Attributes of the resource. Only explicitly set attributes are displayed here.
5014
+ # Attribute definitions with defaults set implicitly apply to these User data
5015
+ # mappings. Attributes listed here must be single valued, that is, exactly one
5016
+ # value is specified for the field "values" in each Attribute.
5005
5017
  # Corresponds to the JSON property `resourceAttributes`
5006
5018
  # @return [Array<Google::Apis::HealthcareV1beta1::Attribute>]
5007
5019
  attr_accessor :resource_attributes