google-apis-healthcare_v1beta1 0.3.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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.3.0"
19
+ GEM_VERSION = "0.8.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.2"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210205"
25
+ REVISION = "20210507"
26
26
  end
27
27
  end
28
28
  end
@@ -784,6 +784,12 @@ module Google
784
784
  include Google::Apis::Core::JsonObjectSupport
785
785
  end
786
786
 
787
+ class QueryAccessibleDataResponse
788
+ class Representation < Google::Apis::Core::JsonRepresentation; end
789
+
790
+ include Google::Apis::Core::JsonObjectSupport
791
+ end
792
+
787
793
  class RedactConfig
788
794
  class Representation < Google::Apis::Core::JsonRepresentation; end
789
795
 
@@ -971,6 +977,7 @@ module Google
971
977
  # @private
972
978
  class Representation < Google::Apis::Core::JsonRepresentation
973
979
  property :document_content, as: 'documentContent'
980
+ collection :licensed_vocabularies, as: 'licensedVocabularies'
974
981
  end
975
982
  end
976
983
 
@@ -2135,6 +2142,12 @@ module Google
2135
2142
  end
2136
2143
  end
2137
2144
 
2145
+ class QueryAccessibleDataResponse
2146
+ # @private
2147
+ class Representation < Google::Apis::Core::JsonRepresentation
2148
+ end
2149
+ end
2150
+
2138
2151
  class RedactConfig
2139
2152
  # @private
2140
2153
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -83,11 +83,15 @@ module Google
83
83
  # @param [String] name
84
84
  # The resource that owns the locations collection, if applicable.
85
85
  # @param [String] filter
86
- # The standard list filter.
86
+ # A filter to narrow down results to a preferred subset. The filtering language
87
+ # accepts strings like "displayName=tokyo", and is documented in more detail in [
88
+ # AIP-160](https://google.aip.dev/160).
87
89
  # @param [Fixnum] page_size
88
- # The standard list page size.
90
+ # The maximum number of results to return. If not set, the service selects a
91
+ # default.
89
92
  # @param [String] page_token
90
- # The standard list page token.
93
+ # A page token received from the `next_page_token` field in the response. Send
94
+ # that page token to receive the subsequent page.
91
95
  # @param [String] fields
92
96
  # Selector specifying which fields to include in a partial response.
93
97
  # @param [String] quota_user
@@ -164,8 +168,8 @@ module Google
164
168
  # successful if de-identification fails for some resources. The new de-
165
169
  # identified dataset will not contain these failed resources. The number of
166
170
  # resources processed are tracked in Operation.metadata. Error details are
167
- # logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/
168
- # docs/how-tos/logging).
171
+ # logged to Cloud Logging. For more information, see [Viewing error logs in
172
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
169
173
  # @param [String] source_dataset
170
174
  # Source dataset resource name. For example, `projects/`project_id`/locations/`
171
175
  # location_id`/datasets/`dataset_id``.
@@ -527,7 +531,8 @@ module Google
527
531
  # operation finishes successfully, a detailed response is returned of type
528
532
  # EvaluateAnnotationStoreResponse, contained in the response. The metadata field
529
533
  # type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing
530
- # logs](/healthcare/docs/how-tos/logging)).
534
+ # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
535
+ # logging)).
531
536
  # @param [String] name
532
537
  # The Annotation store to compare against `golden_store`, in the format of `
533
538
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -565,8 +570,8 @@ module Google
565
570
  # Export Annotations from the Annotation store. If the request is successful, a
566
571
  # detailed response is returned of type ExportAnnotationsResponse, contained in
567
572
  # the response field when the operation finishes. The metadata field type is
568
- # OperationMetadata. Errors are logged to Cloud Logging (see [Viewing logs](/
569
- # healthcare/docs/how-tos/logging)).
573
+ # OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs
574
+ # in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
570
575
  # @param [String] name
571
576
  # The name of the Annotation store to export annotations to, in the format of `
572
577
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -676,7 +681,8 @@ module Google
676
681
  # sources. If the request is successful, a detailed response is returned as of
677
682
  # type ImportAnnotationsResponse, contained in the response field when the
678
683
  # operation finishes. The metadata field type is OperationMetadata. Errors are
679
- # logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)).
684
+ # logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://
685
+ # cloud.google.com/healthcare/docs/how-tos/logging)).
680
686
  # @param [String] name
681
687
  # The name of the Annotation store to which the server imports annotations, in
682
688
  # the format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`
@@ -1072,11 +1078,11 @@ module Google
1072
1078
  execute_or_queue_command(command, &block)
1073
1079
  end
1074
1080
 
1075
- # Checks if a particular data_id of a User data mapping in the given Consent
1076
- # store is consented for a given use.
1081
+ # Checks if a particular data_id of a User data mapping in the specified consent
1082
+ # store is consented for the specified use.
1077
1083
  # @param [String] consent_store
1078
- # Name of the Consent store where the requested data_id is stored, of the form `
1079
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1084
+ # Required. Name of the consent store where the requested data_id is stored, of
1085
+ # the form `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1080
1086
  # consentStores/`consent_store_id``.
1081
1087
  # @param [Google::Apis::HealthcareV1beta1::CheckDataAccessRequest] check_data_access_request_object
1082
1088
  # @param [String] fields
@@ -1108,15 +1114,15 @@ module Google
1108
1114
  execute_or_queue_command(command, &block)
1109
1115
  end
1110
1116
 
1111
- # Creates a new Consent store in the parent dataset. Attempting to create a
1117
+ # Creates a new consent store in the parent dataset. Attempting to create a
1112
1118
  # consent store with the same ID as an existing store fails with an
1113
1119
  # ALREADY_EXISTS error.
1114
1120
  # @param [String] parent
1115
- # Required. The name of the dataset this Consent store belongs to.
1121
+ # Required. The name of the dataset this consent store belongs to.
1116
1122
  # @param [Google::Apis::HealthcareV1beta1::ConsentStore] consent_store_object
1117
1123
  # @param [String] consent_store_id
1118
- # The ID of the consent store to create. The string must match the following
1119
- # regex: `[\p`L`\p`N`_\-\.]`1,256``.
1124
+ # Required. The ID of the consent store to create. The string must match the
1125
+ # following regex: `[\p`L`\p`N`_\-\.]`1,256``. Cannot be changed after creation.
1120
1126
  # @param [String] fields
1121
1127
  # Selector specifying which fields to include in a partial response.
1122
1128
  # @param [String] quota_user
@@ -1147,10 +1153,9 @@ module Google
1147
1153
  execute_or_queue_command(command, &block)
1148
1154
  end
1149
1155
 
1150
- # Deletes the specified Consent store and removes all consent data in the
1151
- # specified consent store.
1156
+ # Deletes the specified consent store and removes all the consent store's data.
1152
1157
  # @param [String] name
1153
- # Required. The resource name of the Consent store to delete.
1158
+ # Required. The resource name of the consent store to delete.
1154
1159
  # @param [String] fields
1155
1160
  # Selector specifying which fields to include in a partial response.
1156
1161
  # @param [String] quota_user
@@ -1178,12 +1183,12 @@ module Google
1178
1183
  execute_or_queue_command(command, &block)
1179
1184
  end
1180
1185
 
1181
- # Evaluates the end user's Consents for all matching User data mappings. Note:
1182
- # User data mappings are indexed asynchronously, so there might be a slight
1183
- # delay between the time a mapping is created or updated and when it is included
1184
- # in the results of EvaluateUserConsents.
1186
+ # Evaluates the user's Consents for all matching User data mappings. Note: User
1187
+ # data mappings are indexed asynchronously, which can cause a slight delay
1188
+ # between the time mappings are created or updated and when they are included in
1189
+ # EvaluateUserConsents results.
1185
1190
  # @param [String] consent_store
1186
- # Name of the Consent store to retrieve user data mappings from.
1191
+ # Required. Name of the consent store to retrieve User data mappings from.
1187
1192
  # @param [Google::Apis::HealthcareV1beta1::EvaluateUserConsentsRequest] evaluate_user_consents_request_object
1188
1193
  # @param [String] fields
1189
1194
  # Selector specifying which fields to include in a partial response.
@@ -1214,9 +1219,9 @@ module Google
1214
1219
  execute_or_queue_command(command, &block)
1215
1220
  end
1216
1221
 
1217
- # Gets the specified Consent store.
1222
+ # Gets the specified consent store.
1218
1223
  # @param [String] name
1219
- # Required. The resource name of the Consent store to get.
1224
+ # Required. The resource name of the consent store to get.
1220
1225
  # @param [String] fields
1221
1226
  # Selector specifying which fields to include in a partial response.
1222
1227
  # @param [String] quota_user
@@ -1285,37 +1290,38 @@ module Google
1285
1290
  execute_or_queue_command(command, &block)
1286
1291
  end
1287
1292
 
1288
- # Lists the Consent stores in the given dataset.
1293
+ # Lists the consent stores in the specified dataset.
1289
1294
  # @param [String] parent
1290
1295
  # Required. Name of the dataset.
1291
1296
  # @param [String] filter
1292
- # Restricts the stores returned to those matching a filter. The following syntax
1293
- # is available: * A string field value can be written as text inside quotation
1294
- # marks, for example `"query text"`. The only valid relational operation for
1295
- # text fields is equality (`=`), where text is searched within the field, rather
1296
- # than having the field be equal to the text. For example, `"Comment = great"`
1297
- # returns messages with `great` in the comment field. * A number field value can
1298
- # be written as an integer, a decimal, or an exponential. The valid relational
1299
- # operators for number fields are the equality operator (`=`), along with the
1297
+ # Optional. Restricts the stores returned to those matching a filter. The
1298
+ # following syntax is available: * A string field value can be written as text
1299
+ # inside quotation marks, for example `"query text"`. The only valid relational
1300
+ # operation for text fields is equality (`=`), where text is searched within the
1301
+ # field, rather than having the field be equal to the text. For example, `"
1302
+ # Comment = great"` returns messages with `great` in the comment field. * A
1303
+ # number field value can be written as an integer, a decimal, or an exponential.
1304
+ # The valid relational operators for number fields are the equality operator (`=`
1305
+ # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
1306
+ # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
1307
+ # operator to an expression to negate it. * A date field value must be written
1308
+ # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
1309
+ # Leading zeros are required for one-digit months and days. The valid relational
1310
+ # operators for date fields are the equality operator (`=`) , along with the
1300
1311
  # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
1301
1312
  # inequality (`!=`) operator. You can prepend the `NOT` operator to an
1302
- # expression to negate it. * A date field value must be written in `yyyy-mm-dd`
1303
- # form. Fields with date and time use the RFC3339 time format. Leading zeros are
1304
- # required for one-digit months and days. The valid relational operators for
1305
- # date fields are the equality operator (`=`) , along with the less than/greater
1306
- # than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`)
1307
- # operator. You can prepend the `NOT` operator to an expression to negate it. *
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`.
1313
+ # expression to negate it. * Multiple field query expressions can be combined in
1314
+ # one query by adding `AND` or `OR` operators between the expressions. If a
1315
+ # boolean operator appears within a quoted string, it is not treated as special,
1316
+ # it's just another part of the character string to be matched. You can prepend
1317
+ # the `NOT` operator to an expression to negate it. Only filtering on labels is
1318
+ # supported. For example, `filter=labels.key=value`.
1314
1319
  # @param [Fixnum] page_size
1315
- # Limit on the number of Consent stores to return in a single response. If not
1316
- # specified, 100 is used. May not be larger than 1000.
1320
+ # Optional. Limit on the number of consent stores to return in a single response.
1321
+ # If not specified, 100 is used. May not be larger than 1000.
1317
1322
  # @param [String] page_token
1318
- # Token to retrieve the next page of results or empty to get the first page.
1323
+ # Optional. Token to retrieve the next page of results, or empty to get the
1324
+ # first page.
1319
1325
  # @param [String] fields
1320
1326
  # Selector specifying which fields to include in a partial response.
1321
1327
  # @param [String] quota_user
@@ -1346,16 +1352,17 @@ module Google
1346
1352
  execute_or_queue_command(command, &block)
1347
1353
  end
1348
1354
 
1349
- # Updates the specified Consent store.
1355
+ # Updates the specified consent store.
1350
1356
  # @param [String] name
1351
- # Resource name of the Consent store, of the form `projects/`project_id`/
1357
+ # Resource name of the consent store, of the form `projects/`project_id`/
1352
1358
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id``
1353
- # .
1359
+ # . Cannot be changed after creation.
1354
1360
  # @param [Google::Apis::HealthcareV1beta1::ConsentStore] consent_store_object
1355
1361
  # @param [String] update_mask
1356
- # The update mask that applies to the resource. For the `FieldMask` definition,
1357
- # see https://developers.google.com/protocol-buffers/docs/reference/google.
1358
- # protobuf#fieldmask. The `labels` field is allowed to be updated.
1362
+ # Required. The update mask that applies to the resource. For the `FieldMask`
1363
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1364
+ # google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `
1365
+ # enable_consent_create_on_update` fields are allowed to be updated.
1359
1366
  # @param [String] fields
1360
1367
  # Selector specifying which fields to include in a partial response.
1361
1368
  # @param [String] quota_user
@@ -1386,27 +1393,28 @@ module Google
1386
1393
  execute_or_queue_command(command, &block)
1387
1394
  end
1388
1395
 
1389
- # Queries all data_ids that are consented for a given use in the given Consent
1390
- # store and writes them to a specified destination. The returned Operation
1391
- # includes a progress counter for the number of User data mappings processed.
1392
- # Errors are logged to Cloud Logging (see [Viewing logs] (/healthcare/docs/how-
1393
- # tos/logging)). For example, the following sample log entry shows a `failed to
1394
- # evaluate consent policy` error that occurred during a QueryAccessibleData call
1395
- # to consent store `projects/`project_id`/locations/`location_id`/datasets/`
1396
- # dataset_id`/consentStores/`consent_store_id``. ```json jsonPayload: ` @type: "
1397
- # type.googleapis.com/google.cloud.healthcare.logging.
1398
- # QueryAccessibleDataLogEntry" error: ` code: 9 message: "failed to evaluate
1399
- # consent policy" ` resourceName: "projects/`project_id`/locations/`location_id`/
1400
- # datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`consent_id`" `
1401
- # logName: "projects/`project_id`/logs/healthcare.googleapis.com%
1402
- # 2Fquery_accessible_data" operation: ` id: "projects/`project_id`/locations/`
1403
- # location_id`/datasets/`dataset_id`/operations/`operation_id`" producer: "
1404
- # healthcare.googleapis.com/QueryAccessibleData" ` receiveTimestamp: "TIMESTAMP"
1405
- # resource: ` labels: ` consent_store_id: "`consent_store_id`" dataset_id: "`
1406
- # dataset_id`" location: "`location_id`" project_id: "`project_id`" ` type: "
1407
- # healthcare_consent_store" ` severity: "ERROR" timestamp: "TIMESTAMP" ```
1396
+ # Queries all data_ids that are consented for a specified use in the given
1397
+ # consent store and writes them to a specified destination. The returned
1398
+ # Operation includes a progress counter for the number of User data mappings
1399
+ # processed. Errors are logged to Cloud Logging (see [Viewing error logs in
1400
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). For
1401
+ # example, the following sample log entry shows a `failed to evaluate consent
1402
+ # policy` error that occurred during a QueryAccessibleData call to consent store
1403
+ # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1404
+ # consentStores/`consent_store_id``. ```json jsonPayload: ` @type: "type.
1405
+ # googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry"
1406
+ # error: ` code: 9 message: "failed to evaluate consent policy" ` resourceName: "
1407
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1408
+ # consentStores/`consent_store_id`/consents/`consent_id`" ` logName: "projects/`
1409
+ # project_id`/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation:
1410
+ # ` id: "projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1411
+ # operations/`operation_id`" producer: "healthcare.googleapis.com/
1412
+ # QueryAccessibleData" ` receiveTimestamp: "TIMESTAMP" resource: ` labels: `
1413
+ # consent_store_id: "`consent_store_id`" dataset_id: "`dataset_id`" location: "`
1414
+ # location_id`" project_id: "`project_id`" ` type: "healthcare_consent_store" `
1415
+ # severity: "ERROR" timestamp: "TIMESTAMP" ```
1408
1416
  # @param [String] consent_store
1409
- # Name of the Consent store to retrieve user data mappings from.
1417
+ # Required. Name of the consent store to retrieve User data mappings from.
1410
1418
  # @param [Google::Apis::HealthcareV1beta1::QueryAccessibleDataRequest] query_accessible_data_request_object
1411
1419
  # @param [String] fields
1412
1420
  # Selector specifying which fields to include in a partial response.
@@ -1511,7 +1519,7 @@ module Google
1511
1519
  execute_or_queue_command(command, &block)
1512
1520
  end
1513
1521
 
1514
- # Creates a new Attribute definition in the parent Consent store.
1522
+ # Creates a new Attribute definition in the parent consent store.
1515
1523
  # @param [String] parent
1516
1524
  # Required. The name of the consent store that this Attribute definition belongs
1517
1525
  # to.
@@ -1551,10 +1559,12 @@ module Google
1551
1559
  execute_or_queue_command(command, &block)
1552
1560
  end
1553
1561
 
1554
- # Deletes the specified Attribute definition. Fails if it is referenced by any
1555
- # User data mapping, or the latest revision of any Consent.
1562
+ # Deletes the specified Attribute definition. Fails if the Attribute definition
1563
+ # is referenced by any User data mapping, or the latest revision of any Consent.
1556
1564
  # @param [String] name
1557
- # Required. The resource name of the Attribute definition to delete.
1565
+ # Required. The resource name of the Attribute definition to delete. To preserve
1566
+ # referential integrity, Attribute definitions referenced by a User data mapping
1567
+ # or the latest revision of a Consent cannot be deleted.
1558
1568
  # @param [String] fields
1559
1569
  # Selector specifying which fields to include in a partial response.
1560
1570
  # @param [String] quota_user
@@ -1612,13 +1622,13 @@ module Google
1612
1622
  execute_or_queue_command(command, &block)
1613
1623
  end
1614
1624
 
1615
- # Lists the Attribute definitions in the given Consent store.
1625
+ # Lists the Attribute definitions in the specified consent store.
1616
1626
  # @param [String] parent
1617
- # Required. Name of the Consent store to retrieve attribute definitions from.
1627
+ # Required. Name of the consent store to retrieve Attribute definitions from.
1618
1628
  # @param [String] filter
1619
- # Restricts the attributes returned to those matching a filter. The following
1620
- # syntax is available: * A string field value can be written as text inside
1621
- # quotation marks, for example `"query text"`. The only valid relational
1629
+ # Optional. Restricts the attributes returned to those matching a filter. The
1630
+ # following syntax is available: * A string field value can be written as text
1631
+ # inside quotation marks, for example `"query text"`. The only valid relational
1622
1632
  # operation for text fields is equality (`=`), where text is searched within the
1623
1633
  # field, rather than having the field be equal to the text. For example, `"
1624
1634
  # Comment = great"` returns messages with `great` in the comment field. * A
@@ -1637,12 +1647,13 @@ module Google
1637
1647
  # boolean operator appears within a quoted string, it is not treated as special,
1638
1648
  # it's just another part of the character string to be matched. You can prepend
1639
1649
  # the `NOT` operator to an expression to negate it. The only field available for
1640
- # filtering is `category`.
1650
+ # filtering is `category`. For example, `filter=category=\"REQUEST\"`.
1641
1651
  # @param [Fixnum] page_size
1642
- # Limit on the number of attribute definitions to return in a single response.
1643
- # If not specified, 100 is used. May not be larger than 1000.
1652
+ # Optional. Limit on the number of Attribute definitions to return in a single
1653
+ # response. If not specified, 100 is used. May not be larger than 1000.
1644
1654
  # @param [String] page_token
1645
- # Token to retrieve the next page of results or empty to get the first page.
1655
+ # Optional. Token to retrieve the next page of results or empty to get the first
1656
+ # page.
1646
1657
  # @param [String] fields
1647
1658
  # Selector specifying which fields to include in a partial response.
1648
1659
  # @param [String] quota_user
@@ -1675,17 +1686,18 @@ module Google
1675
1686
 
1676
1687
  # Updates the specified Attribute definition.
1677
1688
  # @param [String] name
1678
- # Resource name of the attribute definition, of the form `projects/`project_id`/
1689
+ # Resource name of the Attribute definition, of the form `projects/`project_id`/
1679
1690
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1680
- # attributeDefinitions/`attribute_definition_id``.
1691
+ # attributeDefinitions/`attribute_definition_id``. Cannot be changed after
1692
+ # creation.
1681
1693
  # @param [Google::Apis::HealthcareV1beta1::AttributeDefinition] attribute_definition_object
1682
1694
  # @param [String] update_mask
1683
- # The update mask that applies to the resource. For the `FieldMask` definition,
1684
- # see https://developers.google.com/protocol-buffers/docs/reference/google.
1685
- # protobuf#fieldmask. The `description`, `allowed_values`, `
1686
- # consent_default_values`, and `data_mapping_default_value` fields are allowed
1687
- # to be updated. The updated `allowed_values` must contain all values from the
1688
- # previous `allowed_values`.
1695
+ # Required. The update mask that applies to the resource. For the `FieldMask`
1696
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1697
+ # google.protobuf#fieldmask. Only the `description`, `allowed_values`, `
1698
+ # consent_default_values` and `data_mapping_default_value` fields can be updated.
1699
+ # The updated `allowed_values` must contain all values from the previous `
1700
+ # allowed_values`.
1689
1701
  # @param [String] fields
1690
1702
  # Selector specifying which fields to include in a partial response.
1691
1703
  # @param [String] quota_user
@@ -1716,9 +1728,9 @@ module Google
1716
1728
  execute_or_queue_command(command, &block)
1717
1729
  end
1718
1730
 
1719
- # Creates a new Consent artifact in the parent Consent store.
1731
+ # Creates a new Consent artifact in the parent consent store.
1720
1732
  # @param [String] parent
1721
- # Required. The name of the Consent store this consent artifact belongs to.
1733
+ # Required. The name of the consent store this Consent artifact belongs to.
1722
1734
  # @param [Google::Apis::HealthcareV1beta1::ConsentArtifact] consent_artifact_object
1723
1735
  # @param [String] fields
1724
1736
  # Selector specifying which fields to include in a partial response.
@@ -1749,10 +1761,12 @@ module Google
1749
1761
  execute_or_queue_command(command, &block)
1750
1762
  end
1751
1763
 
1752
- # Deletes the specified Consent artifact. Fails if it is referenced by the
1753
- # latest revision of any Consent.
1764
+ # Deletes the specified Consent artifact. Fails if the artifact is referenced by
1765
+ # the latest revision of any Consent.
1754
1766
  # @param [String] name
1755
- # Required. The resource name of the consent artifact to delete.
1767
+ # Required. The resource name of the Consent artifact to delete. To preserve
1768
+ # referential integrity, Consent artifacts referenced by the latest revision of
1769
+ # a Consent cannot be deleted.
1756
1770
  # @param [String] fields
1757
1771
  # Selector specifying which fields to include in a partial response.
1758
1772
  # @param [String] quota_user
@@ -1782,7 +1796,7 @@ module Google
1782
1796
 
1783
1797
  # Gets the specified Consent artifact.
1784
1798
  # @param [String] name
1785
- # Required. The resource name of the consent artifact to retrieve.
1799
+ # Required. The resource name of the Consent artifact to retrieve.
1786
1800
  # @param [String] fields
1787
1801
  # Selector specifying which fields to include in a partial response.
1788
1802
  # @param [String] quota_user
@@ -1810,13 +1824,13 @@ module Google
1810
1824
  execute_or_queue_command(command, &block)
1811
1825
  end
1812
1826
 
1813
- # Lists the Consent artifacts in the given Consent store.
1827
+ # Lists the Consent artifacts in the specified consent store.
1814
1828
  # @param [String] parent
1815
- # Required. Name of the Consent store to retrieve consent artifacts from.
1829
+ # Required. Name of the consent store to retrieve consent artifacts from.
1816
1830
  # @param [String] filter
1817
- # Restricts the artifacts returned to those matching a filter. The following
1818
- # syntax is available: * A string field value can be written as text inside
1819
- # quotation marks, for example `"query text"`. The only valid relational
1831
+ # Optional. Restricts the artifacts returned to those matching a filter. The
1832
+ # following syntax is available: * A string field value can be written as text
1833
+ # inside quotation marks, for example `"query text"`. The only valid relational
1820
1834
  # operation for text fields is equality (`=`), where text is searched within the
1821
1835
  # field, rather than having the field be equal to the text. For example, `"
1822
1836
  # Comment = great"` returns messages with `great` in the comment field. * A
@@ -1835,13 +1849,15 @@ module Google
1835
1849
  # boolean operator appears within a quoted string, it is not treated as special,
1836
1850
  # it's just another part of the character string to be matched. You can prepend
1837
1851
  # the `NOT` operator to an expression to negate it. The fields available for
1838
- # filtering are: - user_id - consent_content_version - metadata. For example, `
1839
- # Metadata("key")="value"` or `HasMetadata("key")`.
1852
+ # filtering are: - user_id. For example, `filter=user_id=\"user123\"`. -
1853
+ # consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=
1854
+ # \"value\"` or `filter=HasMetadata(\"testkey\")`.
1840
1855
  # @param [Fixnum] page_size
1841
- # Limit on the number of consent artifacts to return in a single response. If
1842
- # not specified, 100 is used. May not be larger than 1000.
1856
+ # Optional. Limit on the number of consent artifacts to return in a single
1857
+ # response. If not specified, 100 is used. May not be larger than 1000.
1843
1858
  # @param [String] page_token
1844
- # The next_page_token value returned from the previous List request, if any.
1859
+ # Optional. The next_page_token value returned from the previous List request,
1860
+ # if any.
1845
1861
  # @param [String] fields
1846
1862
  # Selector specifying which fields to include in a partial response.
1847
1863
  # @param [String] quota_user
@@ -1873,12 +1889,12 @@ module Google
1873
1889
  end
1874
1890
 
1875
1891
  # 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 given
1877
- # consent is in the `ACTIVE` state, no new revision is committed. A
1878
- # FAILED_PRECONDITION error occurs if the latest revision of the given consent
1879
- # is in the `REJECTED` or `REVOKED` state.
1892
+ # revision with `state` updated to `ACTIVE`. If the latest revision of the
1893
+ # specified Consent is in the `ACTIVE` state, no new revision is committed. A
1894
+ # FAILED_PRECONDITION error occurs if the latest revision of the specified
1895
+ # consent is in the `REJECTED` or `REVOKED` state.
1880
1896
  # @param [String] name
1881
- # Required. The resource name of the consent to activate, of the form `projects/`
1897
+ # Required. The resource name of the Consent to activate, of the form `projects/`
1882
1898
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1883
1899
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1884
1900
  # revision_id` is specified in the name.
@@ -1912,7 +1928,7 @@ module Google
1912
1928
  execute_or_queue_command(command, &block)
1913
1929
  end
1914
1930
 
1915
- # Creates a new Consent in the parent Consent store.
1931
+ # Creates a new Consent in the parent consent store.
1916
1932
  # @param [String] parent
1917
1933
  # Required. Name of the consent store.
1918
1934
  # @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
@@ -1947,10 +1963,10 @@ module Google
1947
1963
 
1948
1964
  # Deletes the Consent and its revisions. To keep a record of the Consent but
1949
1965
  # mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [
1950
- # DeleteConsentRevision]. This operation does not delete the related consent
1966
+ # DeleteConsentRevision]. This operation does not delete the related Consent
1951
1967
  # artifact.
1952
1968
  # @param [String] name
1953
- # Required. The resource name of the consent to delete, of the form `projects/`
1969
+ # Required. The resource name of the Consent to delete, of the form `projects/`
1954
1970
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1955
1971
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
1956
1972
  # revision_id` is specified in the name.
@@ -1984,7 +2000,7 @@ module Google
1984
2000
  # Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs
1985
2001
  # if the specified revision is the latest revision.
1986
2002
  # @param [String] name
1987
- # Required. The resource name of the consent revision to delete, of the form `
2003
+ # Required. The resource name of the Consent revision to delete, of the form `
1988
2004
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
1989
2005
  # consentStores/`consent_store_id`/consents/`consent_id`@`revision_id``. An
1990
2006
  # INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.
@@ -2018,10 +2034,10 @@ module Google
2018
2034
  # Gets the specified revision of a Consent, or the latest revision if `
2019
2035
  # revision_id` is not specified in the resource name.
2020
2036
  # @param [String] name
2021
- # Required. The resource name of the consent to retrieve, of the form `projects/`
2037
+ # Required. The resource name of the Consent to retrieve, of the form `projects/`
2022
2038
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
2023
2039
  # consent_store_id`/consents/`consent_id``. In order to retrieve a previous
2024
- # revision of the consent, also provide the revision ID: `projects/`project_id`/
2040
+ # revision of the Consent, also provide the revision ID: `projects/`project_id`/
2025
2041
  # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
2026
2042
  # consents/`consent_id`@`revision_id``
2027
2043
  # @param [String] fields
@@ -2051,14 +2067,14 @@ module Google
2051
2067
  execute_or_queue_command(command, &block)
2052
2068
  end
2053
2069
 
2054
- # Lists the Consent in the given Consent store, returning each consent's latest
2070
+ # Lists the Consent in the given consent store, returning each Consent's latest
2055
2071
  # revision.
2056
2072
  # @param [String] parent
2057
- # Required. Name of the Consent store to retrieve consents from.
2073
+ # Required. Name of the consent store to retrieve Consents from.
2058
2074
  # @param [String] filter
2059
- # Restricts the consents returned to those matching a filter. The following
2060
- # syntax is available: * A string field value can be written as text inside
2061
- # quotation marks, for example `"query text"`. The only valid relational
2075
+ # Optional. Restricts the consents returned to those matching a filter. The
2076
+ # following syntax is available: * A string field value can be written as text
2077
+ # inside quotation marks, for example `"query text"`. The only valid relational
2062
2078
  # operation for text fields is equality (`=`), where text is searched within the
2063
2079
  # field, rather than having the field be equal to the text. For example, `"
2064
2080
  # Comment = great"` returns messages with `great` in the comment field. * A
@@ -2077,13 +2093,15 @@ module Google
2077
2093
  # boolean operator appears within a quoted string, it is not treated as special,
2078
2094
  # it's just another part of the character string to be matched. You can prepend
2079
2095
  # the `NOT` operator to an expression to negate it. The fields available for
2080
- # filtering are: - user_id - consent_artifact - state - revision_create_time -
2081
- # metadata. For example, `Metadata("key")="value"` or `HasMetadata("key")`.
2096
+ # filtering are: - user_id. For example, `filter='user_id="user123"'`. -
2097
+ # consent_artifact - state - revision_create_time - metadata. For example, `
2098
+ # filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
2082
2099
  # @param [Fixnum] page_size
2083
- # Limit on the number of consents to return in a single response. If not
2084
- # specified, 100 is used. May not be larger than 1000.
2100
+ # Optional. Limit on the number of Consents to return in a single response. If
2101
+ # not specified, 100 is used. May not be larger than 1000.
2085
2102
  # @param [String] page_token
2086
- # The next_page_token value returned from the previous List request, if any.
2103
+ # Optional. The next_page_token value returned from the previous List request,
2104
+ # if any.
2087
2105
  # @param [String] fields
2088
2106
  # Selector specifying which fields to include in a partial response.
2089
2107
  # @param [String] quota_user
@@ -2114,13 +2132,13 @@ module Google
2114
2132
  execute_or_queue_command(command, &block)
2115
2133
  end
2116
2134
 
2117
- # Lists the revisions of the given Consent in reverse chronological order.
2135
+ # Lists the revisions of the specified Consent in reverse chronological order.
2118
2136
  # @param [String] name
2119
- # Required. The resource name of the consent to retrieve revisions for.
2137
+ # Required. The resource name of the Consent to retrieve revisions for.
2120
2138
  # @param [String] filter
2121
- # Restricts the revisions returned to those matching a filter. The following
2122
- # syntax is available: * A string field value can be written as text inside
2123
- # quotation marks, for example `"query text"`. The only valid relational
2139
+ # Optional. Restricts the revisions returned to those matching a filter. The
2140
+ # following syntax is available: * A string field value can be written as text
2141
+ # inside quotation marks, for example `"query text"`. The only valid relational
2124
2142
  # operation for text fields is equality (`=`), where text is searched within the
2125
2143
  # field, rather than having the field be equal to the text. For example, `"
2126
2144
  # Comment = great"` returns messages with `great` in the comment field. * A
@@ -2139,13 +2157,15 @@ module Google
2139
2157
  # boolean operator appears within a quoted string, it is not treated as special,
2140
2158
  # it's just another part of the character string to be matched. You can prepend
2141
2159
  # the `NOT` operator to an expression to negate it. Fields/functions available
2142
- # for filtering are: - user_id - consent_artifact - state - revision_create_time
2160
+ # for filtering are: - user_id. For example, `filter='user_id="user123"'`. -
2161
+ # consent_artifact - state - revision_create_time - metadata. For example, `
2162
+ # filter=Metadata(\"testkey\")=\"value\"` or `filter=HasMetadata(\"testkey\")`.
2143
2163
  # @param [Fixnum] page_size
2144
- # Limit on the number of revisions to return in a single response. If not
2145
- # specified, 100 is used. May not be larger than 1000.
2164
+ # Optional. Limit on the number of revisions to return in a single response. If
2165
+ # not specified, 100 is used. May not be larger than 1000.
2146
2166
  # @param [String] page_token
2147
- # Token to retrieve the next page of results or empty if there are no more
2148
- # results in the list.
2167
+ # Optional. Token to retrieve the next page of results or empty if there are no
2168
+ # more results in the list.
2149
2169
  # @param [String] fields
2150
2170
  # Selector specifying which fields to include in a partial response.
2151
2171
  # @param [String] quota_user
@@ -2178,17 +2198,17 @@ module Google
2178
2198
 
2179
2199
  # Updates the latest revision of the specified Consent by committing a new
2180
2200
  # revision with the changes. A FAILED_PRECONDITION error occurs if the latest
2181
- # revision of the given consent is in the `REJECTED` or `REVOKED` state.
2201
+ # revision of the specified Consent is in the `REJECTED` or `REVOKED` state.
2182
2202
  # @param [String] name
2183
2203
  # Resource name of the Consent, of the form `projects/`project_id`/locations/`
2184
2204
  # location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
2185
- # consent_id``.
2205
+ # consent_id``. Cannot be changed after creation.
2186
2206
  # @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
2187
2207
  # @param [String] update_mask
2188
- # The update mask to apply to the resource. For the `FieldMask` definition, see
2189
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
2190
- # fieldmask. The `user_id`, `policies`, and `consent_artifact` fields can be
2191
- # updated.
2208
+ # Required. The update mask to apply to the resource. For the `FieldMask`
2209
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
2210
+ # google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`,
2211
+ # and `metadata` fields can be updated.
2192
2212
  # @param [String] fields
2193
2213
  # Selector specifying which fields to include in a partial response.
2194
2214
  # @param [String] quota_user
@@ -2221,11 +2241,11 @@ module Google
2221
2241
 
2222
2242
  # Rejects the latest revision of the specified Consent by committing a new
2223
2243
  # revision with `state` updated to `REJECTED`. If the latest revision of the
2224
- # given consent is in the `REJECTED` state, no new revision is committed. A
2225
- # FAILED_PRECONDITION error occurs if the latest revision of the given consent
2226
- # is in the `ACTIVE` or `REVOKED` state.
2244
+ # specified Consent is in the `REJECTED` state, no new revision is committed. A
2245
+ # FAILED_PRECONDITION error occurs if the latest revision of the specified
2246
+ # Consent is in the `ACTIVE` or `REVOKED` state.
2227
2247
  # @param [String] name
2228
- # Required. The resource name of the consent to reject, of the form `projects/`
2248
+ # Required. The resource name of the Consent to reject, of the form `projects/`
2229
2249
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
2230
2250
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
2231
2251
  # revision_id` is specified in the name.
@@ -2261,11 +2281,11 @@ module Google
2261
2281
 
2262
2282
  # Revokes the latest revision of the specified Consent by committing a new
2263
2283
  # revision with `state` updated to `REVOKED`. If the latest revision of the
2264
- # given consent is in the `REVOKED` state, no new revision is committed. A
2284
+ # specified Consent is in the `REVOKED` state, no new revision is committed. A
2265
2285
  # FAILED_PRECONDITION error occurs if the latest revision of the given consent
2266
2286
  # is in `DRAFT` or `REJECTED` state.
2267
2287
  # @param [String] name
2268
- # Required. The resource name of the consent to revoke, of the form `projects/`
2288
+ # Required. The resource name of the Consent to revoke, of the form `projects/`
2269
2289
  # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
2270
2290
  # consent_store_id`/consents/`consent_id``. An INVALID_ARGUMENT error occurs if `
2271
2291
  # revision_id` is specified in the name.
@@ -2301,7 +2321,7 @@ module Google
2301
2321
 
2302
2322
  # Archives the specified User data mapping.
2303
2323
  # @param [String] name
2304
- # The resource name of the user data mapping to archive.
2324
+ # Required. The resource name of the User data mapping to archive.
2305
2325
  # @param [Google::Apis::HealthcareV1beta1::ArchiveUserDataMappingRequest] archive_user_data_mapping_request_object
2306
2326
  # @param [String] fields
2307
2327
  # Selector specifying which fields to include in a partial response.
@@ -2332,7 +2352,7 @@ module Google
2332
2352
  execute_or_queue_command(command, &block)
2333
2353
  end
2334
2354
 
2335
- # Creates a new User data mapping in the parent Consent store.
2355
+ # Creates a new User data mapping in the parent consent store.
2336
2356
  # @param [String] parent
2337
2357
  # Required. Name of the consent store.
2338
2358
  # @param [Google::Apis::HealthcareV1beta1::UserDataMapping] user_data_mapping_object
@@ -2367,7 +2387,7 @@ module Google
2367
2387
 
2368
2388
  # Deletes the specified User data mapping.
2369
2389
  # @param [String] name
2370
- # Required. The resource name of the user data mapping to delete.
2390
+ # Required. The resource name of the User data mapping to delete.
2371
2391
  # @param [String] fields
2372
2392
  # Selector specifying which fields to include in a partial response.
2373
2393
  # @param [String] quota_user
@@ -2397,7 +2417,7 @@ module Google
2397
2417
 
2398
2418
  # Gets the specified User data mapping.
2399
2419
  # @param [String] name
2400
- # Required. The resource name of the user data mapping to retrieve.
2420
+ # Required. The resource name of the User data mapping to retrieve.
2401
2421
  # @param [String] fields
2402
2422
  # Selector specifying which fields to include in a partial response.
2403
2423
  # @param [String] quota_user
@@ -2425,37 +2445,39 @@ module Google
2425
2445
  execute_or_queue_command(command, &block)
2426
2446
  end
2427
2447
 
2428
- # Lists the User data mappings in the given Consent store.
2448
+ # Lists the User data mappings in the specified consent store.
2429
2449
  # @param [String] parent
2430
- # Required. Name of the Consent store to retrieve user data mappings from.
2450
+ # Required. Name of the consent store to retrieve User data mappings from.
2431
2451
  # @param [String] filter
2432
- # Restricts the user data mappings returned to those matching a filter. The
2433
- # following syntax is available: * A string field value can be written as text
2434
- # inside quotation marks, for example `"query text"`. The only valid relational
2435
- # operation for text fields is equality (`=`), where text is searched within the
2436
- # field, rather than having the field be equal to the text. For example, `"
2437
- # Comment = great"` returns messages with `great` in the comment field. * A
2438
- # number field value can be written as an integer, a decimal, or an exponential.
2439
- # The valid relational operators for number fields are the equality operator (`=`
2440
- # ), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
2441
- # Note that there is no inequality (`!=`) operator. You can prepend the `NOT`
2442
- # operator to an expression to negate it. * A date field value must be written
2443
- # in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format.
2444
- # Leading zeros are required for one-digit months and days. The valid relational
2445
- # operators for date fields are the equality operator (`=`) , along with the
2446
- # less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no
2447
- # inequality (`!=`) operator. You can prepend the `NOT` operator to an
2448
- # expression to negate it. * Multiple field query expressions can be combined in
2449
- # one query by adding `AND` or `OR` operators between the expressions. If a
2452
+ # Optional. Restricts the user data mappings returned to those matching a filter.
2453
+ # The following syntax is available: * A string field value can be written as
2454
+ # text inside quotation marks, for example `"query text"`. The only valid
2455
+ # relational operation for text fields is equality (`=`), where text is searched
2456
+ # within the field, rather than having the field be equal to the text. For
2457
+ # example, `"Comment = great"` returns messages with `great` in the comment
2458
+ # field. * A number field value can be written as an integer, a decimal, or an
2459
+ # exponential. The valid relational operators for number fields are the equality
2460
+ # operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`
2461
+ # , `>=`). Note that there is no inequality (`!=`) operator. You can prepend the
2462
+ # `NOT` operator to an expression to negate it. * A date field value must be
2463
+ # written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time
2464
+ # format. Leading zeros are required for one-digit months and days. The valid
2465
+ # relational operators for date fields are the equality operator (`=`) , along
2466
+ # with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that
2467
+ # there is no inequality (`!=`) operator. You can prepend the `NOT` operator to
2468
+ # an expression to negate it. * Multiple field query expressions can be combined
2469
+ # in one query by adding `AND` or `OR` operators between the expressions. If a
2450
2470
  # boolean operator appears within a quoted string, it is not treated as special,
2451
2471
  # it's just another part of the character string to be matched. You can prepend
2452
2472
  # the `NOT` operator to an expression to negate it. The fields available for
2453
- # filtering are: - data_id - user_id - archived - archive_time
2473
+ # filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\"`.
2474
+ # - archived - archive_time
2454
2475
  # @param [Fixnum] page_size
2455
- # Limit on the number of user data mappings to return in a single response. If
2456
- # not specified, 100 is used. May not be larger than 1000.
2476
+ # Optional. Limit on the number of User data mappings to return in a single
2477
+ # response. If not specified, 100 is used. May not be larger than 1000.
2457
2478
  # @param [String] page_token
2458
- # Token to retrieve the next page of results or empty to get the first page.
2479
+ # Optional. Token to retrieve the next page of results, or empty to get the
2480
+ # first page.
2459
2481
  # @param [String] fields
2460
2482
  # Selector specifying which fields to include in a partial response.
2461
2483
  # @param [String] quota_user
@@ -2493,9 +2515,10 @@ module Google
2493
2515
  # userDataMappings/`user_data_mapping_id``.
2494
2516
  # @param [Google::Apis::HealthcareV1beta1::UserDataMapping] user_data_mapping_object
2495
2517
  # @param [String] update_mask
2496
- # The update mask that applies to the resource. For the `FieldMask` definition,
2497
- # see https://developers.google.com/protocol-buffers/docs/reference/google.
2498
- # protobuf#fieldmask.
2518
+ # Required. The update mask that applies to the resource. For the `FieldMask`
2519
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
2520
+ # google.protobuf#fieldmask. Only the `data_id`, `user_id` and `
2521
+ # resource_attributes` fields can be updated.
2499
2522
  # @param [String] fields
2500
2523
  # Selector specifying which fields to include in a partial response.
2501
2524
  # @param [String] quota_user
@@ -2569,8 +2592,8 @@ module Google
2569
2592
  # result may still be successful if de-identification fails for some DICOM
2570
2593
  # instances. The output DICOM store will not contain these failed resources. The
2571
2594
  # number of resources processed are tracked in Operation.metadata. Error details
2572
- # are logged to Cloud Logging. For more information, see [Viewing logs](/
2573
- # healthcare/docs/how-tos/logging).
2595
+ # are logged to Cloud Logging. For more information, see [Viewing error logs in
2596
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
2574
2597
  # @param [String] source_store
2575
2598
  # Source DICOM store resource name. For example, `projects/`project_id`/
2576
2599
  # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
@@ -2637,8 +2660,8 @@ module Google
2637
2660
 
2638
2661
  # Exports data to the specified destination by copying it from the DICOM store.
2639
2662
  # Errors are also logged to Cloud Logging. For more information, see [Viewing
2640
- # logs](/healthcare/docs/how-tos/logging). The metadata field type is
2641
- # OperationMetadata.
2663
+ # errors in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2664
+ # logging). The metadata field type is OperationMetadata.
2642
2665
  # @param [String] name
2643
2666
  # The DICOM store resource name from which to export the data. For example, `
2644
2667
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -2745,8 +2768,9 @@ module Google
2745
2768
  end
2746
2769
 
2747
2770
  # Imports data into the DICOM store by copying it from the specified source.
2748
- # Errors are logged to Cloud Logging. For more information, see [Viewing logs](/
2749
- # healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.
2771
+ # Errors are logged to Cloud Logging. For more information, see [Viewing error
2772
+ # logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2773
+ # logging). The metadata field type is OperationMetadata.
2750
2774
  # @param [String] name
2751
2775
  # The name of the DICOM store resource into which the data is imported. For
2752
2776
  # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
@@ -3133,11 +3157,10 @@ module Google
3133
3157
 
3134
3158
  # DeleteStudy deletes all instances within the given study using a long running
3135
3159
  # operation. The method returns an Operation which will be marked successful
3136
- # when the deletion is complete. Warning: If you insert instances into a study
3137
- # while a delete operation is running for that study, the instances you insert
3138
- # might not appear in search results until after the deletion operation finishes.
3139
- # For samples that show how to call DeleteStudy, see [Deleting a study, series,
3140
- # or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
3160
+ # when the deletion is complete. Warning: Instances cannot be inserted into a
3161
+ # study that is being deleted by an operation until the operation completes. For
3162
+ # samples that show how to call DeleteStudy, see [Deleting a study, series, or
3163
+ # instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
3141
3164
  # deleting_a_study_series_or_instance).
3142
3165
  # @param [String] parent
3143
3166
  # @param [String] dicom_web_path
@@ -3392,12 +3415,11 @@ module Google
3392
3415
 
3393
3416
  # DeleteSeries deletes all instances within the given study and series using a
3394
3417
  # long running operation. The method returns an Operation which will be marked
3395
- # successful when the deletion is complete. Warning: If you insert instances
3396
- # into a series while a delete operation is running for that series, the
3397
- # instances you insert might not appear in search results until after the
3398
- # deletion operation finishes. For samples that show how to call DeleteSeries,
3399
- # see [Deleting a study, series, or instance](https://cloud.google.com/
3400
- # healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
3418
+ # successful when the deletion is complete. Warning: Instances cannot be
3419
+ # inserted into a series that is being deleted by an operation until the
3420
+ # operation completes. For samples that show how to call DeleteSeries, see [
3421
+ # Deleting a study, series, or instance](https://cloud.google.com/healthcare/
3422
+ # docs/how-tos/dicomweb#deleting_a_study_series_or_instance).
3401
3423
  # @param [String] parent
3402
3424
  # The name of the DICOM store that is being accessed. For example, `projects/`
3403
3425
  # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
@@ -3869,8 +3891,8 @@ module Google
3869
3891
  # store. The metadata field type is OperationMetadata. If the request is
3870
3892
  # successful, the response field type is DeidentifyFhirStoreSummary. The number
3871
3893
  # of resources processed are tracked in Operation.metadata. Error details are
3872
- # logged to Cloud Logging. For more information, see [Viewing logs](/healthcare/
3873
- # docs/how-tos/logging).
3894
+ # logged to Cloud Logging. For more information, see [Viewing error logs in
3895
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
3874
3896
  # @param [String] source_store
3875
3897
  # Source FHIR store resource name. For example, `projects/`project_id`/locations/
3876
3898
  # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
@@ -3937,10 +3959,11 @@ module Google
3937
3959
  # Export resources from the FHIR store to the specified destination. This method
3938
3960
  # returns an Operation that can be used to track the status of the export by
3939
3961
  # calling GetOperation. Immediate fatal errors appear in the error field, errors
3940
- # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](/
3941
- # healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a
3942
- # detailed response of type ExportResourcesResponse is returned in the response
3943
- # field. The metadata field type for this operation is OperationMetadata.
3962
+ # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
3963
+ # https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
3964
+ # the operation finishes, a detailed response of type ExportResourcesResponse is
3965
+ # returned in the response field. The metadata field type for this operation is
3966
+ # OperationMetadata.
3944
3967
  # @param [String] name
3945
3968
  # The name of the FHIR store to export resource from, in the format of `projects/
3946
3969
  # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
@@ -4056,7 +4079,7 @@ module Google
4056
4079
  # stored using the supplied ID regardless of the enable_update_create setting on
4057
4080
  # the FHIR store. It is strongly advised not to include or encode any sensitive
4058
4081
  # data such as patient identifiers in client-specified resource IDs. Those IDs
4059
- # are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/
4082
+ # are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/
4060
4083
  # Sub notifications. Those IDs can also be contained in reference fields within
4061
4084
  # other resources. The import process does not enforce referential integrity,
4062
4085
  # regardless of the disable_referential_integrity setting on the FHIR store.
@@ -4094,10 +4117,11 @@ module Google
4094
4117
  # searchset` bundles produced by a FHIR search or Patient-everything operation.
4095
4118
  # This method returns an Operation that can be used to track the status of the
4096
4119
  # import by calling GetOperation. Immediate fatal errors appear in the error
4097
- # field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/
4098
- # docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed
4099
- # response of type ImportResourcesResponse is returned in the response field.
4100
- # The metadata field type for this operation is OperationMetadata.
4120
+ # field, errors are also logged to Cloud Logging (see [Viewing error logs in
4121
+ # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
4122
+ # Otherwise, when the operation finishes, a detailed response of type
4123
+ # ImportResourcesResponse is returned in the response field. The metadata field
4124
+ # type for this operation is OperationMetadata.
4101
4125
  # @param [String] name
4102
4126
  # The name of the FHIR store to import FHIR resources to, in the format of `
4103
4127
  # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
@@ -4806,22 +4830,21 @@ module Google
4806
4830
  # set, creates the resource with the client-specified ID. It is strongly advised
4807
4831
  # not to include or encode any sensitive data such as patient identifiers in
4808
4832
  # client-specified resource IDs. Those IDs are part of the FHIR resource path
4809
- # recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can
4810
- # also be contained in reference fields within other resources. If the search
4811
- # criteria identify zero matches, and the supplied resource body does not
4812
- # contain an `id`, the resource is created with a server-assigned ID as per the
4813
- # create method. The request body must contain a JSON-encoded FHIR resource, and
4814
- # the request headers must contain `Content-Type: application/fhir+json`. On
4815
- # success, the response body contains a JSON-encoded representation of the
4816
- # updated resource, including the server-assigned version ID. Errors generated
4817
- # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
4818
- # describing the reason for the error. If the request cannot be mapped to a
4819
- # valid API method on a FHIR store, a generic GCP error might be returned
4820
- # instead. This method requires the`healthcare.fhirStores.searchResources` and `
4821
- # healthcare.fhirResources.update` permissions on the parent FHIR store. For
4822
- # samples that show how to call `conditionalUpdate`, see [Conditionally updating
4823
- # a FHIR resource](/healthcare/docs/how-tos/fhir-resources#
4824
- # conditionally_updating_a_fhir_resource).
4833
+ # recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
4834
+ # contained in reference fields within other resources. If the search criteria
4835
+ # identify zero matches, and the supplied resource body does not contain an `id`,
4836
+ # the resource is created with a server-assigned ID as per the create method.
4837
+ # The request body must contain a JSON-encoded FHIR resource, and the request
4838
+ # headers must contain `Content-Type: application/fhir+json`. On success, the
4839
+ # response body contains a JSON-encoded representation of the updated resource,
4840
+ # including the server-assigned version ID. Errors generated by the FHIR store
4841
+ # contain a JSON-encoded `OperationOutcome` resource describing the reason for
4842
+ # the error. If the request cannot be mapped to a valid API method on a FHIR
4843
+ # store, a generic GCP error might be returned instead. This method requires the`
4844
+ # healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update`
4845
+ # permissions on the parent FHIR store. For samples that show how to call `
4846
+ # conditionalUpdate`, see [Conditionally updating a FHIR resource](/healthcare/
4847
+ # docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).
4825
4848
  # @param [String] parent
4826
4849
  # The name of the FHIR store this resource belongs to.
4827
4850
  # @param [String] type
@@ -5344,14 +5367,14 @@ module Google
5344
5367
  # set, creates the resource with the client-specified ID. It is strongly advised
5345
5368
  # not to include or encode any sensitive data such as patient identifiers in
5346
5369
  # client-specified resource IDs. Those IDs are part of the FHIR resource path
5347
- # recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can
5348
- # also be contained in reference fields within other resources. The request body
5349
- # must contain a JSON-encoded FHIR resource, and the request headers must
5350
- # contain `Content-Type: application/fhir+json`. The resource must contain an `
5351
- # id` element having an identical value to the ID in the REST path of the
5352
- # request. On success, the response body contains a JSON-encoded representation
5353
- # of the updated resource, including the server-assigned version ID. Errors
5354
- # generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource
5370
+ # recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be
5371
+ # contained in reference fields within other resources. The request body must
5372
+ # contain a JSON-encoded FHIR resource, and the request headers must contain `
5373
+ # Content-Type: application/fhir+json`. The resource must contain an `id`
5374
+ # element having an identical value to the ID in the REST path of the request.
5375
+ # On success, the response body contains a JSON-encoded representation of the
5376
+ # updated resource, including the server-assigned version ID. Errors generated
5377
+ # by the FHIR store contain a JSON-encoded `OperationOutcome` resource
5355
5378
  # describing the reason for the error. If the request cannot be mapped to a
5356
5379
  # valid API method on a FHIR store, a generic GCP error might be returned
5357
5380
  # instead. For samples that show how to call `update`, see [Updating a FHIR
@@ -5625,10 +5648,11 @@ module Google
5625
5648
  # successfully imported messages are not rolled back. This method returns an
5626
5649
  # Operation that can be used to track the status of the import by calling
5627
5650
  # GetOperation. Immediate fatal errors appear in the error field, errors are
5628
- # also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/
5629
- # logging)). Otherwise, when the operation finishes, a response of type
5630
- # ImportMessagesResponse is returned in the response field. The metadata field
5631
- # type for this operation is OperationMetadata.
5651
+ # also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https:/
5652
+ # /cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the
5653
+ # operation finishes, a response of type ImportMessagesResponse is returned in
5654
+ # the response field. The metadata field type for this operation is
5655
+ # OperationMetadata.
5632
5656
  # @param [String] name
5633
5657
  # The name of the target HL7v2 store, in the format `projects/`project_id`/
5634
5658
  # locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
@@ -5878,10 +5902,10 @@ module Google
5878
5902
  end
5879
5903
 
5880
5904
  # Parses and stores an HL7v2 message. This method triggers an asynchronous
5881
- # notification to any Cloud Pub/Sub topic configured in projects.locations.
5882
- # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
5883
- # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
5884
- # the adapter transmits the message when a notification is received.
5905
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
5906
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
5907
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
5908
+ # message when a notification is received.
5885
5909
  # @param [String] parent
5886
5910
  # The name of the dataset this message belongs to.
5887
5911
  # @param [Google::Apis::HealthcareV1beta1::CreateMessageRequest] create_message_request_object
@@ -5979,14 +6003,14 @@ module Google
5979
6003
  end
5980
6004
 
5981
6005
  # Parses and stores an HL7v2 message. This method triggers an asynchronous
5982
- # notification to any Cloud Pub/Sub topic configured in projects.locations.
5983
- # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the
5984
- # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic,
5985
- # the adapter transmits the message when a notification is received. This method
5986
- # also generates a response containing an HL7v2 acknowledgement (`ACK`) message
5987
- # when successful or a negative acknowledgement (`NACK`) message in case of
5988
- # error, suitable for replying to HL7v2 interface systems that expect these
5989
- # acknowledgements.
6006
+ # notification to any Pub/Sub topic configured in Hl7V2Store.
6007
+ # Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP
6008
+ # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
6009
+ # message when a notification is received. If the method is successful, it
6010
+ # generates a response containing an HL7v2 acknowledgment (`ACK`) message. If
6011
+ # the method encounters an error, it returns a negative acknowledgment (`NACK`)
6012
+ # message. This behavior is suitable for replying to HL7v2 interface systems
6013
+ # that expect these acknowledgments.
5990
6014
  # @param [String] parent
5991
6015
  # The name of the HL7v2 store this message belongs to.
5992
6016
  # @param [Google::Apis::HealthcareV1beta1::IngestMessageRequest] ingest_message_request_object
@@ -6052,14 +6076,17 @@ module Google
6052
6076
  # dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-
6053
6077
  # 01-02"`. * `send_time`, the timestamp when the message was sent, using the
6054
6078
  # RFC3339 time format for comparisons, from the MSH-7 segment. For example, `
6055
- # send_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center
6056
- # that the message came from, from the MSH-4 segment. For example, `
6057
- # send_facility = "ABC"`. * `PatientId(value, type)`, which matches if the
6058
- # message lists a patient having an ID of the given value and type in the PID-2,
6059
- # PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.
6060
- # x`, a string value of the label with key `x` as set using the Message.labels
6061
- # map. For example, `labels."priority"="high"`. The operator `:*` can be used to
6062
- # assert the existence of a label. For example, `labels."priority":*`.
6079
+ # send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when
6080
+ # the message was created in the HL7v2 store. Use the RFC3339 time format for
6081
+ # comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `
6082
+ # send_facility`, the care center that the message came from, from the MSH-4
6083
+ # segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`,
6084
+ # which matches if the message lists a patient having an ID of the given value
6085
+ # and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("
6086
+ # 123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as
6087
+ # set using the Message.labels map. For example, `labels."priority"="high"`. The
6088
+ # operator `:*` can be used to assert the existence of a label. For example, `
6089
+ # labels."priority":*`.
6063
6090
  # @param [String] order_by
6064
6091
  # Orders messages returned by the specified order_by clause. Syntax: https://
6065
6092
  # cloud.google.com/apis/design/design_patterns#sorting_order Fields available