generated/google/apis/healthcare_v1/service.rb in google-api-client-0.44.1 vs generated/google/apis/healthcare_v1/service.rb in google-api-client-0.44.2

- old
+ new

@@ -45,10 +45,79 @@ def initialize super('https://healthcare.googleapis.com/', '') @batch_path = 'batch' end + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @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::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Location] + # + # @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 get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Location::Representation + command.response_class = Google::Apis::HealthcareV1::Location + 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 + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @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::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListLocationsResponse] + # + # @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 list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/locations', options) + command.response_representation = Google::Apis::HealthcareV1::ListLocationsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new health dataset. Results are returned through the Operation # interface which returns either an `Operation.response` which contains a # Dataset or `Operation.error`. The metadata field type is OperationMetadata. A # Google Cloud Platform project can contain up to 500 datasets across all # regions. @@ -722,11 +791,16 @@ execute_or_queue_command(command, &block) end # SearchForInstances returns a list of matching instances. See [Search # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. - # html#sect_10.6). + # html#sect_10.6). For details on the implementation of SearchForInstances, see [ + # 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 [Searching for studies, + # series, instances, and frames](https://cloud.google.com/healthcare/docs/how- + # tos/dicomweb#searching_for_studies_series_instances_and_frames). # @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``. # @param [String] dicom_web_path @@ -761,10 +835,16 @@ execute_or_queue_command(command, &block) end # SearchForSeries returns a list of matching series. See [Search Transaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + # For details on the implementation of SearchForSeries, see [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 + # SearchForSeries, see [Searching for studies, series, instances, and frames]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @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``. # @param [String] dicom_web_path @@ -798,10 +878,16 @@ execute_or_queue_command(command, &block) end # SearchForStudies returns a list of matching studies. See [Search Transaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + # For details on the implementation of SearchForStudies, see [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 SearchForStudies, see [Searching for studies, series, instances, and + # frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @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``. # @param [String] dicom_web_path @@ -870,11 +956,16 @@ execute_or_queue_command(command, &block) end # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.5). + # dicom/current/output/html/part18.html#sect_10.5). For details on the + # implementation of StoreInstances, see [Store transaction](https://cloud.google. + # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call StoreInstances, see [ + # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # storing_dicom_data). # @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``. # @param [String] dicom_web_path @@ -952,11 +1043,14 @@ # DeleteStudy deletes all instances within the given study. Delete requests are # equivalent to the GET requests specified in the Retrieve transaction. The # method returns an Operation which will be marked successful when the deletion # is complete. Warning: Inserting instances into a study while a delete # operation is running for that study could result in the new instances not - # appearing in search results until the deletion operation finishes. + # appearing in search results until the deletion operation finishes. For samples + # that show how to call DeleteStudy, see [Deleting a study, series, or instance]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # deleting_a_study_series_or_instance). # @param [String] parent # @param [String] dicom_web_path # The path of the DeleteStudy request. For example, `studies/`study_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -987,10 +1081,15 @@ end # RetrieveStudyMetadata returns instance associated with the given study # presented as metadata with the bulk data removed. See [RetrieveTransaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). + # For details on the implementation of RetrieveStudyMetadata, see [Metadata + # 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 [Retrieving metadata](https://cloud.google. + # com/healthcare/docs/how-tos/dicomweb#retrieving_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``. # @param [String] dicom_web_path @@ -1024,11 +1123,16 @@ execute_or_queue_command(command, &block) end # RetrieveStudy returns all instances within the given study. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of RetrieveStudy, + # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/ + # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance + # statement. For samples that show how to call RetrieveStudy, see [Retrieving + # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_dicom_data). # @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``. # @param [String] dicom_web_path @@ -1062,11 +1166,16 @@ execute_or_queue_command(command, &block) end # SearchForInstances returns a list of matching instances. See [Search # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. - # html#sect_10.6). + # html#sect_10.6). For details on the implementation of SearchForInstances, see [ + # 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 [Searching for studies, + # series, instances, and frames](https://cloud.google.com/healthcare/docs/how- + # tos/dicomweb#searching_for_studies_series_instances_and_frames). # @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``. # @param [String] dicom_web_path @@ -1101,10 +1210,16 @@ execute_or_queue_command(command, &block) end # SearchForSeries returns a list of matching series. See [Search Transaction] ( # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). + # For details on the implementation of SearchForSeries, see [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 + # SearchForSeries, see [Searching for studies, series, instances, and frames]( + # https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # searching_for_studies_series_instances_and_frames). # @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``. # @param [String] dicom_web_path @@ -1138,11 +1253,16 @@ execute_or_queue_command(command, &block) end # StoreInstances stores DICOM instances associated with study instance unique # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.5). + # dicom/current/output/html/part18.html#sect_10.5). For details on the + # implementation of StoreInstances, see [Store transaction](https://cloud.google. + # com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API + # conformance statement. For samples that show how to call StoreInstances, see [ + # Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # storing_dicom_data). # @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``. # @param [String] dicom_web_path @@ -1183,11 +1303,13 @@ # requests are equivalent to the GET requests specified in the Retrieve # transaction. The method returns an Operation which will be marked successful # when the deletion is complete. Warning: Inserting instances into a series # while a delete operation is running for that series could result in the new # instances not appearing in search results until the deletion operation - # finishes. + # finishes. For samples that show how to call DeleteSeries, see [Deleting a + # study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/ + # dicomweb#deleting_a_study_series_or_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``. # @param [String] dicom_web_path @@ -1222,11 +1344,16 @@ end # RetrieveSeriesMetadata returns instance associated with the given study and # series, presented as metadata with the bulk data removed. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/ + # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_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``. # @param [String] dicom_web_path @@ -1260,11 +1387,16 @@ execute_or_queue_command(command, &block) end # RetrieveSeries returns all instances within the given study and series. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of RetrieveSeries, + # see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/ + # dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance + # statement. For samples that show how to call RetrieveSeries, see [Retrieving + # DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_dicom_data). # @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``. # @param [String] dicom_web_path @@ -1298,11 +1430,16 @@ execute_or_queue_command(command, &block) end # SearchForInstances returns a list of matching instances. See [Search # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. - # html#sect_10.6). + # html#sect_10.6). For details on the implementation of SearchForInstances, see [ + # 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 [Searching for studies, + # series, instances, and frames](https://cloud.google.com/healthcare/docs/how- + # tos/dicomweb#searching_for_studies_series_instances_and_frames). # @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``. # @param [String] dicom_web_path @@ -1339,11 +1476,13 @@ # DeleteInstance deletes an instance associated with the given study, series, # and SOP Instance UID. Delete requests are equivalent to the GET requests # specified in the Retrieve transaction. Study and series search results can # take a few seconds to be updated after an instance is deleted using - # DeleteInstance. + # DeleteInstance. For samples that show how to call DeleteInstance, see [ + # Deleting a study, series, or instance](https://cloud.google.com/healthcare/ + # docs/how-tos/dicomweb#deleting_a_study_series_or_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``. # @param [String] dicom_web_path @@ -1377,11 +1516,17 @@ execute_or_queue_command(command, &block) end # RetrieveInstance returns instance associated with the given study, series, and # SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/ - # dicom/current/output/html/part18.html#sect_10.4). + # dicom/current/output/html/part18.html#sect_10.4). For details on the + # implementation of RetrieveInstance, see [DICOM study/series/instances](https:// + # cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM + # 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 [Retrieving an instance](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_an_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``. # @param [String] dicom_web_path @@ -1416,11 +1561,16 @@ end # RetrieveInstanceMetadata returns instance associated with the given study, # series, and SOP Instance UID presented as metadata with the bulk data removed. # See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/ - # html/part18.html#sect_10.4). + # html/part18.html#sect_10.4). For details on the implementation of + # RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/ + # healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/ + # healthcare/docs/how-tos/dicomweb#retrieving_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``. # @param [String] dicom_web_path @@ -1455,11 +1605,17 @@ end # RetrieveRenderedInstance returns instance associated with the given study, # series, and SOP Instance UID in an acceptable Rendered Media Type. See [ # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # part18.html#sect_10.4). For details on the implementation of + # RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/ + # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveRenderedInstance, see [Retrieving consumer image formats](https:// + # cloud.google.com/healthcare/docs/how-tos/dicomweb# + # retrieving_consumer_image_formats). # @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``. # @param [String] dicom_web_path @@ -1493,11 +1649,16 @@ execute_or_queue_command(command, &block) end # RetrieveFrames returns instances associated with the given study, series, SOP # Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema. - # org/medical/dicom/current/output/html/part18.html#sect_10.4`. + # org/medical/dicom/current/output/html/part18.html#sect_10.4`. For details on + # the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google. + # com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API + # conformance statement. For samples that show how to call RetrieveFrames, see [ + # Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/ + # dicomweb#retrieving_dicom_data). # @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``. # @param [String] dicom_web_path @@ -1532,10 +1693,15 @@ end # RetrieveRenderedFrames returns instances associated with the given study, # series, SOP Instance UID and frame numbers in an acceptable Rendered Media # Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/ - # output/html/part18.html#sect_10.4). + # output/html/part18.html#sect_10.4). For details on the implementation of + # RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/ + # healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API + # conformance statement. For samples that show how to call + # RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud. + # google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). # @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``. # @param [String] dicom_web_path