com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies

public class CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata
extends CloudHealthcareRequest<Operation>

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	UpdateMetadata(String parent, String dicomWebPath, HttpBody content) UpdateStudyMetadata modifies the metadata of all instances in the given study.

Method Summary

Modifier and Type	Method and Description
String	getDicomWebPath() Required.
String	getParent() Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	set(String parameterName, Object value)
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	set$Xgafv(String $Xgafv) V1 error format.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setAccessToken(String accessToken) OAuth access token.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setAlt(String alt) Data format for response.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setCallback(String callback) JSONP
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setDicomWebPath(String dicomWebPath) Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setKey(String key) API key.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setParent(String parent) Required.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

UpdateMetadata

protected UpdateMetadata(String parent,
                         String dicomWebPath,
                         HttpBody content)

UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study. Create a request for the method "studies.updateMetadata". 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.

UpdateMetadata#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 UpdateStudyMetadata request (for example, `studies/{study_uid}`).

content - the HttpBody

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: CloudHealthcareRequest

V1 error format.

Overrides:

set$Xgafv in class CloudHealthcareRequest<Operation>

setAccessToken

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

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<Operation>

setAlt

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

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<Operation>

setCallback

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

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<Operation>

setFields

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

Description copied from class: CloudHealthcareRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudHealthcareRequest<Operation>

setKey

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata 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<Operation>

setOauthToken

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

Description copied from class: CloudHealthcareRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudHealthcareRequest<Operation>

setPrettyPrint

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

Description copied from class: CloudHealthcareRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudHealthcareRequest<Operation>

setQuotaUser

public CloudHealthcare.Projects.Locations.Datasets.DicomStores.Studies.UpdateMetadata 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<Operation>

setUploadType

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

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadType in class CloudHealthcareRequest<Operation>

setUploadProtocol

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

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadProtocol in class CloudHealthcareRequest<Operation>

getParent

public String getParent()

Required. The name of the DICOM store that is being accessed (for example, `projects/{project_id}/l ocations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`).

setParent

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

Required. The name of the DICOM store that is being accessed (for example, `project s/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_sto re_id}`).

getDicomWebPath

public String getDicomWebPath()

Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`).

setDicomWebPath

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

Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`).

set

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

Overrides:

set in class CloudHealthcareRequest<Operation>