com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.DicomStores

java.lang.Object

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

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets

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

The "dicomStores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.CloudHealthcareImport
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Create
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Deidentify
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Delete
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb The "dicomWeb" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Export
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Get
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.GetDICOMStoreMetrics
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.GetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.List
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Patch
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForInstances
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForSeries
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForStudies
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.SetBlobStorageSettings
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.SetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.StoreInstances
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies The "studies" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.DicomStores.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
DicomStores()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Create	create(String parent, DicomStore content) Creates a new DICOM store within the parent dataset.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Deidentify	deidentify(String sourceStore, DeidentifyDicomStoreRequest content) De-identifies data from the source store and writes it to the destination store.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Delete	delete(String name) Deletes the specified DICOM store and removes all images that are contained within it.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb	dicomWeb() An accessor for creating requests from the DicomWeb collection.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Export	export(String name, ExportDicomDataRequest content) Exports data to the specified destination by copying it from the DICOM store.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Get	get(String name) Gets the specified DICOM store.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.GetDICOMStoreMetrics	getDICOMStoreMetrics(String name) Gets metrics associated with the DICOM store.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.CloudHealthcareImport	healthcareImport(String name, ImportDicomDataRequest content) Imports data into the DICOM store by copying it from the specified source.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.List	list(String parent) Lists the DICOM stores in the given dataset.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Patch	patch(String name, DicomStore content) Updates the specified DICOM store.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForInstances	searchForInstances(String parent, String dicomWebPath) SearchForInstances returns a list of matching instances.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForSeries	searchForSeries(String parent, String dicomWebPath) SearchForSeries returns a list of matching series.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForStudies	searchForStudies(String parent, String dicomWebPath) SearchForStudies returns a list of matching studies.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.SetBlobStorageSettings	setBlobStorageSettings(String resource, SetBlobStorageSettingsRequest content) SetBlobStorageSettings sets the blob storage settings of the specified resources.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.StoreInstances	storeInstances(String parent, String dicomWebPath, HttpBody content) StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies	studies() An accessor for creating requests from the Studies collection.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DicomStores

public DicomStores()

Method Detail

create

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Create create(String parent,
                                                                             DicomStore content)
                                                                      throws IOException

Creates a new DICOM store within the parent dataset. Create a request for the method "dicomStores.create". 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 dataset this DICOM store belongs to.

content - the DicomStore

Returns:

the request

Throws:

IOException

deidentify

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Deidentify deidentify(String sourceStore,
                                                                                     DeidentifyDicomStoreRequest content)
                                                                              throws IOException

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). Create a request for the method "dicomStores.deidentify". 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:

sourceStore - Required. Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

content - the DeidentifyDicomStoreRequest

Returns:

the request

Throws:

IOException

delete

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Delete delete(String name)
                                                                      throws IOException

Deletes the specified DICOM store and removes all images that are contained within it. Create a request for the method "dicomStores.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:

name - Required. The resource name of the DICOM store to delete.

Returns:

the request

Throws:

IOException

export

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Export export(String name,
                                                                             ExportDicomDataRequest content)
                                                                      throws IOException

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 errors in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. Create a request for the method "dicomStores.export". 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:

name - 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_st ore_id}`.

content - the ExportDicomDataRequest

Returns:

the request

Throws:

IOException

get

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Get get(String name)
                                                                throws IOException

Gets the specified DICOM store. Create a request for the method "dicomStores.get". 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:

name - Required. The resource name of the DICOM store to get.

Returns:

the request

Throws:

IOException

getDICOMStoreMetrics

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.GetDICOMStoreMetrics getDICOMStoreMetrics(String name)
                                                                                                  throws IOException

Gets metrics associated with the DICOM store. Create a request for the method "dicomStores.getDICOMStoreMetrics". 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:

name - Required. The resource name of the DICOM store to get metrics for.

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.GetIamPolicy getIamPolicy(String resource)
                                                                                  throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "dicomStores.getIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

healthcareImport

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.CloudHealthcareImport healthcareImport(String name,
                                                                                                      ImportDicomDataRequest content)
                                                                                               throws IOException

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. Create a request for the method "dicomStores.import". 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:

name - 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_st ore_id}`.

content - the ImportDicomDataRequest

Returns:

the request

Throws:

IOException

list

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.List list(String parent)
                                                                  throws IOException

Lists the DICOM stores in the given dataset. Create a request for the method "dicomStores.list". 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. Name of the dataset.

Returns:

the request

Throws:

IOException

patch

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Patch patch(String name,
                                                                           DicomStore content)
                                                                    throws IOException

Updates the specified DICOM store. Create a request for the method "dicomStores.patch". 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:

name - Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_st ore_id}`.

content - the DicomStore

Returns:

the request

Throws:

IOException

searchForInstances

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.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 "dicomStores.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

searchForSeries

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForSeries searchForSeries(String parent,
                                                                                               String dicomWebPath)
                                                                                        throws IOException

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

Returns:

the request

Throws:

IOException

searchForStudies

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.SearchForStudies searchForStudies(String parent,
                                                                                                 String dicomWebPath)
                                                                                          throws IOException

SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema. org/medical/dicom/current/output/html/part18.html#sect_10.4). 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 [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). Create a request for the method "dicomStores.searchForStudies". 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 SearchForStudies DICOMweb request. For example, `studies`.

Returns:

the request

Throws:

IOException

setBlobStorageSettings

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.SetBlobStorageSettings setBlobStorageSettings(String resource,
                                                                                                             SetBlobStorageSettingsRequest content)
                                                                                                      throws IOException

SetBlobStorageSettings sets the blob storage settings of the specified resources. Create a request for the method "dicomStores.setBlobStorageSettings". 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:

resource - Required. The path of the resource to update the blob storage settings in the format of `projects/{p rojectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/ studies/{studyUID}`, `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dic omStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{pr ojectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/s tudies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreI D}`.

content - the SetBlobStorageSettingsRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.SetIamPolicy setIamPolicy(String resource,
                                                                                         SetIamPolicyRequest content)
                                                                                  throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "dicomStores.setIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

storeInstances

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.StoreInstances storeInstances(String parent,
                                                                                             String dicomWebPath,
                                                                                             HttpBody content)
                                                                                      throws IOException

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). 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 [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). Create a request for the method "dicomStores.storeInstances". 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 StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.

content - the HttpBody

Returns:

the request

Throws:

IOException

testIamPermissions

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.TestIamPermissions testIamPermissions(String resource,
                                                                                                     TestIamPermissionsRequest content)
                                                                                              throws IOException

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Create a request for the method "dicomStores.testIamPermissions". 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:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

dicomWeb

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb dicomWeb()

An accessor for creating requests from the DicomWeb collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.DicomWeb.List request = healthcare.dicomWeb().list(parameters ...)
 

Returns:

the resource collection

studies

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies studies()

An accessor for creating requests from the Studies collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Studies.List request = healthcare.studies().list(parameters ...)
 

Returns:

the resource collection