1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudHealthcare
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDatasetsDicomStores

ProjectsLocationsDatasetsDicomStores

class ProjectsLocationsDatasetsDicomStores extends Resource (View source)

The "dicomStores" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $dicomStores = $healthcareService->projects_locations_datasets_dicomStores;

Methods

DicomStore
create(string $parent, DicomStore $postBody, array $optParams = [])

Creates a new DICOM store within the parent dataset. (dicomStores.create)

Operation
deidentify(string $sourceStore, DeidentifyDicomStoreRequest $postBody, array $optParams = [])

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. If errors occur, error is set. 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. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

HealthcareEmpty
delete(string $name, array $optParams = [])

Deletes the specified DICOM store and removes all images that are contained within it. (dicomStores.delete)

Operation
export(string $name, ExportDicomDataRequest $postBody, array $optParams = [])

Exports data to the specified destination by copying it from the DICOM store.

DicomStore
get(string $name, array $optParams = [])

Gets the specified DICOM store. (dicomStores.get)

DicomStoreMetrics
getDICOMStoreMetrics(string $name, array $optParams = [])

Gets metrics associated with the DICOM store.

Policy
getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (dicomStores.getIamPolicy)

Operation
import(string $name, ImportDicomDataRequest $postBody, array $optParams = [])

Imports data into the DICOM store by copying it from the specified source.

ListDicomStoresResponse
listProjectsLocationsDatasetsDicomStores(string $parent, array $optParams = [])

Lists the DICOM stores in the given dataset.

DicomStore
patch(string $name, DicomStore $postBody, array $optParams = [])

Updates the specified DICOM store. (dicomStores.patch)

HttpBody
searchForInstances(string $parent, string $dicomWebPath, array $optParams = [])

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.

HttpBody
searchForSeries(string $parent, string $dicomWebPath, array $optParams = [])

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 transact ion in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data. (dicomStores.searchForSeries)

HttpBody
searchForStudies(string $parent, string $dicomWebPath, array $optParams = [])

SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (dicomStores.setIamPolicy)

HttpBody
storeInstances(string $parent, string $dicomWebPath, HttpBody $postBody, array $optParams = [])

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di com/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data. (dicomStores.storeInstances)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

at line 57
DicomStore create(string $parent, DicomStore $postBody, array $optParams = [])

Creates a new DICOM store within the parent dataset. (dicomStores.create)

Parameters

string $parent

Required. The name of the dataset this DICOM store belongs to.
DicomStore $postBody
array $optParams

Optional parameters.

Return Value

DicomStore

Exceptions

Exception

at line 83
Operation deidentify(string $sourceStore, DeidentifyDicomStoreRequest $postBody, array $optParams = [])

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. If errors occur, error is set. 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. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

(dicomStores.deidentify)

Parameters

string $sourceStore

Required. Source DICOM store resource name. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}.
DeidentifyDicomStoreRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 98
HealthcareEmpty delete(string $name, array $optParams = [])

Deletes the specified DICOM store and removes all images that are contained within it. (dicomStores.delete)

Parameters

string $name

Required. The resource name of the DICOM store to delete.
array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

at line 119
Operation export(string $name, ExportDicomDataRequest $postBody, array $optParams = [])

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. The metadata field type is OperationMetadata. (dicomStores.export)

Parameters

string $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_store_id}.
ExportDicomDataRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 133
DicomStore get(string $name, array $optParams = [])

Gets the specified DICOM store. (dicomStores.get)

Parameters

string $name

Required. The resource name of the DICOM store to get.
array $optParams

Optional parameters.

Return Value

DicomStore

Exceptions

Exception

at line 149
DicomStoreMetrics getDICOMStoreMetrics(string $name, array $optParams = [])

Gets metrics associated with the DICOM store.

(dicomStores.getDICOMStoreMetrics)

Parameters

string $name

Required. The resource name of the DICOM store to get metrics for.
array $optParams

Optional parameters.

Return Value

DicomStoreMetrics

Exceptions

Exception

at line 180
Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (dicomStores.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 201
Operation import(string $name, ImportDicomDataRequest $postBody, array $optParams = [])

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. The metadata field type is OperationMetadata. (dicomStores.import)

Parameters

string $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_store_id}.
ImportDicomDataRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 244
ListDicomStoresResponse listProjectsLocationsDatasetsDicomStores(string $parent, array $optParams = [])

Lists the DICOM stores in the given dataset.

(dicomStores.listProjectsLocationsDatasetsDicomStores)

Parameters

string $parent

Required. Name of the dataset.
array $optParams

Optional parameters.

Return Value

ListDicomStoresResponse

Exceptions

Exception

at line 266
DicomStore patch(string $name, DicomStore $postBody, array $optParams = [])

Updates the specified DICOM store. (dicomStores.patch)

Parameters

string $name

Identifier. Resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomSto res/{dicom_store_id}.
DicomStore $postBody
array $optParams

Optional parameters.

Return Value

DicomStore

Exceptions

Exception

at line 292
HttpBody searchForInstances(string $parent, string $dicomWebPath, array $optParams = [])

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.

html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data. (dicomStores.searchForInstances)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.
string $dicomWebPath

Required. The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/{series_uid}/instances, or studies/{study_uid}/instances.
array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

at line 317
HttpBody searchForSeries(string $parent, string $dicomWebPath, array $optParams = [])

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 transact ion in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data. (dicomStores.searchForSeries)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.
string $dicomWebPath

Required. The path of the SearchForSeries DICOMweb request. For example, series or studies/{study_uid}/series.
array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

at line 342
HttpBody searchForStudies(string $parent, string $dicomWebPath, array $optParams = [])

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 transa ction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data. (dicomStores.searchForStudies)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.
string $dicomWebPath

Required. The path of the SearchForStudies DICOMweb request. For example, studies.
array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

at line 362
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (dicomStores.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 389
HttpBody storeInstances(string $parent, string $dicomWebPath, HttpBody $postBody, array $optParams = [])

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/di com/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data. (dicomStores.storeInstances)

Parameters

string $parent

Required. The name of the DICOM store that is being accessed. For example, projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/dicomStores/{dicom_store_id}.
string $dicomWebPath

Required. The path of the StoreInstances DICOMweb request. For example, studies/[{study_uid}]. Note that the study_uid is optional.
HttpBody $postBody
array $optParams

Optional parameters.

Return Value

HttpBody

Exceptions

Exception

at line 412
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (dicomStores.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception