com.google.api.services.healthcare.v1

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread

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.v1.CloudHealthcareRequest<HttpBody>

com.google.api.services.healthcare.v1.CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir

public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread
extends CloudHealthcareRequest<HttpBody>

Nested Class Summary

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Vread(String name) Gets the contents of a version (current or historical) of a FHIR resource by version ID.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getName() The name of the resource version to retrieve.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	set(String parameterName, Object value)
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	set$Xgafv(String $Xgafv) V1 error format.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setAccessToken(String accessToken) OAuth access token.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setAlt(String alt) Data format for response.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setCallback(String callback) JSONP
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setKey(String key) API key.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setName(String name) The name of the resource version to retrieve.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.healthcare.v1.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

Vread

protected Vread(String name)

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version). Create a request for the method "fhir.vread". 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.

CloudHealthcare.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - The name of the resource version to retrieve.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<HttpBody>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<HttpBody>

Throws:

IOException

set$Xgafv

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread setAccessToken(String accessToken)

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<HttpBody>

setAlt

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread setAlt(String alt)

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<HttpBody>

setCallback

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread setCallback(String callback)

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<HttpBody>

setFields

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread 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.FhirStores.Fhir.Vread setUploadProtocol(String uploadProtocol)

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadProtocol in class CloudHealthcareRequest<HttpBody>

getName

public String getName()

The name of the resource version to retrieve.

setName

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread setName(String name)

The name of the resource version to retrieve.

set

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread set(String parameterName,
                                                                             Object value)

Overrides:

set in class CloudHealthcareRequest<HttpBody>