com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData

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.ConsentStores.QueryAccessibleData

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.ConsentStores

public class CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData
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	QueryAccessibleData(String consentStore, QueryAccessibleDataRequest content) Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination.

Method Summary

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

QueryAccessibleData

protected QueryAccessibleData(String consentStore,
                              QueryAccessibleDataRequest content)

Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). For example, the following sample log entry shows a `failed to evaluate consent policy` error that occurred during a QueryAccessibleData call to consent store `projects/{project_id}/locations/{location_id}/datase ts/{dataset_id}/consentStores/{consent_store_id}`. ```json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/loc ations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_i d}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" ``` Create a request for the method "consentStores.queryAccessibleData". 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.

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

Parameters:

consentStore - Required. Name of the consent store to retrieve User data mappings from.

content - the QueryAccessibleDataRequest

Since:

1.13

Method Detail

set$Xgafv

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData setAccessToken(String accessToken)

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<Operation>

setAlt

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData setAlt(String alt)

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<Operation>

setCallback

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData setCallback(String callback)

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<Operation>

setFields

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData 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.ConsentStores.QueryAccessibleData setUploadProtocol(String uploadProtocol)

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadProtocol in class CloudHealthcareRequest<Operation>

getConsentStore

public String getConsentStore()

Required. Name of the consent store to retrieve User data mappings from.

setConsentStore

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData setConsentStore(String consentStore)

Required. Name of the consent store to retrieve User data mappings from.

set

public CloudHealthcare.Projects.Locations.Datasets.ConsentStores.QueryAccessibleData set(String parameterName,
                                                                                         Object value)

Overrides:

set in class CloudHealthcareRequest<Operation>