Show / Hide Table of Contents

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

The "series" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource
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

Constructors

SeriesResource(IClientService)

Constructs a new resource.

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

Properties

Instances

Gets the Instances resource.

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

Methods

Delete(string, string)

DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Delete a study, series, or instance.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.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 DeleteSeries request. For example, studies/{study_uid}/series/{series_uid}.

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

RetrieveMetadata(string, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.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 RetrieveSeriesMetadata DICOMweb request. For example, studies/{study_uid}/series/{series_uid}/metadata.

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

RetrieveSeries(string, string)

RetrieveSeries returns all instances within the given study and series. See RetrieveTransaction. For details on the implementation of RetrieveSeries, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieve DICOM data.

Declaration
public virtual ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.RetrieveSeriesRequest RetrieveSeries(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 RetrieveSeries DICOMweb request. For example, studies/{study_uid}/series/{series_uid}.

Returns
Type Description
ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.RetrieveSeriesRequest

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.StudiesResource.SeriesResource.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.StudiesResource.SeriesResource.SearchForInstancesRequest
In this article
Back to top Generated by DocFX