com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest<HttpBody>

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series

public class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries
extends CloudHealthcareRequest<HttpBody>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RetrieveSeries(String parent, String dicomWebPath) RetrieveSeries returns all instances within the given study and series.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getDicomWebPath() Required.
String	getParent() Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	set(String parameterName, Object value)
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	set$Xgafv(String $Xgafv) V1 error format.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setAccessToken(String accessToken) OAuth access token.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setAlt(String alt) Data format for response.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setCallback(String callback) JSONP
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setDicomWebPath(String dicomWebPath) Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setKey(String key) API key.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setParent(String parent) Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.healthcare.v1beta1.CloudHealthcareRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RetrieveSeries

protected RetrieveSeries(String parent,
                         String dicomWebPath)

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransactio n](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.googl e.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). Create a request for the method "series.retrieveSeries". This request holds the parameters needed by the the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

RetrieveSeries#initialize(com.google.api.client.googleapis.services.Abstr actGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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_st ore_id}`.

dicomWebPath - Required. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<HttpBody>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<HttpBody>

Throws:

IOException

set$Xgafv

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries set$Xgafv(String $Xgafv)

Description copied from class: CloudHealthcareRequest

V1 error format.

Overrides:

set$Xgafv in class CloudHealthcareRequest<HttpBody>

setAccessToken

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setAccessToken(String accessToken)

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<HttpBody>

setAlt

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setAlt(String alt)

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<HttpBody>

setCallback

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setCallback(String callback)

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<HttpBody>

setFields

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setFields(String fields)

Description copied from class: CloudHealthcareRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudHealthcareRequest<HttpBody>

setKey

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setKey(String key)

Description copied from class: CloudHealthcareRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class CloudHealthcareRequest<HttpBody>

setOauthToken

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setOauthToken(String oauthToken)

Description copied from class: CloudHealthcareRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudHealthcareRequest<HttpBody>

setPrettyPrint

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudHealthcareRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudHealthcareRequest<HttpBody>

setQuotaUser

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setQuotaUser(String quotaUser)

Description copied from class: CloudHealthcareRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class CloudHealthcareRequest<HttpBody>

setUploadType

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setUploadType(String uploadType)

Description copied from class: CloudHealthcareRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class CloudHealthcareRequest<HttpBody>

setUploadProtocol

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setUploadProtocol(String uploadProtocol)

Description copied from class: CloudHealthcareRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class CloudHealthcareRequest<HttpBody>

getParent

public String getParent()

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

setParent

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setParent(String parent)

Required. The name of the DICOM store that is being accessed. For example, `proje cts/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom _store_id}`.

getDicomWebPath

public String getDicomWebPath()

Required. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`.

setDicomWebPath

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries setDicomWebPath(String dicomWebPath)

Required. The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`.

set

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.Series.RetrieveSeries set(String parameterName,
                                                                                                 Object value)

Overrides:

set in class CloudHealthcareRequest<HttpBody>