com.google.api.services.healthcare.v1beta1

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

java.lang.Object

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

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies

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

The "series" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Delete
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances The "instances" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveMetadata
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.SearchForInstances

Constructor Summary

Constructors

Constructor and Description
Series()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Delete	delete(String parent, String dicomWebPath) DeleteSeries deletes all instances within the given study and series using a long running operation.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.Instances	instances() An accessor for creating requests from the Instances collection.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveMetadata	retrieveMetadata(String parent, String dicomWebPath) RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	retrieveSeries(String parent, String dicomWebPath) RetrieveSeries returns all instances within the given study and series.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.SearchForInstances	searchForInstances(String parent, String dicomWebPath) SearchForInstances returns a list of matching instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

Series

public Series()

Method Detail

delete

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

DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a 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). Create a request for the method "series.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 DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`.

Returns:

the request

Throws:

IOException

retrieveMetadata

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

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/dico m/current/output/html/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 [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve- metadata). Create a request for the method "series.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 RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`.

Returns:

the request

Throws:

IOException

retrieveSeries

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries retrieveSeries(String parent,
                                                                                                            String dicomWebPath)
                                                                                                     throws IOException

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). 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 [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). Create a request for the method "series.retrieveSeries". 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 RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`.

Returns:

the request

Throws:

IOException

searchForInstances

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.SearchForInstances searchForInstances(String parent,
                                                                                                                    String dicomWebPath)
                                                                                                             throws IOException

SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.n ema.org/medical/dicom/current/output/html/part18.html#sect_10.4). 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 [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). Create a request for the method "series.searchForInstances". 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 SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.

Returns:

the request

Throws:

IOException

instances

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

An accessor for creating requests from the Instances collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Instances.List request = healthcare.instances().list(parameters ...)
 

Returns:

the resource collection