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 +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/healthcare_v1beta1/classes.rb +134 -122
- data/lib/google/apis/healthcare_v1beta1/gem_version.rb +2 -2
- data/lib/google/apis/healthcare_v1beta1/service.rb +196 -179
- metadata +5 -5
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module HealthcareV1beta1
|
18
18
|
# Version of the google-apis-healthcare_v1beta1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.4.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.1.2"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210217"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -1072,11 +1072,11 @@ module Google
|
|
1072
1072
|
execute_or_queue_command(command, &block)
|
1073
1073
|
end
|
1074
1074
|
|
1075
|
-
# Checks if a particular data_id of a User data mapping in the
|
1076
|
-
# store is consented for
|
1075
|
+
# Checks if a particular data_id of a User data mapping in the specified consent
|
1076
|
+
# store is consented for the specified use.
|
1077
1077
|
# @param [String] consent_store
|
1078
|
-
# Name of the
|
1079
|
-
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
1078
|
+
# Required. Name of the consent store where the requested data_id is stored, of
|
1079
|
+
# the form `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
1080
1080
|
# consentStores/`consent_store_id``.
|
1081
1081
|
# @param [Google::Apis::HealthcareV1beta1::CheckDataAccessRequest] check_data_access_request_object
|
1082
1082
|
# @param [String] fields
|
@@ -1108,15 +1108,15 @@ module Google
|
|
1108
1108
|
execute_or_queue_command(command, &block)
|
1109
1109
|
end
|
1110
1110
|
|
1111
|
-
# Creates a new
|
1111
|
+
# Creates a new consent store in the parent dataset. Attempting to create a
|
1112
1112
|
# consent store with the same ID as an existing store fails with an
|
1113
1113
|
# ALREADY_EXISTS error.
|
1114
1114
|
# @param [String] parent
|
1115
|
-
# Required. The name of the dataset this
|
1115
|
+
# Required. The name of the dataset this consent store belongs to.
|
1116
1116
|
# @param [Google::Apis::HealthcareV1beta1::ConsentStore] consent_store_object
|
1117
1117
|
# @param [String] consent_store_id
|
1118
|
-
# The ID of the consent store to create. The string must match the
|
1119
|
-
# regex: `[\p`L`\p`N`_\-\.]`1,256``.
|
1118
|
+
# Required. The ID of the consent store to create. The string must match the
|
1119
|
+
# following regex: `[\p`L`\p`N`_\-\.]`1,256``. Cannot be changed after creation.
|
1120
1120
|
# @param [String] fields
|
1121
1121
|
# Selector specifying which fields to include in a partial response.
|
1122
1122
|
# @param [String] quota_user
|
@@ -1147,10 +1147,9 @@ module Google
|
|
1147
1147
|
execute_or_queue_command(command, &block)
|
1148
1148
|
end
|
1149
1149
|
|
1150
|
-
# Deletes the specified
|
1151
|
-
# specified consent store.
|
1150
|
+
# Deletes the specified consent store and removes all the consent store's data.
|
1152
1151
|
# @param [String] name
|
1153
|
-
# Required. The resource name of the
|
1152
|
+
# Required. The resource name of the consent store to delete.
|
1154
1153
|
# @param [String] fields
|
1155
1154
|
# Selector specifying which fields to include in a partial response.
|
1156
1155
|
# @param [String] quota_user
|
@@ -1178,12 +1177,12 @@ module Google
|
|
1178
1177
|
execute_or_queue_command(command, &block)
|
1179
1178
|
end
|
1180
1179
|
|
1181
|
-
# Evaluates the
|
1182
|
-
#
|
1183
|
-
#
|
1184
|
-
#
|
1180
|
+
# Evaluates the user's Consents for all matching User data mappings. Note: User
|
1181
|
+
# data mappings are indexed asynchronously, which can cause a slight delay
|
1182
|
+
# between the time mappings are created or updated and when they are included in
|
1183
|
+
# EvaluateUserConsents results.
|
1185
1184
|
# @param [String] consent_store
|
1186
|
-
# Name of the
|
1185
|
+
# Required. Name of the consent store to retrieve User data mappings from.
|
1187
1186
|
# @param [Google::Apis::HealthcareV1beta1::EvaluateUserConsentsRequest] evaluate_user_consents_request_object
|
1188
1187
|
# @param [String] fields
|
1189
1188
|
# Selector specifying which fields to include in a partial response.
|
@@ -1214,9 +1213,9 @@ module Google
|
|
1214
1213
|
execute_or_queue_command(command, &block)
|
1215
1214
|
end
|
1216
1215
|
|
1217
|
-
# Gets the specified
|
1216
|
+
# Gets the specified consent store.
|
1218
1217
|
# @param [String] name
|
1219
|
-
# Required. The resource name of the
|
1218
|
+
# Required. The resource name of the consent store to get.
|
1220
1219
|
# @param [String] fields
|
1221
1220
|
# Selector specifying which fields to include in a partial response.
|
1222
1221
|
# @param [String] quota_user
|
@@ -1285,37 +1284,38 @@ module Google
|
|
1285
1284
|
execute_or_queue_command(command, &block)
|
1286
1285
|
end
|
1287
1286
|
|
1288
|
-
# Lists the
|
1287
|
+
# Lists the consent stores in the specified dataset.
|
1289
1288
|
# @param [String] parent
|
1290
1289
|
# Required. Name of the dataset.
|
1291
1290
|
# @param [String] filter
|
1292
|
-
# Restricts the stores returned to those matching a filter. The
|
1293
|
-
# is available: * A string field value can be written as text
|
1294
|
-
# marks, for example `"query text"`. The only valid relational
|
1295
|
-
# text fields is equality (`=`), where text is searched within the
|
1296
|
-
# than having the field be equal to the text. For example, `"
|
1297
|
-
# returns messages with `great` in the comment field. * A
|
1298
|
-
# be written as an integer, a decimal, or an exponential.
|
1299
|
-
# operators for number fields are the equality operator (`=`
|
1291
|
+
# Optional. Restricts the stores returned to those matching a filter. The
|
1292
|
+
# following syntax is available: * A string field value can be written as text
|
1293
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
1294
|
+
# operation for text fields is equality (`=`), where text is searched within the
|
1295
|
+
# field, rather than having the field be equal to the text. For example, `"
|
1296
|
+
# Comment = great"` returns messages with `great` in the comment field. * A
|
1297
|
+
# number field value can be written as an integer, a decimal, or an exponential.
|
1298
|
+
# The valid relational operators for number fields are the equality operator (`=`
|
1299
|
+
# ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
|
1300
|
+
# Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
|
1301
|
+
# operator to an expression to negate it. * A date field value must be written
|
1302
|
+
# in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
|
1303
|
+
# Leading zeros are required for one-digit months and days. The valid relational
|
1304
|
+
# operators for date fields are the equality operator (`=`) , along with the
|
1300
1305
|
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
|
1301
1306
|
# inequality (`!=`) operator. You can prepend the `NOT` operator to an
|
1302
|
-
# expression to negate it. *
|
1303
|
-
#
|
1304
|
-
#
|
1305
|
-
#
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
# Multiple field query expressions can be combined in one query by adding `AND`
|
1309
|
-
# or `OR` operators between the expressions. If a boolean operator appears
|
1310
|
-
# within a quoted string, it is not treated as special, it's just another part
|
1311
|
-
# of the character string to be matched. You can prepend the `NOT` operator to
|
1312
|
-
# an expression to negate it. Only filtering on labels is supported. For example,
|
1313
|
-
# `labels.key=value`.
|
1307
|
+
# expression to negate it. * Multiple field query expressions can be combined in
|
1308
|
+
# one query by adding `AND` or `OR` operators between the expressions. If a
|
1309
|
+
# boolean operator appears within a quoted string, it is not treated as special,
|
1310
|
+
# it's just another part of the character string to be matched. You can prepend
|
1311
|
+
# the `NOT` operator to an expression to negate it. Only filtering on labels is
|
1312
|
+
# supported. For example, `filter=labels.key=value`.
|
1314
1313
|
# @param [Fixnum] page_size
|
1315
|
-
# Limit on the number of
|
1316
|
-
# specified, 100 is used. May not be larger than 1000.
|
1314
|
+
# Optional. Limit on the number of consent stores to return in a single response.
|
1315
|
+
# If not specified, 100 is used. May not be larger than 1000.
|
1317
1316
|
# @param [String] page_token
|
1318
|
-
# Token to retrieve the next page of results or empty to get the
|
1317
|
+
# Optional. Token to retrieve the next page of results, or empty to get the
|
1318
|
+
# first page.
|
1319
1319
|
# @param [String] fields
|
1320
1320
|
# Selector specifying which fields to include in a partial response.
|
1321
1321
|
# @param [String] quota_user
|
@@ -1346,16 +1346,17 @@ module Google
|
|
1346
1346
|
execute_or_queue_command(command, &block)
|
1347
1347
|
end
|
1348
1348
|
|
1349
|
-
# Updates the specified
|
1349
|
+
# Updates the specified consent store.
|
1350
1350
|
# @param [String] name
|
1351
|
-
# Resource name of the
|
1351
|
+
# Resource name of the consent store, of the form `projects/`project_id`/
|
1352
1352
|
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id``
|
1353
|
-
# .
|
1353
|
+
# . Cannot be changed after creation.
|
1354
1354
|
# @param [Google::Apis::HealthcareV1beta1::ConsentStore] consent_store_object
|
1355
1355
|
# @param [String] update_mask
|
1356
|
-
# The update mask that applies to the resource. For the `FieldMask`
|
1357
|
-
# see https://developers.google.com/protocol-buffers/docs/reference/
|
1358
|
-
# protobuf#fieldmask.
|
1356
|
+
# Required. The update mask that applies to the resource. For the `FieldMask`
|
1357
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
1358
|
+
# google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `
|
1359
|
+
# enable_consent_create_on_update` fields are allowed to be updated.
|
1359
1360
|
# @param [String] fields
|
1360
1361
|
# Selector specifying which fields to include in a partial response.
|
1361
1362
|
# @param [String] quota_user
|
@@ -1386,27 +1387,28 @@ module Google
|
|
1386
1387
|
execute_or_queue_command(command, &block)
|
1387
1388
|
end
|
1388
1389
|
|
1389
|
-
# Queries all data_ids that are consented for a
|
1390
|
-
# store and writes them to a specified destination. The returned
|
1391
|
-
# includes a progress counter for the number of User data mappings
|
1392
|
-
# Errors are logged to Cloud Logging (see [Viewing logs] (
|
1393
|
-
# tos/logging)). For example, the following
|
1394
|
-
# evaluate consent policy` error that
|
1395
|
-
# to consent store `projects/`
|
1396
|
-
# dataset_id`/consentStores/`
|
1397
|
-
# type.googleapis.com/google.
|
1398
|
-
# QueryAccessibleDataLogEntry" error: ` code: 9 message:
|
1399
|
-
# consent policy" ` resourceName: "projects/`project_id`/
|
1400
|
-
# datasets/`dataset_id`/consentStores/`consent_store_id`/
|
1401
|
-
# logName: "projects/`project_id`/logs/healthcare.
|
1402
|
-
# 2Fquery_accessible_data" operation: ` id: "projects/`project_id
|
1403
|
-
# location_id`/datasets/`dataset_id`/operations/`operation_id`"
|
1404
|
-
# healthcare.googleapis.com/QueryAccessibleData" ` receiveTimestamp: "
|
1405
|
-
# resource: ` labels: ` consent_store_id: "`consent_store_id`"
|
1406
|
-
# dataset_id`" location: "`location_id`" project_id: "`project_id`"
|
1407
|
-
# healthcare_consent_store" ` severity: "ERROR" timestamp: "TIMESTAMP"
|
1390
|
+
# Queries all data_ids that are consented for a specified use in the given
|
1391
|
+
# consent store and writes them to a specified destination. The returned
|
1392
|
+
# Operation includes a progress counter for the number of User data mappings
|
1393
|
+
# processed. Errors are logged to Cloud Logging (see [Viewing logs] (cloud.
|
1394
|
+
# google.com/healthcare/docs/how-tos/logging)). For example, the following
|
1395
|
+
# sample log entry shows a `failed to evaluate consent policy` error that
|
1396
|
+
# occurred during a QueryAccessibleData call to consent store `projects/`
|
1397
|
+
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1398
|
+
# consent_store_id``. ```json jsonPayload: ` @type: "type.googleapis.com/google.
|
1399
|
+
# cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: ` code: 9 message:
|
1400
|
+
# "failed to evaluate consent policy" ` resourceName: "projects/`project_id`/
|
1401
|
+
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
1402
|
+
# consents/`consent_id`" ` logName: "projects/`project_id`/logs/healthcare.
|
1403
|
+
# googleapis.com%2Fquery_accessible_data" operation: ` id: "projects/`project_id`
|
1404
|
+
# /locations/`location_id`/datasets/`dataset_id`/operations/`operation_id`"
|
1405
|
+
# producer: "healthcare.googleapis.com/QueryAccessibleData" ` receiveTimestamp: "
|
1406
|
+
# TIMESTAMP" resource: ` labels: ` consent_store_id: "`consent_store_id`"
|
1407
|
+
# dataset_id: "`dataset_id`" location: "`location_id`" project_id: "`project_id`"
|
1408
|
+
# ` type: "healthcare_consent_store" ` severity: "ERROR" timestamp: "TIMESTAMP"
|
1409
|
+
# ```
|
1408
1410
|
# @param [String] consent_store
|
1409
|
-
# Name of the
|
1411
|
+
# Required. Name of the consent store to retrieve User data mappings from.
|
1410
1412
|
# @param [Google::Apis::HealthcareV1beta1::QueryAccessibleDataRequest] query_accessible_data_request_object
|
1411
1413
|
# @param [String] fields
|
1412
1414
|
# Selector specifying which fields to include in a partial response.
|
@@ -1511,7 +1513,7 @@ module Google
|
|
1511
1513
|
execute_or_queue_command(command, &block)
|
1512
1514
|
end
|
1513
1515
|
|
1514
|
-
# Creates a new Attribute definition in the parent
|
1516
|
+
# Creates a new Attribute definition in the parent consent store.
|
1515
1517
|
# @param [String] parent
|
1516
1518
|
# Required. The name of the consent store that this Attribute definition belongs
|
1517
1519
|
# to.
|
@@ -1551,10 +1553,12 @@ module Google
|
|
1551
1553
|
execute_or_queue_command(command, &block)
|
1552
1554
|
end
|
1553
1555
|
|
1554
|
-
# Deletes the specified Attribute definition. Fails if
|
1555
|
-
# User data mapping, or the latest revision of any Consent.
|
1556
|
+
# Deletes the specified Attribute definition. Fails if the Attribute definition
|
1557
|
+
# is referenced by any User data mapping, or the latest revision of any Consent.
|
1556
1558
|
# @param [String] name
|
1557
|
-
# Required. The resource name of the Attribute definition to delete.
|
1559
|
+
# Required. The resource name of the Attribute definition to delete. To preserve
|
1560
|
+
# referential integrity, Attribute definitions referenced by a User data mapping
|
1561
|
+
# or the latest revision of a Consent cannot be deleted.
|
1558
1562
|
# @param [String] fields
|
1559
1563
|
# Selector specifying which fields to include in a partial response.
|
1560
1564
|
# @param [String] quota_user
|
@@ -1612,13 +1616,13 @@ module Google
|
|
1612
1616
|
execute_or_queue_command(command, &block)
|
1613
1617
|
end
|
1614
1618
|
|
1615
|
-
# Lists the Attribute definitions in the
|
1619
|
+
# Lists the Attribute definitions in the specified consent store.
|
1616
1620
|
# @param [String] parent
|
1617
|
-
# Required. Name of the
|
1621
|
+
# Required. Name of the consent store to retrieve Attribute definitions from.
|
1618
1622
|
# @param [String] filter
|
1619
|
-
# Restricts the attributes returned to those matching a filter. The
|
1620
|
-
# syntax is available: * A string field value can be written as text
|
1621
|
-
# quotation marks, for example `"query text"`. The only valid relational
|
1623
|
+
# Optional. Restricts the attributes returned to those matching a filter. The
|
1624
|
+
# following syntax is available: * A string field value can be written as text
|
1625
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
1622
1626
|
# operation for text fields is equality (`=`), where text is searched within the
|
1623
1627
|
# field, rather than having the field be equal to the text. For example, `"
|
1624
1628
|
# Comment = great"` returns messages with `great` in the comment field. * A
|
@@ -1637,12 +1641,13 @@ module Google
|
|
1637
1641
|
# boolean operator appears within a quoted string, it is not treated as special,
|
1638
1642
|
# it's just another part of the character string to be matched. You can prepend
|
1639
1643
|
# the `NOT` operator to an expression to negate it. The only field available for
|
1640
|
-
# filtering is `category`.
|
1644
|
+
# filtering is `category`. For example, `filter=category=\"REQUEST\"`.
|
1641
1645
|
# @param [Fixnum] page_size
|
1642
|
-
# Limit on the number of
|
1643
|
-
# If not specified, 100 is used. May not be larger than 1000.
|
1646
|
+
# Optional. Limit on the number of Attribute definitions to return in a single
|
1647
|
+
# response. If not specified, 100 is used. May not be larger than 1000.
|
1644
1648
|
# @param [String] page_token
|
1645
|
-
# Token to retrieve the next page of results or empty to get the first
|
1649
|
+
# Optional. Token to retrieve the next page of results or empty to get the first
|
1650
|
+
# page.
|
1646
1651
|
# @param [String] fields
|
1647
1652
|
# Selector specifying which fields to include in a partial response.
|
1648
1653
|
# @param [String] quota_user
|
@@ -1675,17 +1680,18 @@ module Google
|
|
1675
1680
|
|
1676
1681
|
# Updates the specified Attribute definition.
|
1677
1682
|
# @param [String] name
|
1678
|
-
# Resource name of the
|
1683
|
+
# Resource name of the Attribute definition, of the form `projects/`project_id`/
|
1679
1684
|
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
1680
|
-
# attributeDefinitions/`attribute_definition_id``.
|
1685
|
+
# attributeDefinitions/`attribute_definition_id``. Cannot be changed after
|
1686
|
+
# creation.
|
1681
1687
|
# @param [Google::Apis::HealthcareV1beta1::AttributeDefinition] attribute_definition_object
|
1682
1688
|
# @param [String] update_mask
|
1683
|
-
# The update mask that applies to the resource. For the `FieldMask`
|
1684
|
-
# see https://developers.google.com/protocol-buffers/docs/reference/
|
1685
|
-
# protobuf#fieldmask.
|
1686
|
-
# consent_default_values
|
1687
|
-
#
|
1688
|
-
#
|
1689
|
+
# Required. The update mask that applies to the resource. For the `FieldMask`
|
1690
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
1691
|
+
# google.protobuf#fieldmask. Only the `description`, `allowed_values`, `
|
1692
|
+
# consent_default_values` and `data_mapping_default_value` fields can be updated.
|
1693
|
+
# The updated `allowed_values` must contain all values from the previous `
|
1694
|
+
# allowed_values`.
|
1689
1695
|
# @param [String] fields
|
1690
1696
|
# Selector specifying which fields to include in a partial response.
|
1691
1697
|
# @param [String] quota_user
|
@@ -1716,9 +1722,9 @@ module Google
|
|
1716
1722
|
execute_or_queue_command(command, &block)
|
1717
1723
|
end
|
1718
1724
|
|
1719
|
-
# Creates a new Consent artifact in the parent
|
1725
|
+
# Creates a new Consent artifact in the parent consent store.
|
1720
1726
|
# @param [String] parent
|
1721
|
-
# Required. The name of the
|
1727
|
+
# Required. The name of the consent store this Consent artifact belongs to.
|
1722
1728
|
# @param [Google::Apis::HealthcareV1beta1::ConsentArtifact] consent_artifact_object
|
1723
1729
|
# @param [String] fields
|
1724
1730
|
# Selector specifying which fields to include in a partial response.
|
@@ -1749,10 +1755,12 @@ module Google
|
|
1749
1755
|
execute_or_queue_command(command, &block)
|
1750
1756
|
end
|
1751
1757
|
|
1752
|
-
# Deletes the specified Consent artifact. Fails if
|
1753
|
-
# latest revision of any Consent.
|
1758
|
+
# Deletes the specified Consent artifact. Fails if the artifact is referenced by
|
1759
|
+
# the latest revision of any Consent.
|
1754
1760
|
# @param [String] name
|
1755
|
-
# Required. The resource name of the
|
1761
|
+
# Required. The resource name of the Consent artifact to delete. To preserve
|
1762
|
+
# referential integrity, Consent artifacts referenced by the latest revision of
|
1763
|
+
# a Consent cannot be deleted.
|
1756
1764
|
# @param [String] fields
|
1757
1765
|
# Selector specifying which fields to include in a partial response.
|
1758
1766
|
# @param [String] quota_user
|
@@ -1782,7 +1790,7 @@ module Google
|
|
1782
1790
|
|
1783
1791
|
# Gets the specified Consent artifact.
|
1784
1792
|
# @param [String] name
|
1785
|
-
# Required. The resource name of the
|
1793
|
+
# Required. The resource name of the Consent artifact to retrieve.
|
1786
1794
|
# @param [String] fields
|
1787
1795
|
# Selector specifying which fields to include in a partial response.
|
1788
1796
|
# @param [String] quota_user
|
@@ -1810,13 +1818,13 @@ module Google
|
|
1810
1818
|
execute_or_queue_command(command, &block)
|
1811
1819
|
end
|
1812
1820
|
|
1813
|
-
# Lists the Consent artifacts in the
|
1821
|
+
# Lists the Consent artifacts in the specified consent store.
|
1814
1822
|
# @param [String] parent
|
1815
|
-
# Required. Name of the
|
1823
|
+
# Required. Name of the consent store to retrieve consent artifacts from.
|
1816
1824
|
# @param [String] filter
|
1817
|
-
# Restricts the artifacts returned to those matching a filter. The
|
1818
|
-
# syntax is available: * A string field value can be written as text
|
1819
|
-
# quotation marks, for example `"query text"`. The only valid relational
|
1825
|
+
# Optional. Restricts the artifacts returned to those matching a filter. The
|
1826
|
+
# following syntax is available: * A string field value can be written as text
|
1827
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
1820
1828
|
# operation for text fields is equality (`=`), where text is searched within the
|
1821
1829
|
# field, rather than having the field be equal to the text. For example, `"
|
1822
1830
|
# Comment = great"` returns messages with `great` in the comment field. * A
|
@@ -1835,13 +1843,15 @@ module Google
|
|
1835
1843
|
# boolean operator appears within a quoted string, it is not treated as special,
|
1836
1844
|
# it's just another part of the character string to be matched. You can prepend
|
1837
1845
|
# the `NOT` operator to an expression to negate it. The fields available for
|
1838
|
-
# filtering are: - user_id
|
1839
|
-
#
|
1846
|
+
# filtering are: - user_id. For example, `filter=user_id=\"user123\"`. -
|
1847
|
+
# consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=
|
1848
|
+
# \"value\"` or `filter=HasMetadata(\"testkey\")`.
|
1840
1849
|
# @param [Fixnum] page_size
|
1841
|
-
# Limit on the number of consent artifacts to return in a single
|
1842
|
-
# not specified, 100 is used. May not be larger than 1000.
|
1850
|
+
# Optional. Limit on the number of consent artifacts to return in a single
|
1851
|
+
# response. If not specified, 100 is used. May not be larger than 1000.
|
1843
1852
|
# @param [String] page_token
|
1844
|
-
# The next_page_token value returned from the previous List request,
|
1853
|
+
# Optional. The next_page_token value returned from the previous List request,
|
1854
|
+
# if any.
|
1845
1855
|
# @param [String] fields
|
1846
1856
|
# Selector specifying which fields to include in a partial response.
|
1847
1857
|
# @param [String] quota_user
|
@@ -1873,12 +1883,12 @@ module Google
|
|
1873
1883
|
end
|
1874
1884
|
|
1875
1885
|
# Activates the latest revision of the specified Consent by committing a new
|
1876
|
-
# revision with `state` updated to `ACTIVE`. If the latest revision of the
|
1877
|
-
#
|
1878
|
-
# FAILED_PRECONDITION error occurs if the latest revision of the
|
1879
|
-
# is in the `REJECTED` or `REVOKED` state.
|
1886
|
+
# revision with `state` updated to `ACTIVE`. If the latest revision of the
|
1887
|
+
# specified Consent is in the `ACTIVE` state, no new revision is committed. A
|
1888
|
+
# FAILED_PRECONDITION error occurs if the latest revision of the specified
|
1889
|
+
# consent is in the `REJECTED` or `REVOKED` state.
|
1880
1890
|
# @param [String] name
|
1881
|
-
# Required. The resource name of the
|
1891
|
+
# Required. The resource name of the Consent to activate, of the form `projects/`
|
1882
1892
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1883
1893
|
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
1884
1894
|
# revision_id` is specified in the name.
|
@@ -1912,7 +1922,7 @@ module Google
|
|
1912
1922
|
execute_or_queue_command(command, &block)
|
1913
1923
|
end
|
1914
1924
|
|
1915
|
-
# Creates a new Consent in the parent
|
1925
|
+
# Creates a new Consent in the parent consent store.
|
1916
1926
|
# @param [String] parent
|
1917
1927
|
# Required. Name of the consent store.
|
1918
1928
|
# @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
|
@@ -1947,10 +1957,10 @@ module Google
|
|
1947
1957
|
|
1948
1958
|
# Deletes the Consent and its revisions. To keep a record of the Consent but
|
1949
1959
|
# mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [
|
1950
|
-
# DeleteConsentRevision]. This operation does not delete the related
|
1960
|
+
# DeleteConsentRevision]. This operation does not delete the related Consent
|
1951
1961
|
# artifact.
|
1952
1962
|
# @param [String] name
|
1953
|
-
# Required. The resource name of the
|
1963
|
+
# Required. The resource name of the Consent to delete, of the form `projects/`
|
1954
1964
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
1955
1965
|
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
1956
1966
|
# revision_id` is specified in the name.
|
@@ -1984,7 +1994,7 @@ module Google
|
|
1984
1994
|
# Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs
|
1985
1995
|
# if the specified revision is the latest revision.
|
1986
1996
|
# @param [String] name
|
1987
|
-
# Required. The resource name of the
|
1997
|
+
# Required. The resource name of the Consent revision to delete, of the form `
|
1988
1998
|
# projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
|
1989
1999
|
# consentStores/`consent_store_id`/consents/`consent_id`@`revision_id``. An
|
1990
2000
|
# INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.
|
@@ -2018,10 +2028,10 @@ module Google
|
|
2018
2028
|
# Gets the specified revision of a Consent, or the latest revision if `
|
2019
2029
|
# revision_id` is not specified in the resource name.
|
2020
2030
|
# @param [String] name
|
2021
|
-
# Required. The resource name of the
|
2031
|
+
# Required. The resource name of the Consent to retrieve, of the form `projects/`
|
2022
2032
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
2023
2033
|
# consent_store_id`/consents/`consent_id``. In order to retrieve a previous
|
2024
|
-
# revision of the
|
2034
|
+
# revision of the Consent, also provide the revision ID: `projects/`project_id`/
|
2025
2035
|
# locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
|
2026
2036
|
# consents/`consent_id`@`revision_id``
|
2027
2037
|
# @param [String] fields
|
@@ -2051,14 +2061,14 @@ module Google
|
|
2051
2061
|
execute_or_queue_command(command, &block)
|
2052
2062
|
end
|
2053
2063
|
|
2054
|
-
# Lists the Consent in the given
|
2064
|
+
# Lists the Consent in the given consent store, returning each Consent's latest
|
2055
2065
|
# revision.
|
2056
2066
|
# @param [String] parent
|
2057
|
-
# Required. Name of the
|
2067
|
+
# Required. Name of the consent store to retrieve Consents from.
|
2058
2068
|
# @param [String] filter
|
2059
|
-
# Restricts the consents returned to those matching a filter. The
|
2060
|
-
# syntax is available: * A string field value can be written as text
|
2061
|
-
# quotation marks, for example `"query text"`. The only valid relational
|
2069
|
+
# Optional. Restricts the consents returned to those matching a filter. The
|
2070
|
+
# following syntax is available: * A string field value can be written as text
|
2071
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
2062
2072
|
# operation for text fields is equality (`=`), where text is searched within the
|
2063
2073
|
# field, rather than having the field be equal to the text. For example, `"
|
2064
2074
|
# Comment = great"` returns messages with `great` in the comment field. * A
|
@@ -2077,13 +2087,15 @@ module Google
|
|
2077
2087
|
# boolean operator appears within a quoted string, it is not treated as special,
|
2078
2088
|
# it's just another part of the character string to be matched. You can prepend
|
2079
2089
|
# the `NOT` operator to an expression to negate it. The fields available for
|
2080
|
-
# filtering are: - user_id
|
2081
|
-
# metadata. For example, `
|
2090
|
+
# filtering are: - user_id. For example, `filter='user_id="user123"'`. -
|
2091
|
+
# consent_artifact - state - revision_create_time - metadata. For example, `
|
2092
|
+
# filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
|
2082
2093
|
# @param [Fixnum] page_size
|
2083
|
-
# Limit on the number of
|
2084
|
-
# specified, 100 is used. May not be larger than 1000.
|
2094
|
+
# Optional. Limit on the number of Consents to return in a single response. If
|
2095
|
+
# not specified, 100 is used. May not be larger than 1000.
|
2085
2096
|
# @param [String] page_token
|
2086
|
-
# The next_page_token value returned from the previous List request,
|
2097
|
+
# Optional. The next_page_token value returned from the previous List request,
|
2098
|
+
# if any.
|
2087
2099
|
# @param [String] fields
|
2088
2100
|
# Selector specifying which fields to include in a partial response.
|
2089
2101
|
# @param [String] quota_user
|
@@ -2114,13 +2126,13 @@ module Google
|
|
2114
2126
|
execute_or_queue_command(command, &block)
|
2115
2127
|
end
|
2116
2128
|
|
2117
|
-
# Lists the revisions of the
|
2129
|
+
# Lists the revisions of the specified Consent in reverse chronological order.
|
2118
2130
|
# @param [String] name
|
2119
|
-
# Required. The resource name of the
|
2131
|
+
# Required. The resource name of the Consent to retrieve revisions for.
|
2120
2132
|
# @param [String] filter
|
2121
|
-
# Restricts the revisions returned to those matching a filter. The
|
2122
|
-
# syntax is available: * A string field value can be written as text
|
2123
|
-
# quotation marks, for example `"query text"`. The only valid relational
|
2133
|
+
# Optional. Restricts the revisions returned to those matching a filter. The
|
2134
|
+
# following syntax is available: * A string field value can be written as text
|
2135
|
+
# inside quotation marks, for example `"query text"`. The only valid relational
|
2124
2136
|
# operation for text fields is equality (`=`), where text is searched within the
|
2125
2137
|
# field, rather than having the field be equal to the text. For example, `"
|
2126
2138
|
# Comment = great"` returns messages with `great` in the comment field. * A
|
@@ -2139,13 +2151,15 @@ module Google
|
|
2139
2151
|
# boolean operator appears within a quoted string, it is not treated as special,
|
2140
2152
|
# it's just another part of the character string to be matched. You can prepend
|
2141
2153
|
# the `NOT` operator to an expression to negate it. Fields/functions available
|
2142
|
-
# for filtering are: - user_id
|
2154
|
+
# for filtering are: - user_id. For example, `filter='user_id="user123"'`. -
|
2155
|
+
# consent_artifact - state - revision_create_time - metadata. For example, `
|
2156
|
+
# filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
|
2143
2157
|
# @param [Fixnum] page_size
|
2144
|
-
# Limit on the number of revisions to return in a single response. If
|
2145
|
-
# specified, 100 is used. May not be larger than 1000.
|
2158
|
+
# Optional. Limit on the number of revisions to return in a single response. If
|
2159
|
+
# not specified, 100 is used. May not be larger than 1000.
|
2146
2160
|
# @param [String] page_token
|
2147
|
-
# Token to retrieve the next page of results or empty if there are no
|
2148
|
-
# results in the list.
|
2161
|
+
# Optional. Token to retrieve the next page of results or empty if there are no
|
2162
|
+
# more results in the list.
|
2149
2163
|
# @param [String] fields
|
2150
2164
|
# Selector specifying which fields to include in a partial response.
|
2151
2165
|
# @param [String] quota_user
|
@@ -2178,17 +2192,17 @@ module Google
|
|
2178
2192
|
|
2179
2193
|
# Updates the latest revision of the specified Consent by committing a new
|
2180
2194
|
# revision with the changes. A FAILED_PRECONDITION error occurs if the latest
|
2181
|
-
# revision of the
|
2195
|
+
# revision of the specified Consent is in the `REJECTED` or `REVOKED` state.
|
2182
2196
|
# @param [String] name
|
2183
2197
|
# Resource name of the Consent, of the form `projects/`project_id`/locations/`
|
2184
2198
|
# location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
|
2185
|
-
# consent_id``.
|
2199
|
+
# consent_id``. Cannot be changed after creation.
|
2186
2200
|
# @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
|
2187
2201
|
# @param [String] update_mask
|
2188
|
-
# The update mask to apply to the resource. For the `FieldMask`
|
2189
|
-
# https://developers.google.com/protocol-buffers/docs/reference/
|
2190
|
-
# fieldmask.
|
2191
|
-
# updated.
|
2202
|
+
# Required. The update mask to apply to the resource. For the `FieldMask`
|
2203
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
2204
|
+
# google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`,
|
2205
|
+
# and `metadata` fields can be updated.
|
2192
2206
|
# @param [String] fields
|
2193
2207
|
# Selector specifying which fields to include in a partial response.
|
2194
2208
|
# @param [String] quota_user
|
@@ -2221,11 +2235,11 @@ module Google
|
|
2221
2235
|
|
2222
2236
|
# Rejects the latest revision of the specified Consent by committing a new
|
2223
2237
|
# revision with `state` updated to `REJECTED`. If the latest revision of the
|
2224
|
-
#
|
2225
|
-
# FAILED_PRECONDITION error occurs if the latest revision of the
|
2226
|
-
# is in the `ACTIVE` or `REVOKED` state.
|
2238
|
+
# specified Consent is in the `REJECTED` state, no new revision is committed. A
|
2239
|
+
# FAILED_PRECONDITION error occurs if the latest revision of the specified
|
2240
|
+
# Consent is in the `ACTIVE` or `REVOKED` state.
|
2227
2241
|
# @param [String] name
|
2228
|
-
# Required. The resource name of the
|
2242
|
+
# Required. The resource name of the Consent to reject, of the form `projects/`
|
2229
2243
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
2230
2244
|
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
2231
2245
|
# revision_id` is specified in the name.
|
@@ -2261,11 +2275,11 @@ module Google
|
|
2261
2275
|
|
2262
2276
|
# Revokes the latest revision of the specified Consent by committing a new
|
2263
2277
|
# revision with `state` updated to `REVOKED`. If the latest revision of the
|
2264
|
-
#
|
2278
|
+
# specified Consent is in the `REVOKED` state, no new revision is committed. A
|
2265
2279
|
# FAILED_PRECONDITION error occurs if the latest revision of the given consent
|
2266
2280
|
# is in `DRAFT` or `REJECTED` state.
|
2267
2281
|
# @param [String] name
|
2268
|
-
# Required. The resource name of the
|
2282
|
+
# Required. The resource name of the Consent to revoke, of the form `projects/`
|
2269
2283
|
# project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
|
2270
2284
|
# consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
|
2271
2285
|
# revision_id` is specified in the name.
|
@@ -2301,7 +2315,7 @@ module Google
|
|
2301
2315
|
|
2302
2316
|
# Archives the specified User data mapping.
|
2303
2317
|
# @param [String] name
|
2304
|
-
# The resource name of the
|
2318
|
+
# Required. The resource name of the User data mapping to archive.
|
2305
2319
|
# @param [Google::Apis::HealthcareV1beta1::ArchiveUserDataMappingRequest] archive_user_data_mapping_request_object
|
2306
2320
|
# @param [String] fields
|
2307
2321
|
# Selector specifying which fields to include in a partial response.
|
@@ -2332,7 +2346,7 @@ module Google
|
|
2332
2346
|
execute_or_queue_command(command, &block)
|
2333
2347
|
end
|
2334
2348
|
|
2335
|
-
# Creates a new User data mapping in the parent
|
2349
|
+
# Creates a new User data mapping in the parent consent store.
|
2336
2350
|
# @param [String] parent
|
2337
2351
|
# Required. Name of the consent store.
|
2338
2352
|
# @param [Google::Apis::HealthcareV1beta1::UserDataMapping] user_data_mapping_object
|
@@ -2367,7 +2381,7 @@ module Google
|
|
2367
2381
|
|
2368
2382
|
# Deletes the specified User data mapping.
|
2369
2383
|
# @param [String] name
|
2370
|
-
# Required. The resource name of the
|
2384
|
+
# Required. The resource name of the User data mapping to delete.
|
2371
2385
|
# @param [String] fields
|
2372
2386
|
# Selector specifying which fields to include in a partial response.
|
2373
2387
|
# @param [String] quota_user
|
@@ -2397,7 +2411,7 @@ module Google
|
|
2397
2411
|
|
2398
2412
|
# Gets the specified User data mapping.
|
2399
2413
|
# @param [String] name
|
2400
|
-
# Required. The resource name of the
|
2414
|
+
# Required. The resource name of the User data mapping to retrieve.
|
2401
2415
|
# @param [String] fields
|
2402
2416
|
# Selector specifying which fields to include in a partial response.
|
2403
2417
|
# @param [String] quota_user
|
@@ -2425,37 +2439,39 @@ module Google
|
|
2425
2439
|
execute_or_queue_command(command, &block)
|
2426
2440
|
end
|
2427
2441
|
|
2428
|
-
# Lists the User data mappings in the
|
2442
|
+
# Lists the User data mappings in the specified consent store.
|
2429
2443
|
# @param [String] parent
|
2430
|
-
# Required. Name of the
|
2444
|
+
# Required. Name of the consent store to retrieve User data mappings from.
|
2431
2445
|
# @param [String] filter
|
2432
|
-
# Restricts the user data mappings returned to those matching a filter.
|
2433
|
-
# following syntax is available: * A string field value can be written as
|
2434
|
-
# inside quotation marks, for example `"query text"`. The only valid
|
2435
|
-
# operation for text fields is equality (`=`), where text is searched
|
2436
|
-
# field, rather than having the field be equal to the text. For
|
2437
|
-
# Comment = great"` returns messages with `great` in the comment
|
2438
|
-
# number field value can be written as an integer, a decimal, or an
|
2439
|
-
# The valid relational operators for number fields are the equality
|
2440
|
-
# ), along with the less than/greater than operators (`<`, `<=`,
|
2441
|
-
# Note that there is no inequality (`!=`) operator. You can prepend the
|
2442
|
-
# operator to an expression to negate it. * A date field value must be
|
2443
|
-
# in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time
|
2444
|
-
# Leading zeros are required for one-digit months and days. The valid
|
2445
|
-
# operators for date fields are the equality operator (`=`) , along
|
2446
|
-
# less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
|
2447
|
-
# inequality (`!=`) operator. You can prepend the `NOT` operator to
|
2448
|
-
# expression to negate it. * Multiple field query expressions can be combined
|
2449
|
-
# one query by adding `AND` or `OR` operators between the expressions. If a
|
2446
|
+
# Optional. Restricts the user data mappings returned to those matching a filter.
|
2447
|
+
# The following syntax is available: * A string field value can be written as
|
2448
|
+
# text inside quotation marks, for example `"query text"`. The only valid
|
2449
|
+
# relational operation for text fields is equality (`=`), where text is searched
|
2450
|
+
# within the field, rather than having the field be equal to the text. For
|
2451
|
+
# example, `"Comment = great"` returns messages with `great` in the comment
|
2452
|
+
# field. * A number field value can be written as an integer, a decimal, or an
|
2453
|
+
# exponential. The valid relational operators for number fields are the equality
|
2454
|
+
# operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`
|
2455
|
+
# , `>=`). Note that there is no inequality (`!=`) operator. You can prepend the
|
2456
|
+
# `NOT` operator to an expression to negate it. * A date field value must be
|
2457
|
+
# written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time
|
2458
|
+
# format. Leading zeros are required for one-digit months and days. The valid
|
2459
|
+
# relational operators for date fields are the equality operator (`=`) , along
|
2460
|
+
# with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
|
2461
|
+
# there is no inequality (`!=`) operator. You can prepend the `NOT` operator to
|
2462
|
+
# an expression to negate it. * Multiple field query expressions can be combined
|
2463
|
+
# in one query by adding `AND` or `OR` operators between the expressions. If a
|
2450
2464
|
# boolean operator appears within a quoted string, it is not treated as special,
|
2451
2465
|
# it's just another part of the character string to be matched. You can prepend
|
2452
2466
|
# the `NOT` operator to an expression to negate it. The fields available for
|
2453
|
-
# filtering are: - data_id - user_id
|
2467
|
+
# filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\"`.
|
2468
|
+
# - archived - archive_time
|
2454
2469
|
# @param [Fixnum] page_size
|
2455
|
-
# Limit on the number of
|
2456
|
-
# not specified, 100 is used. May not be larger than 1000.
|
2470
|
+
# Optional. Limit on the number of User data mappings to return in a single
|
2471
|
+
# response. If not specified, 100 is used. May not be larger than 1000.
|
2457
2472
|
# @param [String] page_token
|
2458
|
-
# Token to retrieve the next page of results or empty to get the
|
2473
|
+
# Optional. Token to retrieve the next page of results, or empty to get the
|
2474
|
+
# first page.
|
2459
2475
|
# @param [String] fields
|
2460
2476
|
# Selector specifying which fields to include in a partial response.
|
2461
2477
|
# @param [String] quota_user
|
@@ -2493,9 +2509,10 @@ module Google
|
|
2493
2509
|
# userDataMappings/`user_data_mapping_id``.
|
2494
2510
|
# @param [Google::Apis::HealthcareV1beta1::UserDataMapping] user_data_mapping_object
|
2495
2511
|
# @param [String] update_mask
|
2496
|
-
# The update mask that applies to the resource. For the `FieldMask`
|
2497
|
-
# see https://developers.google.com/protocol-buffers/docs/reference/
|
2498
|
-
# protobuf#fieldmask.
|
2512
|
+
# Required. The update mask that applies to the resource. For the `FieldMask`
|
2513
|
+
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
|
2514
|
+
# google.protobuf#fieldmask. Only the `data_id`, `user_id` and `
|
2515
|
+
# resource_attributes` fields can be updated.
|
2499
2516
|
# @param [String] fields
|
2500
2517
|
# Selector specifying which fields to include in a partial response.
|
2501
2518
|
# @param [String] quota_user
|