lib/google/apis/healthcare_v1/service.rb in google-apis-healthcare_v1-0.53.0 vs lib/google/apis/healthcare_v1/service.rb in google-apis-healthcare_v1-0.54.0
- old
+ new
@@ -172,12 +172,12 @@
# resources. Failed resource totals are tracked in Operation.metadata. Error
# details are also logged to Cloud Logging. For more information, see [Viewing
# error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
# logging).
# @param [String] source_dataset
- # Source dataset resource name. For example, `projects/`project_id`/locations/`
- # location_id`/datasets/`dataset_id``.
+ # Required. Source dataset resource name. For example, `projects/`project_id`/
+ # locations/`location_id`/datasets/`dataset_id``.
# @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -1044,14 +1044,14 @@
execute_or_queue_command(command, &block)
end
# Updates the specified Attribute definition.
# @param [String] name
- # Resource name of the Attribute definition, of the form `projects/`project_id`/
- # locations/`location_id`/datasets/`dataset_id`/consentStores/`consent_store_id`/
- # attributeDefinitions/`attribute_definition_id``. Cannot be changed after
- # creation.
+ # Identifier. Resource name of the Attribute definition, of the form `projects/`
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/consentStores/`
+ # consent_store_id`/attributeDefinitions/`attribute_definition_id``. Cannot be
+ # changed after creation.
# @param [Google::Apis::HealthcareV1::AttributeDefinition] attribute_definition_object
# @param [String] update_mask
# Required. The update mask that applies to the resource. For the `FieldMask`
# definition, see https://developers.google.com/protocol-buffers/docs/reference/
# google.protobuf#fieldmask. Only the `description`, `allowed_values`, `
@@ -1909,15 +1909,15 @@
execute_or_queue_command(command, &block)
end
# Creates a new DICOM store within the parent dataset.
# @param [String] parent
- # The name of the dataset this DICOM store belongs to.
+ # Required. The name of the dataset this DICOM store belongs to.
# @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object
# @param [String] dicom_store_id
- # The ID of the DICOM store that is being created. Any string value up to 256
- # characters in length.
+ # Required. The ID of the DICOM store that is being created. Any string value up
+ # to 256 characters in length.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -1954,12 +1954,12 @@
# contain these failed resources. Failed resource totals are tracked in
# Operation.metadata. Error details are also logged to Cloud Logging (see [
# Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/
# how-tos/logging)).
# @param [String] source_store
- # Source DICOM store resource name. For example, `projects/`project_id`/
- # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
+ # Required. Source DICOM store resource name. For example, `projects/`project_id`
+ # /locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
# @param [Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -1989,11 +1989,11 @@
end
# Deletes the specified DICOM store and removes all images that are contained
# within it.
# @param [String] name
- # The resource name of the DICOM store to delete.
+ # Required. The resource name of the DICOM store to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2022,12 +2022,12 @@
# Exports data to the specified destination by copying it from the DICOM store.
# Errors are also logged to Cloud Logging. For more information, see [Viewing
# error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
# logging). The metadata field type is OperationMetadata.
# @param [String] name
- # The DICOM store resource name from which to export the data. For example, `
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # Required. The DICOM store resource name from which to export the data. For
+ # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
# dicomStores/`dicom_store_id``.
# @param [Google::Apis::HealthcareV1::ExportDicomDataRequest] export_dicom_data_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -2057,11 +2057,11 @@
execute_or_queue_command(command, &block)
end
# Gets the specified DICOM store.
# @param [String] name
- # The resource name of the DICOM store to get.
+ # Required. The resource name of the DICOM store to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2087,11 +2087,11 @@
execute_or_queue_command(command, &block)
end
# Gets metrics associated with the DICOM store.
# @param [String] name
- # The resource name of the DICOM store to get metrics for.
+ # Required. The resource name of the DICOM store to get metrics for.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2165,13 +2165,13 @@
# Imports data into the DICOM store by copying it from the specified source.
# Errors are logged to Cloud Logging. For more information, see [Viewing error
# logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/
# logging). The metadata field type is OperationMetadata.
# @param [String] name
- # The name of the DICOM store resource into which the data is imported. For
- # example, `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
- # dicomStores/`dicom_store_id``.
+ # Required. The name of the DICOM store resource into which the data is imported.
+ # For example, `projects/`project_id`/locations/`location_id`/datasets/`
+ # dataset_id`/dicomStores/`dicom_store_id``.
# @param [Google::Apis::HealthcareV1::ImportDicomDataRequest] import_dicom_data_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -2200,11 +2200,11 @@
execute_or_queue_command(command, &block)
end
# Lists the DICOM stores in the given dataset.
# @param [String] parent
- # Name of the dataset.
+ # Required. Name of the dataset.
# @param [String] filter
# Restricts stores returned to those matching a filter. The following syntax is
# available: * A string field value can be written as text inside quotation
# marks, for example `"query text"`. The only valid relational operation for
# text fields is equality (`=`), where text is searched within the field, rather
@@ -2261,17 +2261,18 @@
execute_or_queue_command(command, &block)
end
# Updates the specified DICOM store.
# @param [String] name
- # Resource name of the DICOM store, of the form `projects/`project_id`/locations/
- # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``.
+ # Identifier. Resource name of the DICOM store, of the form `projects/`
+ # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
+ # dicom_store_id``.
# @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object
# @param [String] update_mask
- # The update mask applies to the resource. For the `FieldMask` definition, see
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
- # fieldmask
+ # Required. The update mask applies to the resource. For the `FieldMask`
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
+ # google.protobuf#fieldmask
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2306,17 +2307,17 @@
# Search transaction](https://cloud.google.com/healthcare/docs/dicom#
# search_transaction) in the Cloud Healthcare API conformance statement. For
# samples that show how to call SearchForInstances, see [Search for DICOM data](
# https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the SearchForInstancesRequest DICOMweb request. For example, `
- # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
- # .
+ # Required. The path of the SearchForInstancesRequest DICOMweb request. For
+ # example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
+ # instances`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2349,16 +2350,16 @@
# (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the
# Cloud Healthcare API conformance statement. For samples that show how to call
# SearchForSeries, see [Search for DICOM data](https://cloud.google.com/
# healthcare/docs/how-tos/dicomweb#search-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the SearchForSeries DICOMweb request. For example, `series` or `
- # studies/`study_uid`/series`.
+ # Required. The path of the SearchForSeries DICOMweb request. For example, `
+ # series` or `studies/`study_uid`/series`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2391,15 +2392,16 @@
# transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction)
# in the Cloud Healthcare API conformance statement. For samples that show how
# to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/
# healthcare/docs/how-tos/dicomweb#search-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the SearchForStudies DICOMweb request. For example, `studies`.
+ # Required. The path of the SearchForStudies DICOMweb request. For example, `
+ # studies`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2470,16 +2472,16 @@
# com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API
# conformance statement. For samples that show how to call StoreInstances, see [
# Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
# store-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the StoreInstances DICOMweb request. For example, `studies/[`
- # study_uid`]`. Note that the `study_uid` is optional.
+ # Required. The path of the StoreInstances DICOMweb request. For example, `
+ # studies/[`study_uid`]`. Note that the `study_uid` is optional.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -2548,13 +2550,13 @@
execute_or_queue_command(command, &block)
end
# GetStudyMetrics returns metrics for a study.
# @param [String] study
- # The study resource path. For example, `projects/`project_id`/locations/`
- # location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
- # studies/`study_uid``.
+ # Required. The study resource path. For example, `projects/`project_id`/
+ # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
+ # dicomWeb/studies/`study_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2580,13 +2582,13 @@
execute_or_queue_command(command, &block)
end
# GetSeriesMetrics returns metrics for a series.
# @param [String] series
- # The series resource path. For example, `projects/`project_id`/locations/`
- # location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/dicomWeb/
- # studies/`study_uid`/series/`series_uid``.
+ # Required. The series resource path. For example, `projects/`project_id`/
+ # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id`/
+ # dicomWeb/studies/`study_uid`/series/`series_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2619,11 +2621,12 @@
# deleted by an operation until the operation completes. For samples that show
# how to call DeleteStudy, see [Delete a study, series, or instance](https://
# cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).
# @param [String] parent
# @param [String] dicom_web_path
- # The path of the DeleteStudy request. For example, `studies/`study_uid``.
+ # Required. The path of the DeleteStudy request. For example, `studies/`
+ # study_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2657,16 +2660,16 @@
# resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources)
# in the Cloud Healthcare API conformance statement. For samples that show how
# to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.
# com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/`
- # study_uid`/metadata`.
+ # Required. The path of the RetrieveStudyMetadata DICOMweb request. For example,
+ # `studies/`study_uid`/metadata`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2700,16 +2703,16 @@
# dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance
# statement. For samples that show how to call RetrieveStudy, see [Retrieve
# DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-
# dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveStudy DICOMweb request. For example, `studies/`
- # study_uid``.
+ # Required. The path of the RetrieveStudy DICOMweb request. For example, `
+ # studies/`study_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2742,17 +2745,17 @@
# Search transaction](https://cloud.google.com/healthcare/docs/dicom#
# search_transaction) in the Cloud Healthcare API conformance statement. For
# samples that show how to call SearchForInstances, see [Search for DICOM data](
# https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the SearchForInstancesRequest DICOMweb request. For example, `
- # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
- # .
+ # Required. The path of the SearchForInstancesRequest DICOMweb request. For
+ # example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
+ # instances`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2785,16 +2788,16 @@
# (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the
# Cloud Healthcare API conformance statement. For samples that show how to call
# SearchForSeries, see [Search for DICOM data](https://cloud.google.com/
# healthcare/docs/how-tos/dicomweb#search-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the SearchForSeries DICOMweb request. For example, `series` or `
- # studies/`study_uid`/series`.
+ # Required. The path of the SearchForSeries DICOMweb request. For example, `
+ # series` or `studies/`study_uid`/series`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2828,16 +2831,16 @@
# com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API
# conformance statement. For samples that show how to call StoreInstances, see [
# Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
# store-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the StoreInstances DICOMweb request. For example, `studies/[`
- # study_uid`]`. Note that the `study_uid` is optional.
+ # Required. The path of the StoreInstances DICOMweb request. For example, `
+ # studies/[`study_uid`]`. Note that the `study_uid` is optional.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -2874,16 +2877,16 @@
# series that is being deleted by an operation until the operation completes.
# For samples that show how to call DeleteSeries, see [Delete a study, series,
# or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-
# dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the DeleteSeries request. For example, `studies/`study_uid`/series/
- # `series_uid``.
+ # Required. The path of the DeleteSeries request. For example, `studies/`
+ # study_uid`/series/`series_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2918,16 +2921,16 @@
# healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API
# conformance statement. For samples that show how to call
# RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/
# healthcare/docs/how-tos/dicomweb#retrieve-metadata).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/
- # `study_uid`/series/`series_uid`/metadata`.
+ # Required. The path of the RetrieveSeriesMetadata DICOMweb request. For example,
+ # `studies/`study_uid`/series/`series_uid`/metadata`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -2961,16 +2964,16 @@
# dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance
# statement. For samples that show how to call RetrieveSeries, see [Retrieve
# DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-
# dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveSeries DICOMweb request. For example, `studies/`
- # study_uid`/series/`series_uid``.
+ # Required. The path of the RetrieveSeries DICOMweb request. For example, `
+ # studies/`study_uid`/series/`series_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3003,17 +3006,17 @@
# Search transaction](https://cloud.google.com/healthcare/docs/dicom#
# search_transaction) in the Cloud Healthcare API conformance statement. For
# samples that show how to call SearchForInstances, see [Search for DICOM data](
# https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the SearchForInstancesRequest DICOMweb request. For example, `
- # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances`
- # .
+ # Required. The path of the SearchForInstancesRequest DICOMweb request. For
+ # example, `instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/
+ # instances`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3046,16 +3049,16 @@
# take a few seconds to be updated after an instance is deleted using
# DeleteInstance. For samples that show how to call DeleteInstance, see [Delete
# a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/
# dicomweb#delete-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the DeleteInstance request. For example, `studies/`study_uid`/
- # series/`series_uid`/instances/`instance_uid``.
+ # Required. The path of the DeleteInstance request. For example, `studies/`
+ # study_uid`/series/`series_uid`/instances/`instance_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3090,16 +3093,16 @@
# instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in
# the Cloud Healthcare API conformance statement. For samples that show how to
# call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/
# healthcare/docs/how-tos/dicomweb#retrieve-instance).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveInstance DICOMweb request. For example, `studies/`
- # study_uid`/series/`series_uid`/instances/`instance_uid``.
+ # Required. The path of the RetrieveInstance DICOMweb request. For example, `
+ # studies/`study_uid`/series/`series_uid`/instances/`instance_uid``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3134,16 +3137,17 @@
# healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API
# conformance statement. For samples that show how to call
# RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/
# healthcare/docs/how-tos/dicomweb#retrieve-metadata).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveInstanceMetadata DICOMweb request. For example, `
- # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`.
+ # Required. The path of the RetrieveInstanceMetadata DICOMweb request. For
+ # example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
+ # metadata`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3178,16 +3182,17 @@
# healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API
# conformance statement. For samples that show how to call
# RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.
# google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveRenderedInstance DICOMweb request. For example, `
- # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`.
+ # Required. The path of the RetrieveRenderedInstance DICOMweb request. For
+ # example, `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/
+ # rendered`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3221,16 +3226,17 @@
# com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API
# conformance statement. For samples that show how to call RetrieveFrames, see [
# Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#
# retrieve-dicom).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveFrames DICOMweb request. For example, `studies/`
- # study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list``.
+ # Required. The path of the RetrieveFrames DICOMweb request. For example, `
+ # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
+ # frame_list``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3265,17 +3271,17 @@
# healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API
# conformance statement. For samples that show how to call
# RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.
# google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).
# @param [String] parent
- # The name of the DICOM store that is being accessed. For example, `projects/`
- # project_id`/locations/`location_id`/datasets/`dataset_id`/dicomStores/`
- # dicom_store_id``.
+ # Required. The name of the DICOM store that is being accessed. For example, `
+ # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # dicomStores/`dicom_store_id``.
# @param [String] dicom_web_path
- # The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/
- # `study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list`/
- # rendered`.
+ # Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,
+ # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`
+ # frame_list`/rendered`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3302,15 +3308,15 @@
execute_or_queue_command(command, &block)
end
# Creates a new FHIR store within the parent dataset.
# @param [String] parent
- # The name of the dataset this FHIR store belongs to.
+ # Required. The name of the dataset this FHIR store belongs to.
# @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object
# @param [String] fhir_store_id
- # The ID of the FHIR store that is being created. The string must match the
- # following regex: `[\p`L`\p`N`_\-\.]`1,256``.
+ # Required. The ID of the FHIR store that is being created. The string must
+ # match the following regex: `[\p`L`\p`N`_\-\.]`1,256``.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3344,12 +3350,12 @@
# successful, the response field type is DeidentifyFhirStoreSummary. If errors
# occur, error is set. Error details are also logged to Cloud Logging (see [
# Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/
# how-tos/logging)).
# @param [String] source_store
- # Source FHIR store resource name. For example, `projects/`project_id`/locations/
- # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
+ # Required. Source FHIR store resource name. For example, `projects/`project_id`/
+ # locations/`location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
# @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -3378,11 +3384,11 @@
execute_or_queue_command(command, &block)
end
# Deletes the specified FHIR store and removes all resources within it.
# @param [String] name
- # The resource name of the FHIR store to delete.
+ # Required. The resource name of the FHIR store to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3415,13 +3421,13 @@
# https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
# the operation finishes, a detailed response of type ExportResourcesResponse is
# returned in the response field. The metadata field type for this operation is
# OperationMetadata.
# @param [String] name
- # The name of the FHIR store to export resource from, in the format of `projects/
- # `project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/`
- # fhir_store_id``.
+ # Required. The name of the FHIR store to export resource from, in the format of
+ # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # fhirStores/`fhir_store_id``.
# @param [Google::Apis::HealthcareV1::ExportResourcesRequest] export_resources_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -3450,11 +3456,11 @@
execute_or_queue_command(command, &block)
end
# Gets the configuration of the specified FHIR store.
# @param [String] name
- # The resource name of the FHIR store to get.
+ # Required. The resource name of the FHIR store to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3480,11 +3486,11 @@
execute_or_queue_command(command, &block)
end
# Gets metrics associated with the FHIR store.
# @param [String] name
- # The resource name of the FHIR store to get metrics for.
+ # Required. The resource name of the FHIR store to get metrics for.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3607,13 +3613,13 @@
# Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
# Otherwise, when the operation finishes, a detailed response of type
# ImportResourcesResponse is returned in the response field. The metadata field
# type for this operation is OperationMetadata.
# @param [String] name
- # The name of the FHIR store to import FHIR resources to, in the format of `
- # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/
- # `fhir_store_id``.
+ # Required. The name of the FHIR store to import FHIR resources to, in the
+ # format of `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/
+ # fhirStores/`fhir_store_id``.
# @param [Google::Apis::HealthcareV1::ImportResourcesRequest] import_resources_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -3642,11 +3648,11 @@
execute_or_queue_command(command, &block)
end
# Lists the FHIR stores in the given dataset.
# @param [String] parent
- # Name of the dataset.
+ # Required. Name of the dataset.
# @param [String] filter
# Restricts stores returned to those matching a filter. The following syntax is
# available: * A string field value can be written as text inside quotation
# marks, for example `"query text"`. The only valid relational operation for
# text fields is equality (`=`), where text is searched within the field, rather
@@ -3703,17 +3709,17 @@
execute_or_queue_command(command, &block)
end
# Updates the configuration of the specified FHIR store.
# @param [String] name
- # Output only. Resource name of the FHIR store, of the form `projects/`
- # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
+ # Output only. Identifier. Resource name of the FHIR store, of the form `
+ # projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``.
# @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object
# @param [String] update_mask
- # The update mask applies to the resource. For the `FieldMask` definition, see
- # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
- # fieldmask
+ # Required. The update mask applies to the resource. For the `FieldMask`
+ # definition, see https://developers.google.com/protocol-buffers/docs/reference/
+ # google.protobuf#fieldmask
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3740,10 +3746,52 @@
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
+ # Rolls back resources from the FHIR store to the specified time. This method
+ # returns an Operation that can be used to track the status of the rollback by
+ # calling GetOperation. Immediate fatal errors appear in the error field, errors
+ # are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](
+ # https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when
+ # the operation finishes, a detailed response of type
+ # RollbackFhirResourcesResponse is returned in the response field. The metadata
+ # field type for this operation is OperationMetadata.
+ # @param [String] name
+ # Required. The name of the FHIR store to rollback, in the format of "projects/`
+ # project_id`/locations/`location_id`/datasets/`dataset_id` /fhirStores/`
+ # fhir_store_id`".
+ # @param [Google::Apis::HealthcareV1::RollbackFhirResourcesRequest] rollback_fhir_resources_request_object
+ # @param [String] fields
+ # Selector specifying which fields to include in a partial response.
+ # @param [String] quota_user
+ # Available to use for quota purposes for server-side applications. Can be any
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
+ # @param [Google::Apis::RequestOptions] options
+ # Request-specific options
+ #
+ # @yield [result, err] Result & error if block supplied
+ # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object
+ # @yieldparam err [StandardError] error object if request failed
+ #
+ # @return [Google::Apis::HealthcareV1::Operation]
+ #
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
+ def rollback_fhir_store_fhir_resources(name, rollback_fhir_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+ command = make_simple_command(:post, 'v1/{+name}:rollback', options)
+ command.request_representation = Google::Apis::HealthcareV1::RollbackFhirResourcesRequest::Representation
+ command.request_object = rollback_fhir_resources_request_object
+ command.response_representation = Google::Apis::HealthcareV1::Operation::Representation
+ command.response_class = Google::Apis::HealthcareV1::Operation
+ command.params['name'] = name unless name.nil?
+ command.query['fields'] = fields unless fields.nil?
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
+ execute_or_queue_command(command, &block)
+ end
+
# Sets the access control policy on the specified resource. Replaces any
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified. See [Resource
@@ -3839,38 +3887,39 @@
# types and referencing search parameters. For samples that show how to call `
# Patient-everything`, see [Getting all patient compartment resources](https://
# cloud.google.com/healthcare/docs/how-tos/fhir-resources#
# getting_all_patient_compartment_resources).
# @param [String] name
- # Name of the `Patient` resource for which the information is required.
+ # Required. Name of the `Patient` resource for which the information is required.
# @param [Fixnum] _count
- # Maximum number of resources in a page. If not specified, 100 is used. May not
- # be larger than 1000.
+ # Optional. Maximum number of resources in a page. If not specified, 100 is used.
+ # May not be larger than 1000.
# @param [String] _page_token
# Used to retrieve the next or previous page of results when using pagination.
# Set `_page_token` to the value of _page_token set in next or previous page
# links' url. Next and previous page are returned in the response bundle's links
# field, where `link.relation` is "previous" or "next". Omit `_page_token` if no
# previous request has been made.
# @param [String] _since
- # If provided, only resources updated after this time are returned. The time
- # uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:
- # 17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the
- # second and include a time zone.
+ # Optional. If provided, only resources updated after this time are returned.
+ # The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-
+ # 07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified
+ # to the second and include a time zone.
# @param [String] _type
- # String of comma-delimited FHIR resource types. If provided, only resources of
- # the specified resource type(s) are returned. Specifying multiple `_type`
- # parameters isn't supported. For example, the result of `_type=Observation&
- # _type=Encounter` is undefined. Use `_type=Observation,Encounter` instead.
+ # Optional. String of comma-delimited FHIR resource types. If provided, only
+ # resources of the specified resource type(s) are returned. Specifying multiple `
+ # _type` parameters isn't supported. For example, the result of `_type=
+ # Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter`
+ # instead.
# @param [String] end_
- # The response includes records prior to the end date. The date uses the format
- # YYYY-MM-DD. If no end date is provided, all records subsequent to the start
- # date are in scope.
+ # Optional. The response includes records prior to the end date. The date uses
+ # the format YYYY-MM-DD. If no end date is provided, all records subsequent to
+ # the start date are in scope.
# @param [String] start
- # The response includes records subsequent to the start date. The date uses the
- # format YYYY-MM-DD. If no start date is provided, all records prior to the end
- # date are in scope.
+ # Optional. The response includes records subsequent to the start date. The date
+ # uses the format YYYY-MM-DD. If no start date is provided, all records prior to
+ # the end date are in scope.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3908,11 +3957,11 @@
# standard operation. For samples that show how to call `Resource-purge`, see [
# Deleting historical versions of a FHIR resource](https://cloud.google.com/
# healthcare/docs/how-tos/fhir-resources#
# deleting_historical_versions_of_a_fhir_resource).
# @param [String] name
- # The name of the resource to purge.
+ # Required. The name of the resource to purge.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -3951,22 +4000,24 @@
# be found in the FHIR store then an error is returned. Errors generated by
# validation contain a JSON-encoded `OperationOutcome` resource describing the
# reason for the error. If the request cannot be mapped to a valid API method on
# a FHIR store, a generic GCP error might be returned instead.
# @param [String] parent
- # The name of the FHIR store that holds the profiles being used for validation.
+ # Required. The name of the FHIR store that holds the profiles being used for
+ # validation.
# @param [String] type
- # The FHIR resource type of the resource being validated. For a complete list,
- # see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/
- # DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/
- # resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/
- # resourcelist.html)). Must match the resource type in the provided content.
+ # Required. The FHIR resource type of the resource being validated. For a
+ # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
+ # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
+ # standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/
+ # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
+ # provided content.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] profile
- # The canonical URL of a profile that this resource should be validated against.
- # For example, to validate a Patient resource against the US Core Patient
- # profile this parameter would be `http://hl7.org/fhir/us/core/
+ # Required. The canonical URL of a profile that this resource should be
+ # validated against. For example, to validate a Patient resource against the US
+ # Core Patient profile this parameter would be `http://hl7.org/fhir/us/core/
# StructureDefinition/us-core-patient`. A StructureDefinition with this
# canonical URL must exist in the FHIR store.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -4008,11 +4059,11 @@
# implement/standards/fhir/R4/http.html#capabilities)), or the [conformance
# interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#
# conformance) in the DSTU2 case. On success, the response body contains a JSON-
# encoded representation of a `CapabilityStatement` resource.
# @param [String] name
- # Name of the FHIR store to retrieve the capabilities for.
+ # Required. Name of the FHIR store to retrieve the capabilities for.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -4049,17 +4100,17 @@
# retrieved through vread and related methods, unless they are removed by the
# purge method. For samples that show how to call `conditionalDelete`, see [
# Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/
# docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).
# @param [String] parent
- # The name of the FHIR store this resource belongs to.
+ # Required. The name of the FHIR store this resource belongs to.
# @param [String] type
- # The FHIR resource type to delete, such as Patient or Observation. For a
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
- # standards/fhir/R4/resourcelist.html)).
+ # Required. The FHIR resource type to delete, such as Patient or Observation.
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
+ # implement/standards/fhir/R4/resourcelist.html)).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -4104,17 +4155,17 @@
# a FHIR store, a generic GCP error might be returned instead. For samples that
# show how to call `conditionalPatch`, see [Conditionally patching a FHIR
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
# conditionally_patching_a_fhir_resource).
# @param [String] parent
- # The name of the FHIR store this resource belongs to.
+ # Required. The name of the FHIR store this resource belongs to.
# @param [String] type
- # The FHIR resource type to update, such as Patient or Observation. For a
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
- # standards/fhir/R4/resourcelist.html)).
+ # Required. The FHIR resource type to update, such as Patient or Observation.
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
+ # implement/standards/fhir/R4/resourcelist.html)).
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4169,18 +4220,18 @@
# might be returned instead. For samples that show how to call `
# conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.
# google.com/healthcare/docs/how-tos/fhir-resources#
# conditionally_updating_a_fhir_resource).
# @param [String] parent
- # The name of the FHIR store this resource belongs to.
+ # Required. The name of the FHIR store this resource belongs to.
# @param [String] type
- # The FHIR resource type to update, such as Patient or Observation. For a
- # complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/
- # standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/
- # standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/
- # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
- # provided content.
+ # Required. The FHIR resource type to update, such as Patient or Observation.
+ # For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/
+ # implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
+ # in the provided content.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4233,18 +4284,18 @@
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
# might be returned instead. For samples that show how to call `create`, see [
# Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
# fhir-resources#creating_a_fhir_resource).
# @param [String] parent
- # The name of the FHIR store this resource belongs to.
+ # Required. The name of the FHIR store this resource belongs to.
# @param [String] type
- # The FHIR resource type to create, such as Patient or Observation. For a
- # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
- # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
- # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/
- # standards/fhir/R4/resourcelist.html)). Must match the resource type in the
- # provided content.
+ # Required. The FHIR resource type to create, such as Patient or Observation.
+ # For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
+ # implement/standards/fhir/R4/resourcelist.html)). Must match the resource type
+ # in the provided content.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4283,11 +4334,11 @@
# can still be retrieved through vread and related methods, unless they are
# removed by the purge method. For samples that show how to call `delete`, see [
# Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/
# fhir-resources#deleting_a_fhir_resource).
# @param [String] name
- # The name of the resource to delete.
+ # Required. The name of the resource to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -4345,11 +4396,11 @@
# logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For
# samples that show how to call `executeBundle`, see [Managing FHIR resources
# using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-
# bundles).
# @param [String] parent
- # Name of the FHIR store in which this bundle will be executed.
+ # Required. Name of the FHIR store in which this bundle will be executed.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4391,11 +4442,11 @@
# valid API method on a FHIR store, a generic GCP error might be returned
# instead. For samples that show how to call `history`, see [Listing FHIR
# resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-
# resources#listing_fhir_resource_versions).
# @param [String] name
- # The name of the resource to retrieve.
+ # Required. The name of the resource to retrieve.
# @param [String] _at
# Only include resource versions that were current at some point during the time
# period specified in the date time value. The date parameter format is yyyy-mm-
# ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An
# entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `
@@ -4459,11 +4510,11 @@
# valid API method on a FHIR store, a generic GCP error might be returned
# instead. For samples that show how to call `patch`, see [Patching a FHIR
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
# patching_a_fhir_resource).
# @param [String] name
- # The name of the resource to update.
+ # Required. The name of the resource to update.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4507,11 +4558,11 @@
# cannot be mapped to a valid API method on a FHIR store, a generic GCP error
# might be returned instead. For samples that show how to call `read`, see [
# Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-
# resources#getting_a_fhir_resource).
# @param [String] name
- # The name of the resource to retrieve.
+ # Required. The name of the resource to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
@@ -4598,11 +4649,11 @@
# DocumentManifest searches. For samples and detailed information, see [
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
# healthcare/docs/how-tos/fhir-advanced-search).
# @param [String] parent
- # Name of the FHIR store to retrieve resources from.
+ # Required. Name of the FHIR store to retrieve resources from.
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4692,17 +4743,17 @@
# DocumentManifest searches. For samples and detailed information, see [
# Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/
# fhir-search) and [Advanced FHIR search features](https://cloud.google.com/
# healthcare/docs/how-tos/fhir-advanced-search).
# @param [String] parent
- # Name of the FHIR store to retrieve resources from.
+ # Required. Name of the FHIR store to retrieve resources from.
# @param [String] resource_type
- # The FHIR resource type to search, such as Patient or Observation. For a
- # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/
- # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/
- # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/
- # standards/fhir/R4/resourcelist.html)).
+ # Required. The FHIR resource type to search, such as Patient or Observation.
+ # For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/
+ # implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/
+ # implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/
+ # implement/standards/fhir/R4/resourcelist.html)).
# @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4752,11 +4803,11 @@
# valid API method on a FHIR store, a generic GCP error might be returned
# instead. For samples that show how to call `update`, see [Updating a FHIR
# resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#
# updating_a_fhir_resource).
# @param [String] name
- # The name of the resource to update.
+ # Required. The name of the resource to update.
# @param [Google::Apis::HealthcareV1::HttpBody] http_body_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
@@ -4796,10 +4847,10 @@
# store, a generic GCP error might be returned instead. For samples that show
# how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.
# google.com/healthcare/docs/how-tos/fhir-resources#
# retrieving_a_fhir_resource_version).
# @param [String] name
- # The name of the resource version to retrieve.
+ # Required. The name of the resource version to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.