com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics

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<StudyMetrics>

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies

public class CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics
extends CloudHealthcareRequest<StudyMetrics>

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	GetStudyMetrics(String study) GetStudyMetrics returns metrics for a study.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getStudy() Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	set(String parameterName, Object value)
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	set$Xgafv(String $Xgafv) V1 error format.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setAccessToken(String accessToken) OAuth access token.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setAlt(String alt) Data format for response.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setCallback(String callback) JSONP
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setKey(String key) API key.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setStudy(String study) Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics	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

GetStudyMetrics

protected GetStudyMetrics(String study)

GetStudyMetrics returns metrics for a study. Create a request for the method "studies.getStudyMetrics". 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.

GetStudyMetrics#initialize(com.google.api.client.googleapis.services.Abst ractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

study - Required. The study resource path. For example, `projects/{project_id}/locations/{location_id}/datas ets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_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<StudyMetrics>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics set$Xgafv(String $Xgafv)

Description copied from class: CloudHealthcareRequest

V1 error format.

Overrides:

set$Xgafv in class CloudHealthcareRequest<StudyMetrics>

setAccessToken

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setAccessToken(String accessToken)

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<StudyMetrics>

setAlt

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setAlt(String alt)

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<StudyMetrics>

setCallback

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setCallback(String callback)

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<StudyMetrics>

setFields

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setFields(String fields)

Description copied from class: CloudHealthcareRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudHealthcareRequest<StudyMetrics>

setKey

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics 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<StudyMetrics>

setOauthToken

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setOauthToken(String oauthToken)

Description copied from class: CloudHealthcareRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudHealthcareRequest<StudyMetrics>

setPrettyPrint

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudHealthcareRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudHealthcareRequest<StudyMetrics>

setQuotaUser

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics 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<StudyMetrics>

setUploadType

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setUploadType(String uploadType)

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadType in class CloudHealthcareRequest<StudyMetrics>

setUploadProtocol

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setUploadProtocol(String uploadProtocol)

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadProtocol in class CloudHealthcareRequest<StudyMetrics>

getStudy

public String getStudy()

Required. The study resource path. For example, `projects/{project_id}/locations/{location_id}/data sets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`.

setStudy

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.DicomWeb.Studies.GetStudyMetrics setStudy(String study)

Required. The study resource path. For example, `projects/{project_id}/locations/ {location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies /{study_uid}`.

set

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

Overrides:

set in class CloudHealthcareRequest<StudyMetrics>