google-apis-healthcare_v1beta1 0.62.0 → 0.64.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +9 -0
  3. data/lib/google/apis/healthcare_v1beta1/classes.rb +233 -62
  4. data/lib/google/apis/healthcare_v1beta1/gem_version.rb +3 -3
  5. data/lib/google/apis/healthcare_v1beta1/representations.rb +69 -0
  6. data/lib/google/apis/healthcare_v1beta1/service.rb +340 -290
  7. metadata +3 -3
data/lib/google/apis/healthcare_v1beta1/service.rb CHANGED
@@ -128,12 +128,12 @@ module Google
128
128
  # interface which returns either an `Operation.response` which contains a
129
129
  # Dataset or `Operation.error`. The metadata field type is OperationMetadata.
130
130
  # @param [String] parent
131
- # The name of the project where the server creates the dataset. For example, `
132
- # projects/`project_id`/locations/`location_id``.
131
+ # Required. The name of the project where the server creates the dataset. For
132
+ # example, `projects/`project_id`/locations/`location_id``.
133
133
  # @param [Google::Apis::HealthcareV1beta1::Dataset] dataset_object
134
134
  # @param [String] dataset_id
135
- # The ID of the dataset that is being created. The string must match the
136
- # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
135
+ # Required. The ID of the dataset that is being created. The string must match
136
+ # the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
137
137
  # @param [String] fields
138
138
  # Selector specifying which fields to include in a partial response.
139
139
  # @param [String] quota_user
@@ -173,8 +173,8 @@ module Google
173
173
  # logged to Cloud Logging. For more information, see [Viewing error logs in
174
174
  # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
175
175
  # @param [String] source_dataset
176
- # Source dataset resource name. For example, `projects/`project_id`/locations/`
177
- # location_id`/datasets/`dataset_id``.
176
+ # Required. Source dataset resource name. For example, `projects/`project_id`/
177
+ # locations/`location_id`/datasets/`dataset_id``.
178
178
  # @param [Google::Apis::HealthcareV1beta1::DeidentifyDatasetRequest] deidentify_dataset_request_object
179
179
  # @param [String] fields
180
180
  # Selector specifying which fields to include in a partial response.
@@ -209,8 +209,8 @@ module Google
209
209
  # Deleting a dataset does not affect the sources from which the dataset was
210
210
  # imported (if any).
211
211
  # @param [String] name
212
- # The name of the dataset to delete. For example, `projects/`project_id`/
213
- # locations/`location_id`/datasets/`dataset_id``.
212
+ # Required. The name of the dataset to delete. For example, `projects/`
213
+ # project_id`/locations/`location_id`/datasets/`dataset_id``.
214
214
  # @param [String] fields
215
215
  # Selector specifying which fields to include in a partial response.
216
216
  # @param [String] quota_user
@@ -240,8 +240,8 @@ module Google
240
240
 
241
241
  # Gets any metadata associated with a dataset.
242
242
  # @param [String] name
243
- # The name of the dataset to read. For example, `projects/`project_id`/locations/
244
- # `location_id`/datasets/`dataset_id``.
243
+ # Required. The name of the dataset to read. For example, `projects/`project_id`/
244
+ # locations/`location_id`/datasets/`dataset_id``.
245
245
  # @param [String] fields
246
246
  # Selector specifying which fields to include in a partial response.
247
247
  # @param [String] quota_user
@@ -316,8 +316,8 @@ module Google
316
316
 
317
317
  # Lists the health datasets in the current project.
318
318
  # @param [String] parent
319
- # The name of the project whose datasets should be listed. For example, `
320
- # projects/`project_id`/locations/`location_id``.
319
+ # Required. The name of the project whose datasets should be listed. For example,
320
+ # `projects/`project_id`/locations/`location_id``.
321
321
  # @param [Fixnum] page_size
322
322
  # The maximum number of items to return. If not specified, 100 is used. May not
323
323
  # be larger than 1000.
@@ -354,13 +354,13 @@ module Google
354
354
 
355
355
  # Updates dataset metadata.
356
356
  # @param [String] name
357
- # Resource name of the dataset, of the form `projects/`project_id`/locations/`
358
- # location_id`/datasets/`dataset_id``.
357
+ # Identifier. Resource name of the dataset, of the form `projects/`project_id`/
358
+ # locations/`location_id`/datasets/`dataset_id``.
359
359
  # @param [Google::Apis::HealthcareV1beta1::Dataset] dataset_object
360
360
  # @param [String] update_mask
361
- # The update mask applies to the resource. For the `FieldMask` definition, see
362
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
363
- # fieldmask
361
+ # Required. The update mask applies to the resource. For the `FieldMask`
362
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
363
+ # google.protobuf#fieldmask
364
364
  # @param [String] fields
365
365
  # Selector specifying which fields to include in a partial response.
366
366
  # @param [String] quota_user
@@ -469,11 +469,11 @@ module Google
469
469
 
470
470
  # Creates a new Annotation store within the parent dataset.
471
471
  # @param [String] parent
472
- # The name of the dataset this Annotation store belongs to.
472
+ # Required. The name of the dataset this Annotation store belongs to.
473
473
  # @param [Google::Apis::HealthcareV1beta1::AnnotationStore] annotation_store_object
474
474
  # @param [String] annotation_store_id
475
- # The ID of the Annotation store that is being created. The string must match
476
- # the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
475
+ # Required. The ID of the Annotation store that is being created. The string
476
+ # must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
477
477
  # @param [String] fields
478
478
  # Selector specifying which fields to include in a partial response.
479
479
  # @param [String] quota_user
@@ -507,7 +507,7 @@ module Google
507
507
  # Deletes the specified Annotation store and removes all annotations that are
508
508
  # contained within it.
509
509
  # @param [String] name
510
- # The resource name of the Annotation store to delete.
510
+ # Required. The resource name of the Annotation store to delete.
511
511
  # @param [String] fields
512
512
  # Selector specifying which fields to include in a partial response.
513
513
  # @param [String] quota_user
@@ -542,8 +542,8 @@ module Google
542
542
  # error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
543
543
  # logging)).
544
544
  # @param [String] name
545
- # The Annotation store to compare against `golden_store`, in the format of `
546
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
545
+ # Required. The Annotation store to compare against `golden_store`, in the
546
+ # format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
547
547
  # annotationStores/`annotation_store_id``.
548
548
  # @param [Google::Apis::HealthcareV1beta1::EvaluateAnnotationStoreRequest] evaluate_annotation_store_request_object
549
549
  # @param [String] fields
@@ -581,8 +581,8 @@ module Google
581
581
  # OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs
582
582
  # in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
583
583
  # @param [String] name
584
- # The name of the Annotation store to export annotations to, in the format of `
585
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
584
+ # Required. The name of the Annotation store to export annotations to, in the
585
+ # format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
586
586
  # annotationStores/`annotation_store_id``.
587
587
  # @param [Google::Apis::HealthcareV1beta1::ExportAnnotationsRequest] export_annotations_request_object
588
588
  # @param [String] fields
@@ -616,7 +616,7 @@ module Google
616
616
 
617
617
  # Gets the specified Annotation store or returns NOT_FOUND if it does not exist.
618
618
  # @param [String] name
619
- # The resource name of the Annotation store to get.
619
+ # Required. The resource name of the Annotation store to get.
620
620
  # @param [String] fields
621
621
  # Selector specifying which fields to include in a partial response.
622
622
  # @param [String] quota_user
@@ -696,9 +696,9 @@ module Google
696
696
  # logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://
697
697
  # cloud.google.com/healthcare/docs/how-tos/logging)).
698
698
  # @param [String] name
699
- # The name of the Annotation store to which the server imports annotations, in
700
- # the format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`
701
- # /annotationStores/`annotation_store_id``.
699
+ # Required. The name of the Annotation store to which the server imports
700
+ # annotations, in the format `projects/`project_id`/locations/`location_id`/
701
+ # datasets/`dataset_id`/annotationStores/`annotation_store_id``.
702
702
  # @param [Google::Apis::HealthcareV1beta1::ImportAnnotationsRequest] import_annotations_request_object
703
703
  # @param [String] fields
704
704
  # Selector specifying which fields to include in a partial response.
@@ -731,7 +731,7 @@ module Google
731
731
 
732
732
  # Lists the Annotation stores in the given dataset for a source store.
733
733
  # @param [String] parent
734
- # Name of the dataset.
734
+ # Required. Name of the dataset.
735
735
  # @param [String] filter
736
736
  # Restricts stores returned to those matching a filter. The following syntax is
737
737
  # available: * A string field value can be written as text inside quotation
@@ -792,14 +792,14 @@ module Google
792
792
 
793
793
  # Updates the specified Annotation store.
794
794
  # @param [String] name
795
- # Resource name of the Annotation store, of the form `projects/`project_id`/
796
- # locations/`location_id`/datasets/`dataset_id`/annotationStores/`
795
+ # Identifier. Resource name of the Annotation store, of the form `projects/`
796
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/annotationStores/`
797
797
  # annotation_store_id``.
798
798
  # @param [Google::Apis::HealthcareV1beta1::AnnotationStore] annotation_store_object
799
799
  # @param [String] update_mask
800
- # The update mask applies to the resource. For the `FieldMask` definition, see
801
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
802
- # fieldmask
800
+ # Required. The update mask applies to the resource. For the `FieldMask`
801
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
802
+ # google.protobuf#fieldmask
803
803
  # @param [String] fields
804
804
  # Selector specifying which fields to include in a partial response.
805
805
  # @param [String] quota_user
@@ -910,9 +910,9 @@ module Google
910
910
  # the same source more than once since a unique ID is assigned to each record by
911
911
  # this service.
912
912
  # @param [String] parent
913
- # The name of the Annotation store this annotation belongs to. For example, `
914
- # projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/
915
- # myannotationstore`.
913
+ # Required. The name of the Annotation store this annotation belongs to. For
914
+ # example, `projects/my-project/locations/us-central1/datasets/mydataset/
915
+ # annotationStores/myannotationstore`.
916
916
  # @param [Google::Apis::HealthcareV1beta1::Annotation] annotation_object
917
917
  # @param [String] fields
918
918
  # Selector specifying which fields to include in a partial response.
@@ -945,7 +945,7 @@ module Google
945
945
 
946
946
  # Deletes an Annotation or returns NOT_FOUND if it does not exist.
947
947
  # @param [String] name
948
- # The resource name of the Annotation to delete.
948
+ # Required. The resource name of the Annotation to delete.
949
949
  # @param [String] fields
950
950
  # Selector specifying which fields to include in a partial response.
951
951
  # @param [String] quota_user
@@ -975,7 +975,7 @@ module Google
975
975
 
976
976
  # Gets an Annotation.
977
977
  # @param [String] name
978
- # The resource name of the Annotation to retrieve.
978
+ # Required. The resource name of the Annotation to retrieve.
979
979
  # @param [String] fields
980
980
  # Selector specifying which fields to include in a partial response.
981
981
  # @param [String] quota_user
@@ -1005,7 +1005,7 @@ module Google
1005
1005
 
1006
1006
  # Lists the Annotations in the given Annotation store for a source resource.
1007
1007
  # @param [String] parent
1008
- # Name of the Annotation store to retrieve Annotations from.
1008
+ # Required. Name of the Annotation store to retrieve Annotations from.
1009
1009
  # @param [String] filter
1010
1010
  # Restricts Annotations returned to those matching a filter. Functions available
1011
1011
  # for filtering are: - `matches("annotation_source.cloud_healthcare_source.name",
@@ -1054,14 +1054,14 @@ module Google
1054
1054
 
1055
1055
  # Updates the Annotation.
1056
1056
  # @param [String] name
1057
- # Resource name of the Annotation, of the form `projects/`project_id`/locations/`
1058
- # location_id`/datasets/`dataset_id`/annotationStores/`annotation_store_id`/
1059
- # annotations/`annotation_id``.
1057
+ # Identifier. Resource name of the Annotation, of the form `projects/`project_id`
1058
+ # /locations/`location_id`/datasets/`dataset_id`/annotationStores/`
1059
+ # annotation_store_id`/annotations/`annotation_id``.
1060
1060
  # @param [Google::Apis::HealthcareV1beta1::Annotation] annotation_object
1061
1061
  # @param [String] update_mask
1062
- # The update mask applies to the resource. For the `FieldMask` definition, see
1063
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
1064
- # fieldmask
1062
+ # Required. The update mask applies to the resource. For the `FieldMask`
1063
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
1064
+ # google.protobuf#fieldmask
1065
1065
  # @param [String] fields
1066
1066
  # Selector specifying which fields to include in a partial response.
1067
1067
  # @param [String] quota_user
@@ -1709,10 +1709,10 @@ module Google
1709
1709
 
1710
1710
  # Updates the specified Attribute definition.
1711
1711
  # @param [String] name
1712
- # Resource name of the Attribute definition, of the form `projects/`project_id`/
1713
- # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
1714
- # attributeDefinitions/`attribute_definition_id``. Cannot be changed after
1715
- # creation.
1712
+ # Identifier. Resource name of the Attribute definition, of the form `projects/`
1713
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
1714
+ # consent_store_id`/attributeDefinitions/`attribute_definition_id``. Cannot be
1715
+ # changed after creation.
1716
1716
  # @param [Google::Apis::HealthcareV1beta1::AttributeDefinition] attribute_definition_object
1717
1717
  # @param [String] update_mask
1718
1718
  # Required. The update mask that applies to the resource. For the `FieldMask`
@@ -2223,9 +2223,9 @@ module Google
2223
2223
  # revision with the changes. A FAILED_PRECONDITION error occurs if the latest
2224
2224
  # revision of the specified Consent is in the `REJECTED` or `REVOKED` state.
2225
2225
  # @param [String] name
2226
- # Resource name of the Consent, of the form `projects/`project_id`/locations/`
2227
- # location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/consents/`
2228
- # consent_id``. Cannot be changed after creation.
2226
+ # Identifier. Resource name of the Consent, of the form `projects/`project_id`/
2227
+ # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
2228
+ # consents/`consent_id``. Cannot be changed after creation.
2229
2229
  # @param [Google::Apis::HealthcareV1beta1::Consent] consent_object
2230
2230
  # @param [String] update_mask
2231
2231
  # Required. The update mask to apply to the resource. For the `FieldMask`
@@ -2574,11 +2574,11 @@ module Google
2574
2574
 
2575
2575
  # Creates a new DICOM store within the parent dataset.
2576
2576
  # @param [String] parent
2577
- # The name of the dataset this DICOM store belongs to.
2577
+ # Required. The name of the dataset this DICOM store belongs to.
2578
2578
  # @param [Google::Apis::HealthcareV1beta1::DicomStore] dicom_store_object
2579
2579
  # @param [String] dicom_store_id
2580
- # The ID of the DICOM store that is being created. Any string value up to 256
2581
- # characters in length.
2580
+ # Required. The ID of the DICOM store that is being created. Any string value up
2581
+ # to 256 characters in length.
2582
2582
  # @param [String] fields
2583
2583
  # Selector specifying which fields to include in a partial response.
2584
2584
  # @param [String] quota_user
@@ -2618,8 +2618,8 @@ module Google
2618
2618
  # are logged to Cloud Logging. For more information, see [Viewing error logs in
2619
2619
  # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
2620
2620
  # @param [String] source_store
2621
- # Source DICOM store resource name. For example, `projects/`project_id`/
2622
- # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
2621
+ # Required. Source DICOM store resource name. For example, `projects/`project_id`
2622
+ # /locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
2623
2623
  # @param [Google::Apis::HealthcareV1beta1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object
2624
2624
  # @param [String] fields
2625
2625
  # Selector specifying which fields to include in a partial response.
@@ -2653,7 +2653,7 @@ module Google
2653
2653
  # Deletes the specified DICOM store and removes all images that are contained
2654
2654
  # within it.
2655
2655
  # @param [String] name
2656
- # The resource name of the DICOM store to delete.
2656
+ # Required. The resource name of the DICOM store to delete.
2657
2657
  # @param [String] fields
2658
2658
  # Selector specifying which fields to include in a partial response.
2659
2659
  # @param [String] quota_user
@@ -2686,8 +2686,8 @@ module Google
2686
2686
  # errors in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2687
2687
  # logging). The metadata field type is OperationMetadata.
2688
2688
  # @param [String] name
2689
- # The DICOM store resource name from which to export the data. For example, `
2690
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
2689
+ # Required. The DICOM store resource name from which to export the data. For
2690
+ # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
2691
2691
  # dicomStores/`dicom_store_id``.
2692
2692
  # @param [Google::Apis::HealthcareV1beta1::ExportDicomDataRequest] export_dicom_data_request_object
2693
2693
  # @param [String] fields
@@ -2721,7 +2721,7 @@ module Google
2721
2721
 
2722
2722
  # Gets the specified DICOM store.
2723
2723
  # @param [String] name
2724
- # The resource name of the DICOM store to get.
2724
+ # Required. The resource name of the DICOM store to get.
2725
2725
  # @param [String] fields
2726
2726
  # Selector specifying which fields to include in a partial response.
2727
2727
  # @param [String] quota_user
@@ -2751,7 +2751,7 @@ module Google
2751
2751
 
2752
2752
  # Gets metrics associated with the DICOM store.
2753
2753
  # @param [String] name
2754
- # The resource name of the DICOM store to get metrics for.
2754
+ # Required. The resource name of the DICOM store to get metrics for.
2755
2755
  # @param [String] fields
2756
2756
  # Selector specifying which fields to include in a partial response.
2757
2757
  # @param [String] quota_user
@@ -2829,9 +2829,9 @@ module Google
2829
2829
  # logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
2830
2830
  # logging). The metadata field type is OperationMetadata.
2831
2831
  # @param [String] name
2832
- # The name of the DICOM store resource into which the data is imported. For
2833
- # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
2834
- # dicomStores/`dicom_store_id``.
2832
+ # Required. The name of the DICOM store resource into which the data is imported.
2833
+ # For example, `projects/`project_id`/locations/`location_id`/datasets/`
2834
+ # dataset_id`/dicomStores/`dicom_store_id``.
2835
2835
  # @param [Google::Apis::HealthcareV1beta1::ImportDicomDataRequest] import_dicom_data_request_object
2836
2836
  # @param [String] fields
2837
2837
  # Selector specifying which fields to include in a partial response.
@@ -2864,7 +2864,7 @@ module Google
2864
2864
 
2865
2865
  # Lists the DICOM stores in the given dataset.
2866
2866
  # @param [String] parent
2867
- # Name of the dataset.
2867
+ # Required. Name of the dataset.
2868
2868
  # @param [String] filter
2869
2869
  # Restricts stores returned to those matching a filter. The following syntax is
2870
2870
  # available: * A string field value can be written as text inside quotation
@@ -2925,8 +2925,9 @@ module Google
2925
2925
 
2926
2926
  # Updates the specified DICOM store.
2927
2927
  # @param [String] name
2928
- # Resource name of the DICOM store, of the form `projects/`project_id`/locations/
2929
- # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
2928
+ # Identifier. Resource name of the DICOM store, of the form `projects/`
2929
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
2930
+ # dicom_store_id``.
2930
2931
  # @param [Google::Apis::HealthcareV1beta1::DicomStore] dicom_store_object
2931
2932
  # @param [String] update_mask
2932
2933
  # The update mask applies to the resource. For the `FieldMask` definition, see
@@ -2971,13 +2972,13 @@ module Google
2971
2972
  # see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/
2972
2973
  # dicomweb#search-dicom).
2973
2974
  # @param [String] parent
2974
- # The name of the DICOM store that is being accessed. For example, `projects/`
2975
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
2976
- # dicom_store_id``.
2975
+ # Required. The name of the DICOM store that is being accessed. For example, `
2976
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
2977
+ # dicomStores/`dicom_store_id``.
2977
2978
  # @param [String] dicom_web_path
2978
- # The path of the SearchForInstancesRequest DICOMweb request. For example, `
2979
- # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
2980
- # .
2979
+ # Required. The path of the SearchForInstancesRequest DICOMweb request. For
2980
+ # example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
2981
+ # instances`.
2981
2982
  # @param [String] fields
2982
2983
  # Selector specifying which fields to include in a partial response.
2983
2984
  # @param [String] quota_user
@@ -3014,12 +3015,12 @@ module Google
3014
3015
  # SearchForSeries, see [Search for DICOM data](https://cloud.google.com/
3015
3016
  # healthcare/docs/how-tos/dicomweb#search-dicom).
3016
3017
  # @param [String] parent
3017
- # The name of the DICOM store that is being accessed. For example, `projects/`
3018
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3019
- # dicom_store_id``.
3018
+ # Required. The name of the DICOM store that is being accessed. For example, `
3019
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3020
+ # dicomStores/`dicom_store_id``.
3020
3021
  # @param [String] dicom_web_path
3021
- # The path of the SearchForSeries DICOMweb request. For example, `series` or `
3022
- # studies/`study_uid`/series`.
3022
+ # Required. The path of the SearchForSeries DICOMweb request. For example, `
3023
+ # series` or `studies/`study_uid`/series`.
3023
3024
  # @param [String] fields
3024
3025
  # Selector specifying which fields to include in a partial response.
3025
3026
  # @param [String] quota_user
@@ -3056,11 +3057,12 @@ module Google
3056
3057
  # to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/
3057
3058
  # healthcare/docs/how-tos/dicomweb#search-dicom).
3058
3059
  # @param [String] parent
3059
- # The name of the DICOM store that is being accessed. For example, `projects/`
3060
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3061
- # dicom_store_id``.
3060
+ # Required. The name of the DICOM store that is being accessed. For example, `
3061
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3062
+ # dicomStores/`dicom_store_id``.
3062
3063
  # @param [String] dicom_web_path
3063
- # The path of the SearchForStudies DICOMweb request. For example, `studies`.
3064
+ # Required. The path of the SearchForStudies DICOMweb request. For example, `
3065
+ # studies`.
3064
3066
  # @param [String] fields
3065
3067
  # Selector specifying which fields to include in a partial response.
3066
3068
  # @param [String] quota_user
@@ -3177,12 +3179,12 @@ module Google
3177
3179
  # Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
3178
3180
  # store-dicom).
3179
3181
  # @param [String] parent
3180
- # The name of the DICOM store that is being accessed. For example, `projects/`
3181
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3182
- # dicom_store_id``.
3182
+ # Required. The name of the DICOM store that is being accessed. For example, `
3183
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3184
+ # dicomStores/`dicom_store_id``.
3183
3185
  # @param [String] dicom_web_path
3184
- # The path of the StoreInstances DICOMweb request. For example, `studies/[`
3185
- # study_uid`]`. Note that the `study_uid` is optional.
3186
+ # Required. The path of the StoreInstances DICOMweb request. For example, `
3187
+ # studies/[`study_uid`]`. Note that the `study_uid` is optional.
3186
3188
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
3187
3189
  # @param [String] fields
3188
3190
  # Selector specifying which fields to include in a partial response.
@@ -3255,9 +3257,9 @@ module Google
3255
3257
 
3256
3258
  # GetStudyMetrics returns metrics for a study.
3257
3259
  # @param [String] study
3258
- # The study resource path. For example, `projects/`project_id`/locations/`
3259
- # location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
3260
- # studies/`study_uid``.
3260
+ # Required. The study resource path. For example, `projects/`project_id`/
3261
+ # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
3262
+ # dicomWeb/studies/`study_uid``.
3261
3263
  # @param [String] fields
3262
3264
  # Selector specifying which fields to include in a partial response.
3263
3265
  # @param [String] quota_user
@@ -3329,9 +3331,9 @@ module Google
3329
3331
 
3330
3332
  # GetSeriesMetrics returns metrics for a series.
3331
3333
  # @param [String] series
3332
- # The series resource path. For example, `projects/`project_id`/locations/`
3333
- # location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
3334
- # studies/`study_uid`/series/`series_uid``.
3334
+ # Required. The series resource path. For example, `projects/`project_id`/
3335
+ # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
3336
+ # dicomWeb/studies/`study_uid`/series/`series_uid``.
3335
3337
  # @param [String] fields
3336
3338
  # Selector specifying which fields to include in a partial response.
3337
3339
  # @param [String] quota_user
@@ -3401,7 +3403,8 @@ module Google
3401
3403
  # dicom).
3402
3404
  # @param [String] parent
3403
3405
  # @param [String] dicom_web_path
3404
- # The path of the DeleteStudy request. For example, `studies/`study_uid``.
3406
+ # Required. The path of the DeleteStudy request. For example, `studies/`
3407
+ # study_uid``.
3405
3408
  # @param [String] fields
3406
3409
  # Selector specifying which fields to include in a partial response.
3407
3410
  # @param [String] quota_user
@@ -3439,12 +3442,12 @@ module Google
3439
3442
  # to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.
3440
3443
  # com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
3441
3444
  # @param [String] parent
3442
- # The name of the DICOM store that is being accessed. For example, `projects/`
3443
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3444
- # dicom_store_id``.
3445
+ # Required. The name of the DICOM store that is being accessed. For example, `
3446
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3447
+ # dicomStores/`dicom_store_id``.
3445
3448
  # @param [String] dicom_web_path
3446
- # The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/`
3447
- # study_uid`/metadata`.
3449
+ # Required. The path of the RetrieveStudyMetadata DICOMweb request. For example,
3450
+ # `studies/`study_uid`/metadata`.
3448
3451
  # @param [String] fields
3449
3452
  # Selector specifying which fields to include in a partial response.
3450
3453
  # @param [String] quota_user
@@ -3482,12 +3485,12 @@ module Google
3482
3485
  # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-
3483
3486
  # dicom).
3484
3487
  # @param [String] parent
3485
- # The name of the DICOM store that is being accessed. For example, `projects/`
3486
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3487
- # dicom_store_id``.
3488
+ # Required. The name of the DICOM store that is being accessed. For example, `
3489
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3490
+ # dicomStores/`dicom_store_id``.
3488
3491
  # @param [String] dicom_web_path
3489
- # The path of the RetrieveStudy DICOMweb request. For example, `studies/`
3490
- # study_uid``.
3492
+ # Required. The path of the RetrieveStudy DICOMweb request. For example, `
3493
+ # studies/`study_uid``.
3491
3494
  # @param [String] fields
3492
3495
  # Selector specifying which fields to include in a partial response.
3493
3496
  # @param [String] quota_user
@@ -3525,13 +3528,13 @@ module Google
3525
3528
  # see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/
3526
3529
  # dicomweb#search-dicom).
3527
3530
  # @param [String] parent
3528
- # The name of the DICOM store that is being accessed. For example, `projects/`
3529
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3530
- # dicom_store_id``.
3531
+ # Required. The name of the DICOM store that is being accessed. For example, `
3532
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3533
+ # dicomStores/`dicom_store_id``.
3531
3534
  # @param [String] dicom_web_path
3532
- # The path of the SearchForInstancesRequest DICOMweb request. For example, `
3533
- # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
3534
- # .
3535
+ # Required. The path of the SearchForInstancesRequest DICOMweb request. For
3536
+ # example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
3537
+ # instances`.
3535
3538
  # @param [String] fields
3536
3539
  # Selector specifying which fields to include in a partial response.
3537
3540
  # @param [String] quota_user
@@ -3568,12 +3571,12 @@ module Google
3568
3571
  # SearchForSeries, see [Search for DICOM data](https://cloud.google.com/
3569
3572
  # healthcare/docs/how-tos/dicomweb#search-dicom).
3570
3573
  # @param [String] parent
3571
- # The name of the DICOM store that is being accessed. For example, `projects/`
3572
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3573
- # dicom_store_id``.
3574
+ # Required. The name of the DICOM store that is being accessed. For example, `
3575
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3576
+ # dicomStores/`dicom_store_id``.
3574
3577
  # @param [String] dicom_web_path
3575
- # The path of the SearchForSeries DICOMweb request. For example, `series` or `
3576
- # studies/`study_uid`/series`.
3578
+ # Required. The path of the SearchForSeries DICOMweb request. For example, `
3579
+ # series` or `studies/`study_uid`/series`.
3577
3580
  # @param [String] fields
3578
3581
  # Selector specifying which fields to include in a partial response.
3579
3582
  # @param [String] quota_user
@@ -3611,12 +3614,12 @@ module Google
3611
3614
  # Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
3612
3615
  # store-dicom).
3613
3616
  # @param [String] parent
3614
- # The name of the DICOM store that is being accessed. For example, `projects/`
3615
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3616
- # dicom_store_id``.
3617
+ # Required. The name of the DICOM store that is being accessed. For example, `
3618
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3619
+ # dicomStores/`dicom_store_id``.
3617
3620
  # @param [String] dicom_web_path
3618
- # The path of the StoreInstances DICOMweb request. For example, `studies/[`
3619
- # study_uid`]`. Note that the `study_uid` is optional.
3621
+ # Required. The path of the StoreInstances DICOMweb request. For example, `
3622
+ # studies/[`study_uid`]`. Note that the `study_uid` is optional.
3620
3623
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
3621
3624
  # @param [String] fields
3622
3625
  # Selector specifying which fields to include in a partial response.
@@ -3656,12 +3659,12 @@ module Google
3656
3659
  # Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/
3657
3660
  # how-tos/dicomweb#delete-dicom).
3658
3661
  # @param [String] parent
3659
- # The name of the DICOM store that is being accessed. For example, `projects/`
3660
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3661
- # dicom_store_id``.
3662
+ # Required. The name of the DICOM store that is being accessed. For example, `
3663
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3664
+ # dicomStores/`dicom_store_id``.
3662
3665
  # @param [String] dicom_web_path
3663
- # The path of the DeleteSeries request. For example, `studies/`study_uid`/series/
3664
- # `series_uid``.
3666
+ # Required. The path of the DeleteSeries request. For example, `studies/`
3667
+ # study_uid`/series/`series_uid``.
3665
3668
  # @param [String] fields
3666
3669
  # Selector specifying which fields to include in a partial response.
3667
3670
  # @param [String] quota_user
@@ -3700,12 +3703,12 @@ module Google
3700
3703
  # RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/
3701
3704
  # healthcare/docs/how-tos/dicomweb#retrieve-metadata).
3702
3705
  # @param [String] parent
3703
- # The name of the DICOM store that is being accessed. For example, `projects/`
3704
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3705
- # dicom_store_id``.
3706
+ # Required. The name of the DICOM store that is being accessed. For example, `
3707
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3708
+ # dicomStores/`dicom_store_id``.
3706
3709
  # @param [String] dicom_web_path
3707
- # The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/
3708
- # `study_uid`/series/`series_uid`/metadata`.
3710
+ # Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example,
3711
+ # `studies/`study_uid`/series/`series_uid`/metadata`.
3709
3712
  # @param [String] fields
3710
3713
  # Selector specifying which fields to include in a partial response.
3711
3714
  # @param [String] quota_user
@@ -3743,12 +3746,12 @@ module Google
3743
3746
  # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-
3744
3747
  # dicom).
3745
3748
  # @param [String] parent
3746
- # The name of the DICOM store that is being accessed. For example, `projects/`
3747
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3748
- # dicom_store_id``.
3749
+ # Required. The name of the DICOM store that is being accessed. For example, `
3750
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3751
+ # dicomStores/`dicom_store_id``.
3749
3752
  # @param [String] dicom_web_path
3750
- # The path of the RetrieveSeries DICOMweb request. For example, `studies/`
3751
- # study_uid`/series/`series_uid``.
3753
+ # Required. The path of the RetrieveSeries DICOMweb request. For example, `
3754
+ # studies/`study_uid`/series/`series_uid``.
3752
3755
  # @param [String] fields
3753
3756
  # Selector specifying which fields to include in a partial response.
3754
3757
  # @param [String] quota_user
@@ -3786,13 +3789,13 @@ module Google
3786
3789
  # see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/
3787
3790
  # dicomweb#search-dicom).
3788
3791
  # @param [String] parent
3789
- # The name of the DICOM store that is being accessed. For example, `projects/`
3790
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3791
- # dicom_store_id``.
3792
+ # Required. The name of the DICOM store that is being accessed. For example, `
3793
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3794
+ # dicomStores/`dicom_store_id``.
3792
3795
  # @param [String] dicom_web_path
3793
- # The path of the SearchForInstancesRequest DICOMweb request. For example, `
3794
- # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
3795
- # .
3796
+ # Required. The path of the SearchForInstancesRequest DICOMweb request. For
3797
+ # example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
3798
+ # instances`.
3796
3799
  # @param [String] fields
3797
3800
  # Selector specifying which fields to include in a partial response.
3798
3801
  # @param [String] quota_user
@@ -3829,12 +3832,12 @@ module Google
3829
3832
  # a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/
3830
3833
  # dicomweb#delete-dicom).
3831
3834
  # @param [String] parent
3832
- # The name of the DICOM store that is being accessed. For example, `projects/`
3833
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3834
- # dicom_store_id``.
3835
+ # Required. The name of the DICOM store that is being accessed. For example, `
3836
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3837
+ # dicomStores/`dicom_store_id``.
3835
3838
  # @param [String] dicom_web_path
3836
- # The path of the DeleteInstance request. For example, `studies/`study_uid`/
3837
- # series/`series_uid`/instances/`instance_uid``.
3839
+ # Required. The path of the DeleteInstance request. For example, `studies/`
3840
+ # study_uid`/series/`series_uid`/instances/`instance_uid``.
3838
3841
  # @param [String] fields
3839
3842
  # Selector specifying which fields to include in a partial response.
3840
3843
  # @param [String] quota_user
@@ -3873,12 +3876,12 @@ module Google
3873
3876
  # call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/
3874
3877
  # healthcare/docs/how-tos/dicomweb#retrieve-instance).
3875
3878
  # @param [String] parent
3876
- # The name of the DICOM store that is being accessed. For example, `projects/`
3877
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3878
- # dicom_store_id``.
3879
+ # Required. The name of the DICOM store that is being accessed. For example, `
3880
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3881
+ # dicomStores/`dicom_store_id``.
3879
3882
  # @param [String] dicom_web_path
3880
- # The path of the RetrieveInstance DICOMweb request. For example, `studies/`
3881
- # study_uid`/series/`series_uid`/instances/`instance_uid``.
3883
+ # Required. The path of the RetrieveInstance DICOMweb request. For example, `
3884
+ # studies/`study_uid`/series/`series_uid`/instances/`instance_uid``.
3882
3885
  # @param [String] fields
3883
3886
  # Selector specifying which fields to include in a partial response.
3884
3887
  # @param [String] quota_user
@@ -3917,12 +3920,13 @@ module Google
3917
3920
  # RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/
3918
3921
  # healthcare/docs/how-tos/dicomweb#retrieve-metadata).
3919
3922
  # @param [String] parent
3920
- # The name of the DICOM store that is being accessed. For example, `projects/`
3921
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3922
- # dicom_store_id``.
3923
+ # Required. The name of the DICOM store that is being accessed. For example, `
3924
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3925
+ # dicomStores/`dicom_store_id``.
3923
3926
  # @param [String] dicom_web_path
3924
- # The path of the RetrieveInstanceMetadata DICOMweb request. For example, `
3925
- # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`.
3927
+ # Required. The path of the RetrieveInstanceMetadata DICOMweb request. For
3928
+ # example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
3929
+ # metadata`.
3926
3930
  # @param [String] fields
3927
3931
  # Selector specifying which fields to include in a partial response.
3928
3932
  # @param [String] quota_user
@@ -3961,12 +3965,13 @@ module Google
3961
3965
  # RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.
3962
3966
  # google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
3963
3967
  # @param [String] parent
3964
- # The name of the DICOM store that is being accessed. For example, `projects/`
3965
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
3966
- # dicom_store_id``.
3968
+ # Required. The name of the DICOM store that is being accessed. For example, `
3969
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
3970
+ # dicomStores/`dicom_store_id``.
3967
3971
  # @param [String] dicom_web_path
3968
- # The path of the RetrieveRenderedInstance DICOMweb request. For example, `
3969
- # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`.
3972
+ # Required. The path of the RetrieveRenderedInstance DICOMweb request. For
3973
+ # example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
3974
+ # rendered`.
3970
3975
  # @param [String] fields
3971
3976
  # Selector specifying which fields to include in a partial response.
3972
3977
  # @param [String] quota_user
@@ -4048,12 +4053,13 @@ module Google
4048
4053
  # Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
4049
4054
  # retrieve-dicom).
4050
4055
  # @param [String] parent
4051
- # The name of the DICOM store that is being accessed. For example, `projects/`
4052
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
4053
- # dicom_store_id``.
4056
+ # Required. The name of the DICOM store that is being accessed. For example, `
4057
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
4058
+ # dicomStores/`dicom_store_id``.
4054
4059
  # @param [String] dicom_web_path
4055
- # The path of the RetrieveFrames DICOMweb request. For example, `studies/`
4056
- # study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list``.
4060
+ # Required. The path of the RetrieveFrames DICOMweb request. For example, `
4061
+ # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
4062
+ # frame_list``.
4057
4063
  # @param [String] fields
4058
4064
  # Selector specifying which fields to include in a partial response.
4059
4065
  # @param [String] quota_user
@@ -4092,13 +4098,13 @@ module Google
4092
4098
  # RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.
4093
4099
  # google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
4094
4100
  # @param [String] parent
4095
- # The name of the DICOM store that is being accessed. For example, `projects/`
4096
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
4097
- # dicom_store_id``.
4101
+ # Required. The name of the DICOM store that is being accessed. For example, `
4102
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
4103
+ # dicomStores/`dicom_store_id``.
4098
4104
  # @param [String] dicom_web_path
4099
- # The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/
4100
- # `study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list`/
4101
- # rendered`.
4105
+ # Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,
4106
+ # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
4107
+ # frame_list`/rendered`.
4102
4108
  # @param [String] fields
4103
4109
  # Selector specifying which fields to include in a partial response.
4104
4110
  # @param [String] quota_user
@@ -4143,8 +4149,9 @@ module Google
4143
4149
  # consent check for data access, `consent_config.access_enforced` must be set to
4144
4150
  # true for the FhirStore.
4145
4151
  # @param [String] name
4146
- # The name of the FHIR store to enforce, in the format `projects/`project_id`/
4147
- # locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
4152
+ # Required. The name of the FHIR store to enforce, in the format `projects/`
4153
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
4154
+ # fhir_store_id``.
4148
4155
  # @param [Google::Apis::HealthcareV1beta1::ApplyAdminConsentsRequest] apply_admin_consents_request_object
4149
4156
  # @param [String] fields
4150
4157
  # Selector specifying which fields to include in a partial response.
@@ -4229,8 +4236,9 @@ module Google
4229
4236
  # returns an Operation that can be used to track the progress of the reindexing
4230
4237
  # by calling GetOperation.
4231
4238
  # @param [String] name
4232
- # The name of the FHIR store to configure, in the format `projects/`project_id`/
4233
- # locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
4239
+ # Required. The name of the FHIR store to configure, in the format `projects/`
4240
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
4241
+ # fhir_store_id``.
4234
4242
  # @param [Google::Apis::HealthcareV1beta1::ConfigureSearchRequest] configure_search_request_object
4235
4243
  # @param [String] fields
4236
4244
  # Selector specifying which fields to include in a partial response.
@@ -4263,11 +4271,11 @@ module Google
4263
4271
 
4264
4272
  # Creates a new FHIR store within the parent dataset.
4265
4273
  # @param [String] parent
4266
- # The name of the dataset this FHIR store belongs to.
4274
+ # Required. The name of the dataset this FHIR store belongs to.
4267
4275
  # @param [Google::Apis::HealthcareV1beta1::FhirStore] fhir_store_object
4268
4276
  # @param [String] fhir_store_id
4269
- # The ID of the FHIR store that is being created. The string must match the
4270
- # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
4277
+ # Required. The ID of the FHIR store that is being created. The string must
4278
+ # match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
4271
4279
  # @param [String] fields
4272
4280
  # Selector specifying which fields to include in a partial response.
4273
4281
  # @param [String] quota_user
@@ -4305,8 +4313,8 @@ module Google
4305
4313
  # logged to Cloud Logging. For more information, see [Viewing error logs in
4306
4314
  # Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging).
4307
4315
  # @param [String] source_store
4308
- # Source FHIR store resource name. For example, `projects/`project_id`/locations/
4309
- # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
4316
+ # Required. Source FHIR store resource name. For example, `projects/`project_id`/
4317
+ # locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
4310
4318
  # @param [Google::Apis::HealthcareV1beta1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
4311
4319
  # @param [String] fields
4312
4320
  # Selector specifying which fields to include in a partial response.
@@ -4339,7 +4347,7 @@ module Google
4339
4347
 
4340
4348
  # Deletes the specified FHIR store and removes all resources within it.
4341
4349
  # @param [String] name
4342
- # The resource name of the FHIR store to delete.
4350
+ # Required. The resource name of the FHIR store to delete.
4343
4351
  # @param [String] fields
4344
4352
  # Selector specifying which fields to include in a partial response.
4345
4353
  # @param [String] quota_user
@@ -4367,6 +4375,43 @@ module Google
4367
4375
  execute_or_queue_command(command, &block)
4368
4376
  end
4369
4377
 
4378
+ # Explains all the permitted/denied actor, purpose and environment for a given
4379
+ # resource.
4380
+ # @param [String] name
4381
+ # Required. The name of the FHIR store to enforce, in the format `projects/`
4382
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
4383
+ # fhir_store_id``.
4384
+ # @param [String] resource_id
4385
+ # Required. The ID (``resourceType`/`id``) of the resource to explain data
4386
+ # access on.
4387
+ # @param [String] fields
4388
+ # Selector specifying which fields to include in a partial response.
4389
+ # @param [String] quota_user
4390
+ # Available to use for quota purposes for server-side applications. Can be any
4391
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4392
+ # @param [Google::Apis::RequestOptions] options
4393
+ # Request-specific options
4394
+ #
4395
+ # @yield [result, err] Result & error if block supplied
4396
+ # @yieldparam result [Google::Apis::HealthcareV1beta1::ExplainDataAccessResponse] parsed result object
4397
+ # @yieldparam err [StandardError] error object if request failed
4398
+ #
4399
+ # @return [Google::Apis::HealthcareV1beta1::ExplainDataAccessResponse]
4400
+ #
4401
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4402
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4403
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4404
+ def explain_project_location_dataset_fhir_store_data_access(name, resource_id: nil, fields: nil, quota_user: nil, options: nil, &block)
4405
+ command = make_simple_command(:get, 'v1beta1/{+name}:explainDataAccess', options)
4406
+ command.response_representation = Google::Apis::HealthcareV1beta1::ExplainDataAccessResponse::Representation
4407
+ command.response_class = Google::Apis::HealthcareV1beta1::ExplainDataAccessResponse
4408
+ command.params['name'] = name unless name.nil?
4409
+ command.query['resourceId'] = resource_id unless resource_id.nil?
4410
+ command.query['fields'] = fields unless fields.nil?
4411
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4412
+ execute_or_queue_command(command, &block)
4413
+ end
4414
+
4370
4415
  # Export resources from the FHIR store to the specified destination. This method
4371
4416
  # returns an Operation that can be used to track the status of the export by
4372
4417
  # calling GetOperation. Immediate fatal errors appear in the error field, errors
@@ -4376,9 +4421,9 @@ module Google
4376
4421
  # returned in the response field. The metadata field type for this operation is
4377
4422
  # OperationMetadata.
4378
4423
  # @param [String] name
4379
- # The name of the FHIR store to export resource from, in the format of `projects/
4380
- # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
4381
- # fhir_store_id``.
4424
+ # Required. The name of the FHIR store to export resource from, in the format of
4425
+ # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
4426
+ # fhirStores/`fhir_store_id``.
4382
4427
  # @param [Google::Apis::HealthcareV1beta1::ExportResourcesRequest] export_resources_request_object
4383
4428
  # @param [String] fields
4384
4429
  # Selector specifying which fields to include in a partial response.
@@ -4411,7 +4456,7 @@ module Google
4411
4456
 
4412
4457
  # Gets the configuration of the specified FHIR store.
4413
4458
  # @param [String] name
4414
- # The resource name of the FHIR store to get.
4459
+ # Required. The resource name of the FHIR store to get.
4415
4460
  # @param [String] fields
4416
4461
  # Selector specifying which fields to include in a partial response.
4417
4462
  # @param [String] quota_user
@@ -4441,7 +4486,7 @@ module Google
4441
4486
 
4442
4487
  # Gets metrics associated with the FHIR store.
4443
4488
  # @param [String] name
4444
- # The resource name of the FHIR store to get metrics for.
4489
+ # Required. The resource name of the FHIR store to get metrics for.
4445
4490
  # @param [String] fields
4446
4491
  # Selector specifying which fields to include in a partial response.
4447
4492
  # @param [String] quota_user
@@ -4568,9 +4613,9 @@ module Google
4568
4613
  # ImportResourcesResponse is returned in the response field. The metadata field
4569
4614
  # type for this operation is OperationMetadata.
4570
4615
  # @param [String] name
4571
- # The name of the FHIR store to import FHIR resources to, in the format of `
4572
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
4573
- # `fhir_store_id``.
4616
+ # Required. The name of the FHIR store to import FHIR resources to, in the
4617
+ # format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
4618
+ # fhirStores/`fhir_store_id``.
4574
4619
  # @param [Google::Apis::HealthcareV1beta1::ImportResourcesRequest] import_resources_request_object
4575
4620
  # @param [String] fields
4576
4621
  # Selector specifying which fields to include in a partial response.
@@ -4603,7 +4648,7 @@ module Google
4603
4648
 
4604
4649
  # Lists the FHIR stores in the given dataset.
4605
4650
  # @param [String] parent
4606
- # Name of the dataset.
4651
+ # Required. Name of the dataset.
4607
4652
  # @param [String] filter
4608
4653
  # Restricts stores returned to those matching a filter. The following syntax is
4609
4654
  # available: * A string field value can be written as text inside quotation
@@ -4664,13 +4709,13 @@ module Google
4664
4709
 
4665
4710
  # Updates the configuration of the specified FHIR store.
4666
4711
  # @param [String] name
4667
- # Output only. Resource name of the FHIR store, of the form `projects/`
4668
- # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
4712
+ # Output only. Identifier. Resource name of the FHIR store, of the form `
4713
+ # projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
4669
4714
  # @param [Google::Apis::HealthcareV1beta1::FhirStore] fhir_store_object
4670
4715
  # @param [String] update_mask
4671
- # The update mask applies to the resource. For the `FieldMask` definition, see
4672
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
4673
- # fieldmask
4716
+ # Required. The update mask applies to the resource. For the `FieldMask`
4717
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
4718
+ # google.protobuf#fieldmask
4674
4719
  # @param [String] fields
4675
4720
  # Selector specifying which fields to include in a partial response.
4676
4721
  # @param [String] quota_user
@@ -4830,10 +4875,10 @@ module Google
4830
4875
  # for the error. If the request cannot be mapped to a valid API method on a FHIR
4831
4876
  # store, a generic GCP error might be returned instead.
4832
4877
  # @param [String] parent
4833
- # The name for the FHIR store containing the concept map(s) to use for the
4834
- # translation.
4878
+ # Required. The name for the FHIR store containing the concept map(s) to use for
4879
+ # the translation.
4835
4880
  # @param [String] code
4836
- # The code to translate.
4881
+ # Required. The code to translate.
4837
4882
  # @param [String] concept_map_version
4838
4883
  # The version of the concept map to use. If unset, the most current version is
4839
4884
  # used.
@@ -4841,7 +4886,7 @@ module Google
4841
4886
  # The source value set of the concept map to be used. If unset, target is used
4842
4887
  # to search for concept maps.
4843
4888
  # @param [String] system
4844
- # The system for the code to be translated.
4889
+ # Required. The system for the code to be translated.
4845
4890
  # @param [String] target
4846
4891
  # The target value set of the concept map to be used. If unset, source is used
4847
4892
  # to search for concept maps.
@@ -4893,14 +4938,14 @@ module Google
4893
4938
  # the error. If the request cannot be mapped to a valid API method on a FHIR
4894
4939
  # store, a generic GCP error might be returned instead.
4895
4940
  # @param [String] name
4896
- # The URL for the concept map to use for the translation.
4941
+ # Required. The URL for the concept map to use for the translation.
4897
4942
  # @param [String] code
4898
- # The code to translate.
4943
+ # Required. The code to translate.
4899
4944
  # @param [String] concept_map_version
4900
4945
  # The version of the concept map to use. If unset, the most current version is
4901
4946
  # used.
4902
4947
  # @param [String] system
4903
- # The system for the code to be translated.
4948
+ # Required. The system for the code to be translated.
4904
4949
  # @param [String] fields
4905
4950
  # Selector specifying which fields to include in a partial response.
4906
4951
  # @param [String] quota_user
@@ -4990,7 +5035,7 @@ module Google
4990
5035
  # the request cannot be mapped to a valid API method on a FHIR store, a generic
4991
5036
  # GCP error might be returned instead.
4992
5037
  # @param [String] parent
4993
- # Name of the FHIR store to retrieve resources from.
5038
+ # Required. Name of the FHIR store to retrieve resources from.
4994
5039
  # @param [String] fields
4995
5040
  # Selector specifying which fields to include in a partial response.
4996
5041
  # @param [String] quota_user
@@ -5089,7 +5134,7 @@ module Google
5089
5134
  # cloud.google.com/healthcare/docs/how-tos/fhir-resources#
5090
5135
  # getting_all_patient_compartment_resources).
5091
5136
  # @param [String] name
5092
- # Name of the `Patient` resource for which the information is required.
5137
+ # Required. Name of the `Patient` resource for which the information is required.
5093
5138
  # @param [Fixnum] _count
5094
5139
  # Maximum number of resources in a page. If not specified, 100 is used. May not
5095
5140
  # be larger than 1000.
@@ -5223,7 +5268,7 @@ module Google
5223
5268
  # healthcare/docs/how-tos/fhir-resources#
5224
5269
  # deleting_historical_versions_of_a_fhir_resource).
5225
5270
  # @param [String] name
5226
- # The name of the resource to purge.
5271
+ # Required. The name of the resource to purge.
5227
5272
  # @param [String] fields
5228
5273
  # Selector specifying which fields to include in a partial response.
5229
5274
  # @param [String] quota_user
@@ -5266,18 +5311,20 @@ module Google
5266
5311
  # reason for the error. If the request cannot be mapped to a valid API method on
5267
5312
  # a FHIR store, a generic GCP error might be returned instead.
5268
5313
  # @param [String] parent
5269
- # The name of the FHIR store that holds the profiles being used for validation.
5314
+ # Required. The name of the FHIR store that holds the profiles being used for
5315
+ # validation.
5270
5316
  # @param [String] type
5271
- # The FHIR resource type of the resource being validated. For a complete list,
5272
- # see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/
5273
- # DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/
5274
- # resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/
5275
- # resourcelist.html)). Must match the resource type in the provided content.
5317
+ # Required. The FHIR resource type of the resource being validated. For a
5318
+ # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
5319
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
5320
+ # standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/
5321
+ # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
5322
+ # provided content.
5276
5323
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
5277
5324
  # @param [String] profile
5278
- # The canonical URL of a profile that this resource should be validated against.
5279
- # For example, to validate a Patient resource against the US Core Patient
5280
- # profile this parameter would be `http://hl7.org/fhir/us/core/
5325
+ # Required. The canonical URL of a profile that this resource should be
5326
+ # validated against. For example, to validate a Patient resource against the US
5327
+ # Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/
5281
5328
  # StructureDefinition/us-core-patient`. A StructureDefinition with this
5282
5329
  # canonical URL must exist in the FHIR store.
5283
5330
  # @param [String] fields
@@ -5323,7 +5370,7 @@ module Google
5323
5370
  # conformance) in the DSTU2 case. On success, the response body contains a JSON-
5324
5371
  # encoded representation of a `CapabilityStatement` resource.
5325
5372
  # @param [String] name
5326
- # Name of the FHIR store to retrieve the capabilities for.
5373
+ # Required. Name of the FHIR store to retrieve the capabilities for.
5327
5374
  # @param [String] fields
5328
5375
  # Selector specifying which fields to include in a partial response.
5329
5376
  # @param [String] quota_user
@@ -5373,13 +5420,13 @@ module Google
5373
5420
  # resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
5374
5421
  # conditionally_deleting_a_fhir_resource).
5375
5422
  # @param [String] parent
5376
- # The name of the FHIR store this resource belongs to.
5423
+ # Required. The name of the FHIR store this resource belongs to.
5377
5424
  # @param [String] type
5378
- # The FHIR resource type to delete, such as Patient or Observation. For a
5379
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
5380
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
5381
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
5382
- # standards/fhir/R4/resourcelist.html)).
5425
+ # Required. The FHIR resource type to delete, such as Patient or Observation.
5426
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
5427
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
5428
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
5429
+ # implement/standards/fhir/R4/resourcelist.html)).
5383
5430
  # @param [String] fields
5384
5431
  # Selector specifying which fields to include in a partial response.
5385
5432
  # @param [String] quota_user
@@ -5431,13 +5478,13 @@ module Google
5431
5478
  # a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
5432
5479
  # resources#conditionally_patching_a_fhir_resource).
5433
5480
  # @param [String] parent
5434
- # The name of the FHIR store this resource belongs to.
5481
+ # Required. The name of the FHIR store this resource belongs to.
5435
5482
  # @param [String] type
5436
- # The FHIR resource type to update, such as Patient or Observation. For a
5437
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
5438
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
5439
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
5440
- # standards/fhir/R4/resourcelist.html)).
5483
+ # Required. The FHIR resource type to update, such as Patient or Observation.
5484
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
5485
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
5486
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
5487
+ # implement/standards/fhir/R4/resourcelist.html)).
5441
5488
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
5442
5489
  # @param [String] fields
5443
5490
  # Selector specifying which fields to include in a partial response.
@@ -5499,14 +5546,14 @@ module Google
5499
5546
  # google.com/healthcare/docs/how-tos/fhir-resources#
5500
5547
  # conditionally_updating_a_fhir_resource).
5501
5548
  # @param [String] parent
5502
- # The name of the FHIR store this resource belongs to.
5549
+ # Required. The name of the FHIR store this resource belongs to.
5503
5550
  # @param [String] type
5504
- # The FHIR resource type to update, such as Patient or Observation. For a
5505
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
5506
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
5507
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
5508
- # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
5509
- # provided content.
5551
+ # Required. The FHIR resource type to update, such as Patient or Observation.
5552
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
5553
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
5554
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
5555
+ # implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
5556
+ # in the provided content.
5510
5557
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
5511
5558
  # @param [String] fields
5512
5559
  # Selector specifying which fields to include in a partial response.
@@ -5559,14 +5606,14 @@ module Google
5559
5606
  # how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/
5560
5607
  # healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).
5561
5608
  # @param [String] parent
5562
- # The name of the FHIR store this resource belongs to.
5609
+ # Required. The name of the FHIR store this resource belongs to.
5563
5610
  # @param [String] type
5564
- # The FHIR resource type to create, such as Patient or Observation. For a
5565
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
5566
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
5567
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
5568
- # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
5569
- # provided content.
5611
+ # Required. The FHIR resource type to create, such as Patient or Observation.
5612
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
5613
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
5614
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
5615
+ # implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
5616
+ # in the provided content.
5570
5617
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
5571
5618
  # @param [String] fields
5572
5619
  # Selector specifying which fields to include in a partial response.
@@ -5609,7 +5656,7 @@ module Google
5609
5656
  # a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
5610
5657
  # resources#deleting_a_fhir_resource).
5611
5658
  # @param [String] name
5612
- # The name of the resource to delete.
5659
+ # Required. The name of the resource to delete.
5613
5660
  # @param [String] fields
5614
5661
  # Selector specifying which fields to include in a partial response.
5615
5662
  # @param [String] quota_user
@@ -5671,7 +5718,7 @@ module Google
5671
5718
  # using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-
5672
5719
  # bundles).
5673
5720
  # @param [String] parent
5674
- # Name of the FHIR store in which this bundle will be executed.
5721
+ # Required. Name of the FHIR store in which this bundle will be executed.
5675
5722
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
5676
5723
  # @param [String] fields
5677
5724
  # Selector specifying which fields to include in a partial response.
@@ -5717,7 +5764,7 @@ module Google
5717
5764
  # resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
5718
5765
  # resources#listing_fhir_resource_versions).
5719
5766
  # @param [String] name
5720
- # The name of the resource to retrieve.
5767
+ # Required. The name of the resource to retrieve.
5721
5768
  # @param [String] _at
5722
5769
  # Only include resource versions that were current at some point during the time
5723
5770
  # period specified in the date time value. The date parameter format is yyyy-mm-
@@ -5785,7 +5832,7 @@ module Google
5785
5832
  # resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
5786
5833
  # patching_a_fhir_resource).
5787
5834
  # @param [String] name
5788
- # The name of the resource to update.
5835
+ # Required. The name of the resource to update.
5789
5836
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
5790
5837
  # @param [String] fields
5791
5838
  # Selector specifying which fields to include in a partial response.
@@ -5833,7 +5880,7 @@ module Google
5833
5880
  # Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
5834
5881
  # resources#getting_a_fhir_resource).
5835
5882
  # @param [String] name
5836
- # The name of the resource to retrieve.
5883
+ # Required. The name of the resource to retrieve.
5837
5884
  # @param [String] fields
5838
5885
  # Selector specifying which fields to include in a partial response.
5839
5886
  # @param [String] quota_user
@@ -5924,7 +5971,7 @@ module Google
5924
5971
  # fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
5925
5972
  # healthcare/docs/how-tos/fhir-advanced-search).
5926
5973
  # @param [String] parent
5927
- # Name of the FHIR store to retrieve resources from.
5974
+ # Required. Name of the FHIR store to retrieve resources from.
5928
5975
  # @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
5929
5976
  # @param [String] fields
5930
5977
  # Selector specifying which fields to include in a partial response.
@@ -6018,13 +6065,13 @@ module Google
6018
6065
  # fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
6019
6066
  # healthcare/docs/how-tos/fhir-advanced-search).
6020
6067
  # @param [String] parent
6021
- # Name of the FHIR store to retrieve resources from.
6068
+ # Required. Name of the FHIR store to retrieve resources from.
6022
6069
  # @param [String] resource_type
6023
- # The FHIR resource type to search, such as Patient or Observation. For a
6024
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
6025
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
6026
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
6027
- # standards/fhir/R4/resourcelist.html)).
6070
+ # Required. The FHIR resource type to search, such as Patient or Observation.
6071
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
6072
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
6073
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
6074
+ # implement/standards/fhir/R4/resourcelist.html)).
6028
6075
  # @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object
6029
6076
  # @param [String] fields
6030
6077
  # Selector specifying which fields to include in a partial response.
@@ -6078,7 +6125,7 @@ module Google
6078
6125
  # resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
6079
6126
  # updating_a_fhir_resource).
6080
6127
  # @param [String] name
6081
- # The name of the resource to update.
6128
+ # Required. The name of the resource to update.
6082
6129
  # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object
6083
6130
  # @param [String] fields
6084
6131
  # Selector specifying which fields to include in a partial response.
@@ -6122,7 +6169,7 @@ module Google
6122
6169
  # (https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
6123
6170
  # retrieving_a_fhir_resource_version).
6124
6171
  # @param [String] name
6125
- # The name of the resource version to retrieve.
6172
+ # Required. The name of the resource version to retrieve.
6126
6173
  # @param [String] fields
6127
6174
  # Selector specifying which fields to include in a partial response.
6128
6175
  # @param [String] quota_user
@@ -6152,11 +6199,11 @@ module Google
6152
6199
 
6153
6200
  # Creates a new HL7v2 store within the parent dataset.
6154
6201
  # @param [String] parent
6155
- # The name of the dataset this HL7v2 store belongs to.
6202
+ # Required. The name of the dataset this HL7v2 store belongs to.
6156
6203
  # @param [Google::Apis::HealthcareV1beta1::Hl7V2Store] hl7_v2_store_object
6157
6204
  # @param [String] hl7_v2_store_id
6158
- # The ID of the HL7v2 store that is being created. The string must match the
6159
- # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
6205
+ # Required. The ID of the HL7v2 store that is being created. The string must
6206
+ # match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
6160
6207
  # @param [String] fields
6161
6208
  # Selector specifying which fields to include in a partial response.
6162
6209
  # @param [String] quota_user
@@ -6189,7 +6236,7 @@ module Google
6189
6236
 
6190
6237
  # Deletes the specified HL7v2 store and removes all messages that it contains.
6191
6238
  # @param [String] name
6192
- # The resource name of the HL7v2 store to delete.
6239
+ # Required. The resource name of the HL7v2 store to delete.
6193
6240
  # @param [String] fields
6194
6241
  # Selector specifying which fields to include in a partial response.
6195
6242
  # @param [String] quota_user
@@ -6225,8 +6272,9 @@ module Google
6225
6272
  # response of type ExportMessagesResponse is returned in the response field. The
6226
6273
  # metadata field type for this operation is OperationMetadata.
6227
6274
  # @param [String] name
6228
- # The name of the source HL7v2 store, in the format `projects/`project_id`/
6229
- # locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
6275
+ # Required. The name of the source HL7v2 store, in the format `projects/`
6276
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`
6277
+ # hl7v2_store_id``
6230
6278
  # @param [Google::Apis::HealthcareV1beta1::ExportMessagesRequest] export_messages_request_object
6231
6279
  # @param [String] fields
6232
6280
  # Selector specifying which fields to include in a partial response.
@@ -6259,7 +6307,7 @@ module Google
6259
6307
 
6260
6308
  # Gets the specified HL7v2 store.
6261
6309
  # @param [String] name
6262
- # The resource name of the HL7v2 store to get.
6310
+ # Required. The resource name of the HL7v2 store to get.
6263
6311
  # @param [String] fields
6264
6312
  # Selector specifying which fields to include in a partial response.
6265
6313
  # @param [String] quota_user
@@ -6289,8 +6337,8 @@ module Google
6289
6337
 
6290
6338
  # Gets metrics associated with the HL7v2 store.
6291
6339
  # @param [String] name
6292
- # The resource name of the HL7v2 store to get metrics for, in the format `
6293
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
6340
+ # Required. The resource name of the HL7v2 store to get metrics for, in the
6341
+ # format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
6294
6342
  # hl7V2Stores/`hl7v2_store_id``.
6295
6343
  # @param [String] fields
6296
6344
  # Selector specifying which fields to include in a partial response.
@@ -6389,8 +6437,9 @@ module Google
6389
6437
  # the response field. The metadata field type for this operation is
6390
6438
  # OperationMetadata.
6391
6439
  # @param [String] name
6392
- # The name of the target HL7v2 store, in the format `projects/`project_id`/
6393
- # locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id``
6440
+ # Required. The name of the target HL7v2 store, in the format `projects/`
6441
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`
6442
+ # hl7v2_store_id``
6394
6443
  # @param [Google::Apis::HealthcareV1beta1::ImportMessagesRequest] import_messages_request_object
6395
6444
  # @param [String] fields
6396
6445
  # Selector specifying which fields to include in a partial response.
@@ -6423,7 +6472,7 @@ module Google
6423
6472
 
6424
6473
  # Lists the HL7v2 stores in the given dataset.
6425
6474
  # @param [String] parent
6426
- # Name of the dataset.
6475
+ # Required. Name of the dataset.
6427
6476
  # @param [String] filter
6428
6477
  # Restricts stores returned to those matching a filter. The following syntax is
6429
6478
  # available: * A string field value can be written as text inside quotation
@@ -6484,13 +6533,14 @@ module Google
6484
6533
 
6485
6534
  # Updates the HL7v2 store.
6486
6535
  # @param [String] name
6487
- # Resource name of the HL7v2 store, of the form `projects/`project_id`/locations/
6488
- # `location_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``.
6536
+ # Identifier. Resource name of the HL7v2 store, of the form `projects/`
6537
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/hl7V2Stores/`
6538
+ # hl7v2_store_id``.
6489
6539
  # @param [Google::Apis::HealthcareV1beta1::Hl7V2Store] hl7_v2_store_object
6490
6540
  # @param [String] update_mask
6491
- # The update mask applies to the resource. For the `FieldMask` definition, see
6492
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
6493
- # fieldmask
6541
+ # Required. The update mask applies to the resource. For the `FieldMask`
6542
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
6543
+ # google.protobuf#fieldmask
6494
6544
  # @param [String] fields
6495
6545
  # Selector specifying which fields to include in a partial response.
6496
6546
  # @param [String] quota_user
@@ -6599,9 +6649,9 @@ module Google
6599
6649
 
6600
6650
  # Gets multiple messages in the given HL7v2 store.
6601
6651
  # @param [String] parent
6602
- # Name of the HL7v2 store to retrieve messages from, in the format: `projects/`
6603
- # project_id`/locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`
6604
- # hl7v2_store_id``.
6652
+ # Required. Name of the HL7v2 store to retrieve messages from, in the format: `
6653
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
6654
+ # hl7v2Stores/`hl7v2_store_id``.
6605
6655
  # @param [Array<String>, String] ids
6606
6656
  # The resource id of the HL7v2 messages to retrieve in the format: ``message_id``
6607
6657
  # , where the full resource name is ``parent`/messages/`message_id`` A maximum
@@ -6644,7 +6694,7 @@ module Google
6644
6694
  # adapter is configured to listen to a Pub/Sub topic, the adapter transmits the
6645
6695
  # message when a notification is received.
6646
6696
  # @param [String] parent
6647
- # The name of the HL7v2 store this message belongs to.
6697
+ # Required. The name of the HL7v2 store this message belongs to.
6648
6698
  # @param [Google::Apis::HealthcareV1beta1::CreateMessageRequest] create_message_request_object
6649
6699
  # @param [String] fields
6650
6700
  # Selector specifying which fields to include in a partial response.
@@ -6677,7 +6727,7 @@ module Google
6677
6727
 
6678
6728
  # Deletes an HL7v2 message.
6679
6729
  # @param [String] name
6680
- # The resource name of the HL7v2 message to delete.
6730
+ # Required. The resource name of the HL7v2 message to delete.
6681
6731
  # @param [String] fields
6682
6732
  # Selector specifying which fields to include in a partial response.
6683
6733
  # @param [String] quota_user
@@ -6707,7 +6757,7 @@ module Google
6707
6757
 
6708
6758
  # Gets an HL7v2 message.
6709
6759
  # @param [String] name
6710
- # The resource name of the HL7v2 message to retrieve.
6760
+ # Required. The resource name of the HL7v2 message to retrieve.
6711
6761
  # @param [String] view
6712
6762
  # Specifies which parts of the Message resource to return in the response. When
6713
6763
  # unspecified, equivalent to FULL.
@@ -6749,7 +6799,7 @@ module Google
6749
6799
  # message. This behavior is suitable for replying to HL7v2 interface systems
6750
6800
  # that expect these acknowledgments.
6751
6801
  # @param [String] parent
6752
- # The name of the HL7v2 store this message belongs to.
6802
+ # Required. The name of the HL7v2 store this message belongs to.
6753
6803
  # @param [Google::Apis::HealthcareV1beta1::IngestMessageRequest] ingest_message_request_object
6754
6804
  # @param [String] fields
6755
6805
  # Selector specifying which fields to include in a partial response.
@@ -6785,7 +6835,7 @@ module Google
6785
6835
  # delay between the time a message is created and when it can be found through a
6786
6836
  # filter.
6787
6837
  # @param [String] parent
6788
- # Name of the HL7v2 store to retrieve messages from.
6838
+ # Required. Name of the HL7v2 store to retrieve messages from.
6789
6839
  # @param [String] filter
6790
6840
  # Restricts messages returned to those matching a filter. The following syntax
6791
6841
  # is available: * A string field value can be written as text inside quotation
@@ -6876,14 +6926,14 @@ module Google
6876
6926
  # are merged with the existing set of labels. Existing labels with the same keys
6877
6927
  # are updated.
6878
6928
  # @param [String] name
6879
- # Resource name of the Message, of the form `projects/`project_id`/locations/`
6880
- # location_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/messages/`
6881
- # message_id``. Assigned by the server.
6929
+ # Output only. Resource name of the Message, of the form `projects/`project_id`/
6930
+ # locations/`location_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/
6931
+ # messages/`message_id``. Assigned by the server.
6882
6932
  # @param [Google::Apis::HealthcareV1beta1::Message] message_object
6883
6933
  # @param [String] update_mask
6884
- # The update mask applies to the resource. For the `FieldMask` definition, see
6885
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
6886
- # fieldmask
6934
+ # Required. The update mask applies to the resource. For the `FieldMask`
6935
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
6936
+ # google.protobuf#fieldmask
6887
6937
  # @param [String] fields
6888
6938
  # Selector specifying which fields to include in a partial response.
6889
6939
  # @param [String] quota_user