com.google.api.services.healthcare.v1beta1.model

Class ExecuteCohortRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.healthcare.v1beta1.model.ExecuteCohortRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExecuteCohortRequest
extends com.google.api.client.json.GenericJson

Request to execute a cohort definition from a FHIR store based on provided queries and sending the resulting subset of data to a specified sink.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
ExecuteCohortRequest()

Method Summary

Modifier and Type	Method and Description
ExecuteCohortRequest	clone()
String	getAt() Optional.
FHIRPathQuery	getFhirpathQuery() Return resources that match the specified FHIRPath expressions.
GoogleCloudHealthcareV1beta1FhirGcsDestination	getGcsDestination() The Cloud Storage output destination.
Boolean	getValidateOnly() Optional.
ExecuteCohortRequest	set(String fieldName, Object value)
ExecuteCohortRequest	setAt(String at) Optional.
ExecuteCohortRequest	setFhirpathQuery(FHIRPathQuery fhirpathQuery) Return resources that match the specified FHIRPath expressions.
ExecuteCohortRequest	setGcsDestination(GoogleCloudHealthcareV1beta1FhirGcsDestination gcsDestination) The Cloud Storage output destination.
ExecuteCohortRequest	setValidateOnly(Boolean validateOnly) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

ExecuteCohortRequest

public ExecuteCohortRequest()

Method Detail

getAt

public String getAt()

Optional. If provided, the queried resources will represent the state of the FHIR store at the given past timestamp. Runs the operation against the state of the store at this timestamp. State of the store is represented by the resource versions that were the current versions during the time specified or the resources that have not been updated since. Only works if the store has history enabled. Although users should be able to use this field to reproduce previous runs of the operation and get consistent results, there are a few cases where the past state of the store can be altered, thus resulting in no guarantee of reproducibility. For example, resource versions can be deleted using the purge method, or modified using ImportResourcesHistory.

Returns:

value or null for none

setAt

public ExecuteCohortRequest setAt(String at)

Optional. If provided, the queried resources will represent the state of the FHIR store at the given past timestamp. Runs the operation against the state of the store at this timestamp. State of the store is represented by the resource versions that were the current versions during the time specified or the resources that have not been updated since. Only works if the store has history enabled. Although users should be able to use this field to reproduce previous runs of the operation and get consistent results, there are a few cases where the past state of the store can be altered, thus resulting in no guarantee of reproducibility. For example, resource versions can be deleted using the purge method, or modified using ImportResourcesHistory.

Parameters:

at - at or null for none

getFhirpathQuery

public FHIRPathQuery getFhirpathQuery()

Return resources that match the specified FHIRPath expressions.

Returns:

value or null for none

setFhirpathQuery

public ExecuteCohortRequest setFhirpathQuery(FHIRPathQuery fhirpathQuery)

Return resources that match the specified FHIRPath expressions.

Parameters:

fhirpathQuery - fhirpathQuery or null for none

getGcsDestination

public GoogleCloudHealthcareV1beta1FhirGcsDestination getGcsDestination()

The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one or more objects per resource type depending on the volume of the resources exported. When there is only one object per resource type, the object name is in the form of `{operation_id}_{resource_type}`. When there are multiple objects for a given resource type, the object names are in the form of `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited JSON, and each line is a FHIR resource.

Returns:

value or null for none

setGcsDestination

public ExecuteCohortRequest setGcsDestination(GoogleCloudHealthcareV1beta1FhirGcsDestination gcsDestination)

The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one or more objects per resource type depending on the volume of the resources exported. When there is only one object per resource type, the object name is in the form of `{operation_id}_{resource_type}`. When there are multiple objects for a given resource type, the object names are in the form of `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited JSON, and each line is a FHIR resource.

Parameters:

gcsDestination - gcsDestination or null for none

getValidateOnly

public Boolean getValidateOnly()

Optional. If true, the request will be validated but no cohort execution will be run.

Returns:

value or null for none

setValidateOnly

public ExecuteCohortRequest setValidateOnly(Boolean validateOnly)

Optional. If true, the request will be validated but no cohort execution will be run.

Parameters:

validateOnly - validateOnly or null for none

set

public ExecuteCohortRequest set(String fieldName,
                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExecuteCohortRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson