Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource

The "dicomStores" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudHealthcare.v1beta1
Assembly: Google.Apis.CloudHealthcare.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource

Constructors

DicomStoresResource(IClientService)

Constructs a new resource.

Declaration
public DicomStoresResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

DicomWeb

Gets the DicomWeb resource.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource DicomWeb { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource

Studies

Gets the Studies resource.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource Studies { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource

Methods

Create(DicomStore, string)

Creates a new DICOM store within the parent dataset.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.CreateRequest Create(DicomStore body, string parent)
Parameters
Type Name Description
DicomStore body

The body of the request.

string parent

Required. The name of the dataset this DICOM store belongs to.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.CreateRequest

Deidentify(DeidentifyDicomStoreRequest, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DeidentifyRequest Deidentify(DeidentifyDicomStoreRequest body, string sourceStore)
Parameters
Type Name Description
DeidentifyDicomStoreRequest body

The body of the request.

string sourceStore

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DeidentifyRequest

Delete(string)

Deletes the specified DICOM store and removes all images that are contained within it.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DeleteRequest

Export(ExportDicomDataRequest, string)

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. The metadata field type is OperationMetadata.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ExportRequest Export(ExportDicomDataRequest body, string name)
Parameters
Type Name Description
ExportDicomDataRequest body

The body of the request.

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}.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ExportRequest

Get(string)

Gets the specified DICOM store.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetRequest

GetDICOMStoreMetrics(string)

Gets metrics associated with the DICOM store.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetDICOMStoreMetricsRequest GetDICOMStoreMetrics(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetDICOMStoreMetricsRequest

GetIamPolicy(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetIamPolicyRequest

Import(ImportDicomDataRequest, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ImportRequest Import(ImportDicomDataRequest body, string name)
Parameters
Type Name Description
ImportDicomDataRequest body

The body of the request.

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}.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ImportRequest

List(string)

Lists the DICOM stores in the given dataset.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Name of the dataset.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ListRequest

Patch(DicomStore, string)

Updates the specified DICOM store.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.PatchRequest Patch(DicomStore body, string name)
Parameters
Type Name Description
DicomStore body

The body of the request.

string name

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.PatchRequest

SearchForInstances(string, string)

SearchForInstances returns a list of matching instances. See RetrieveTransaction. 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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForInstancesRequest SearchForInstances(string parent, string dicomWebPath)
Parameters
Type Name Description
string 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_store_id}.

string dicomWebPath

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForInstancesRequest

SearchForSeries(string, string)

SearchForSeries returns a list of matching series. See RetrieveTransaction. For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForSeriesRequest SearchForSeries(string parent, string dicomWebPath)
Parameters
Type Name Description
string 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_store_id}.

string dicomWebPath

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForSeriesRequest

SearchForStudies(string, string)

SearchForStudies returns a list of matching studies. See RetrieveTransaction. For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForStudiesRequest SearchForStudies(string parent, string dicomWebPath)
Parameters
Type Name Description
string 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_store_id}.

string dicomWebPath

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForStudiesRequest

SetBlobStorageSettings(SetBlobStorageSettingsRequest, string)

SetBlobStorageSettings sets the blob storage settings of the specified resources.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SetBlobStorageSettingsRequest SetBlobStorageSettings(SetBlobStorageSettingsRequest body, string resource)
Parameters
Type Name Description
SetBlobStorageSettingsRequest body

The body of the request.

string resource

Required. The path of the resource to update the blob storage settings in the format of projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}, projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/, or projects/{projectID}/locations/{locationID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{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/{dicomStoreID}.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SetBlobStorageSettingsRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SetIamPolicyRequest

StoreInstances(HttpBody, string, string)

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction. 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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StoreInstancesRequest StoreInstances(HttpBody body, string parent, string dicomWebPath)
Parameters
Type Name Description
HttpBody body

The body of the request.

string 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_store_id}.

string dicomWebPath

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StoreInstancesRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

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

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX