com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances

java.lang.Object

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series

public class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances
extends Object

The "instances" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Bulkdata The "bulkdata" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Delete
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Frames The "frames" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveInstance
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveMetadata
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveRendered

Constructor Summary

Constructors

Constructor and Description
Instances()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Bulkdata	bulkdata() An accessor for creating requests from the Bulkdata collection.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Delete	delete(String parent, String dicomWebPath) DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Frames	frames() An accessor for creating requests from the Frames collection.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveInstance	retrieveInstance(String parent, String dicomWebPath) RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveMetadata	retrieveMetadata(String parent, String dicomWebPath) RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveRendered	retrieveRendered(String parent, String dicomWebPath) RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Instances

public Instances()

Method Detail

delete

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Delete delete(String parent,
                                                                                                      String dicomWebPath)
                                                                                               throws IOException

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. 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). Create a request for the method "instances.delete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

dicomWebPath - Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`.

Returns:

the request

Throws:

IOException

retrieveInstance

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveInstance retrieveInstance(String parent,
                                                                                                                          String dicomWebPath)
                                                                                                                   throws IOException

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#sec t_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 [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve- instance). Create a request for the method "instances.retrieveInstance". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

dicomWebPath - Required. The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`.

Returns:

the request

Throws:

IOException

retrieveMetadata

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveMetadata retrieveMetadata(String parent,
                                                                                                                          String dicomWebPath)
                                                                                                                   throws IOException

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://d icom.nema.org/medical/dicom/current/output/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 [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve- metadata). Create a request for the method "instances.retrieveMetadata". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

dicomWebPath - Required. The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata`.

Returns:

the request

Throws:

IOException

retrieveRendered

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.RetrieveRendered retrieveRendered(String parent,
                                                                                                                          String dicomWebPath)
                                                                                                                   throws IOException

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.or g/medical/dicom/current/output/html/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 [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#retrieve-consumer). Create a request for the method "instances.retrieveRendered". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

dicomWebPath - Required. The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered`.

Returns:

the request

Throws:

IOException

bulkdata

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Bulkdata bulkdata()

An accessor for creating requests from the Bulkdata collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Bulkdata.List request = healthcare.bulkdata().list(parameters ...)
 

Returns:

the resource collection

frames

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances.Frames frames()

An accessor for creating requests from the Frames collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Frames.List request = healthcare.frames().list(parameters ...)
 

Returns:

the resource collection