com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores.ExecuteCohort

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.FhirStores.ExecuteCohort

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.FhirStores

public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.ExecuteCohort
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	ExecuteCohort(String name, ExecuteCohortRequest content) Executes and materializes a cohort definition from a FHIR store.

Method Summary

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

ExecuteCohort

protected ExecuteCohort(String name,
                        ExecuteCohortRequest content)

Executes and materializes a cohort definition from a FHIR store. This method returns an Operation that can be used to track the status of the cohort execution by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how- tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. Create a request for the method "fhirStores.executeCohort". 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.

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

Parameters:

name - Required. The name of the FHIR store to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_stor e_id}`.

content - the ExecuteCohortRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: CloudHealthcareRequest

OAuth access token.

Overrides:

setAccessToken in class CloudHealthcareRequest<Operation>

setAlt

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

Description copied from class: CloudHealthcareRequest

Data format for response.

Overrides:

setAlt in class CloudHealthcareRequest<Operation>

setCallback

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

Description copied from class: CloudHealthcareRequest

JSONP

Overrides:

setCallback in class CloudHealthcareRequest<Operation>

setFields

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

Description copied from class: CloudHealthcareRequest

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

Overrides:

setUploadProtocol in class CloudHealthcareRequest<Operation>

getName

public String getName()

Required. The name of the FHIR store to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.

setName

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

Required. The name of the FHIR store to query, in the format `projects/{project_id}/l ocations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.

set

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

Overrides:

set in class CloudHealthcareRequest<Operation>