Class ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource

The "instances" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource

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.StudiesResource.SeriesResource.InstancesResource

Constructors

InstancesResource(IClientService)

Constructs a new resource.

Declaration

public InstancesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Bulkdata

Gets the Bulkdata resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.BulkdataResource Bulkdata { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.BulkdataResource

Frames

Gets the Frames resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.FramesResource Frames { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.FramesResource

Methods

Delete(string, string)

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Delete a study, series, or instance.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.DeleteRequest Delete(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 DeleteInstance request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.DeleteRequest

RetrieveInstance(string, string)

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See RetrieveTransaction. For details on the implementation of RetrieveInstance, see DICOM study/series/instances and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveInstanceRequest RetrieveInstance(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 RetrieveInstance DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveInstanceRequest

RetrieveMetadata(string, string)

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See RetrieveTransaction. For details on the implementation of RetrieveInstanceMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveMetadataRequest RetrieveMetadata(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 RetrieveInstanceMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/metadata.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveMetadataRequest

RetrieveRendered(string, string)

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See RetrieveTransaction. For details on the implementation of RetrieveRenderedInstance, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveRenderedRequest RetrieveRendered(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 RetrieveRenderedInstance DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/rendered.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveRenderedRequest