Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsDicomStores extends Google_Service_Resource
in package

Application

The "dicomStores" collection of methods.

Typical usage is: $healthcareService = new Google_Service_CloudHealthcare(...); $dicomStores = $healthcareService->dicomStores;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudHealthcare_DicomStore: Creates a new DICOM store within the parent dataset. (dicomStores.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
deidentify() : Google_Service_CloudHealthcare_Operation: 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 logs](/healthcare/docs/how-tos/logging)). (dicomStores.deidentify)
delete() : Google_Service_CloudHealthcare_HealthcareEmpty: Deletes the specified DICOM store and removes all images that are contained within it. (dicomStores.delete)
export() : Google_Service_CloudHealthcare_Operation: Exports data to the specified destination by copying it from the DICOM store.
get() : Google_Service_CloudHealthcare_DicomStore: Gets the specified DICOM store. (dicomStores.get)
getIamPolicy() : Google_Service_CloudHealthcare_Policy: 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)
import() : Google_Service_CloudHealthcare_Operation: Imports data into the DICOM store by copying it from the specified source.
listProjectsLocationsDatasetsDicomStores() : Google_Service_CloudHealthcare_ListDicomStoresResponse: Lists the DICOM stores in the given dataset.
patch() : Google_Service_CloudHealthcare_DicomStore: Updates the specified DICOM store. (dicomStores.patch)
searchForInstances() : Google_Service_CloudHealthcare_HttpBody: SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.
searchForSeries() : Google_Service_CloudHealthcare_HttpBody: 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](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).
searchForStudies() : Google_Service_CloudHealthcare_HttpBody: SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.
setIamPolicy() : Google_Service_CloudHealthcare_Policy: 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)
storeInstances() : Google_Service_CloudHealthcare_HttpBody: 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](https://cloud.googl e.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). (dicomStores.storeInstances)
testIamPermissions() : Google_Service_CloudHealthcare_TestIamPermissionsResponse: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

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


    public
                create(string $parent, Google_Service_CloudHealthcare_DicomStore $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_DicomStore

Parameters

$parent : string: The name of the dataset this DICOM store belongs to.
$postBody : Google_Service_CloudHealthcare_DicomStore
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_DicomStore —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

deidentify()

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 logs](/healthcare/docs/how-tos/logging)). (dicomStores.deidentify)


    public
                deidentify(string $sourceStore, Google_Service_CloudHealthcare_DeidentifyDicomStoreRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

Parameters

$sourceStore : string: Source DICOM store resource name. For example, pr ojects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores /{dicom_store_id}.
$postBody : Google_Service_CloudHealthcare_DeidentifyDicomStoreRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

delete()

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


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HealthcareEmpty

Parameters

$name : string: The resource name of the DICOM store to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HealthcareEmpty —

export()

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


    public
                export(string $name, Google_Service_CloudHealthcare_ExportDicomDataRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

Errors are also logged to Cloud Logging. For more information, see Viewing logs. The metadata field type is OperationMetadata. (dicomStores.export)

Parameters

$name : string: The DICOM store resource name from which to export the data. For example, projects/{project_id}/locations/{location_id}/datasets/{d ataset_id}/dicomStores/{dicom_store_id}.
$postBody : Google_Service_CloudHealthcare_ExportDicomDataRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

get()

Gets the specified DICOM store. (dicomStores.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_DicomStore

Parameters

$name : string: The resource name of the DICOM store to get.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_DicomStore —

getIamPolicy()

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)


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Policy —

import()

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


    public
                import(string $name, Google_Service_CloudHealthcare_ImportDicomDataRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

Errors are logged to Cloud Logging. For more information, see Viewing logs. The metadata field type is OperationMetadata. (dicomStores.import)

Parameters

$name : string: The name of the DICOM store resource into which the data is imported. For example, projects/{project_id}/locations/{location_id}/data sets/{dataset_id}/dicomStores/{dicom_store_id}.
$postBody : Google_Service_CloudHealthcare_ImportDicomDataRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

listProjectsLocationsDatasetsDicomStores()

Lists the DICOM stores in the given dataset.


    public
                listProjectsLocationsDatasetsDicomStores(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_ListDicomStoresResponse

(dicomStores.listProjectsLocationsDatasetsDicomStores)

Parameters

$parent : string: Name of the dataset.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_ListDicomStoresResponse —

patch()

Updates the specified DICOM store. (dicomStores.patch)


    public
                patch(string $name, Google_Service_CloudHealthcare_DicomStore $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_DicomStore

Parameters

$name : string: Resource name of the DICOM store, of the form projects/{ project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_ store_id}.
$postBody : Google_Service_CloudHealthcare_DicomStore
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_DicomStore —

searchForInstances()

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


    public
                searchForInstances(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody

html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_tr ansaction) 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). (dicomStores.searchForInstances)

Parameters

$parent : string: 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}.
$dicomWebPath : string: The path of the SearchForInstancesRequest DICOMweb request. For example, instances, series/{series_uid}/instances, or studies/{study_uid}/instances.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HttpBody —

searchForSeries()

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](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).


    public
                searchForSeries(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody

(dicomStores.searchForSeries)

Parameters

$parent : string: 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}.
$dicomWebPath : string: The path of the SearchForSeries DICOMweb request. For example, series or studies/{study_uid}/series.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HttpBody —

searchForStudies()

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


    public
                searchForStudies(string $parent, string $dicomWebPath[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody

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 [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how- tos/dicomweb#searching_for_studies_series_instances_and_frames). (dicomStores.searchForStudies)

Parameters

$parent : string: 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}.
$dicomWebPath : string: The path of the SearchForStudies DICOMweb request. For example, studies.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HttpBody —

setIamPolicy()

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)


    public
                setIamPolicy(string $resource, Google_Service_CloudHealthcare_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudHealthcare_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Policy —

storeInstances()

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](https://cloud.googl e.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). (dicomStores.storeInstances)


    public
                storeInstances(string $parent, string $dicomWebPath, Google_Service_CloudHealthcare_HttpBody $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HttpBody

Parameters

$parent : string: 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}.
$dicomWebPath : string: The path of the StoreInstances DICOMweb request. For example, studies/[{study_uid}]. Note that the study_uid is optional.
$postBody : Google_Service_CloudHealthcare_HttpBody
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HttpBody —

testIamPermissions()

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.


    public
                testIamPermissions(string $resource, Google_Service_CloudHealthcare_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_TestIamPermissionsResponse

This operation may "fail open" without warning. (dicomStores.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudHealthcare_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —