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

Class ConsentConfig

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.ConsentConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.

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
ConsentConfig()

Method Summary

Modifier and Type	Method and Description
ConsentConfig	clone()
AccessDeterminationLogConfig	getAccessDeterminationLogConfig() Optional.
Boolean	getAccessEnforced() Optional.
ConsentHeaderHandling	getConsentHeaderHandling() Optional.
List<String>	getEnforcedAdminConsents() The versioned names of the enforced admin Consent resource(s), in the format `projects/{project _id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resour ce_id}/_history/{version_id}`.
String	getVersion() Required.
ConsentConfig	set(String fieldName, Object value)
ConsentConfig	setAccessDeterminationLogConfig(AccessDeterminationLogConfig accessDeterminationLogConfig) Optional.
ConsentConfig	setAccessEnforced(Boolean accessEnforced) Optional.
ConsentConfig	setConsentHeaderHandling(ConsentHeaderHandling consentHeaderHandling) Optional.
ConsentConfig	setEnforcedAdminConsents(List<String> enforcedAdminConsents) The versioned names of the enforced admin Consent resource(s), in the format `projects/{project _id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resour ce_id}/_history/{version_id}`.
ConsentConfig	setVersion(String version) Required.

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

ConsentConfig

public ConsentConfig()

Method Detail

getAccessDeterminationLogConfig

public AccessDeterminationLogConfig getAccessDeterminationLogConfig()

Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used.

Returns:

value or null for none

setAccessDeterminationLogConfig

public ConsentConfig setAccessDeterminationLogConfig(AccessDeterminationLogConfig accessDeterminationLogConfig)

Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used.

Parameters:

accessDeterminationLogConfig - accessDeterminationLogConfig or null for none

getAccessEnforced

public Boolean getAccessEnforced()

Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.

Returns:

value or null for none

setAccessEnforced

public ConsentConfig setAccessEnforced(Boolean accessEnforced)

Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.

Parameters:

accessEnforced - accessEnforced or null for none

getConsentHeaderHandling

public ConsentHeaderHandling getConsentHeaderHandling()

Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header.

Returns:

value or null for none

setConsentHeaderHandling

public ConsentConfig setConsentHeaderHandling(ConsentHeaderHandling consentHeaderHandling)

Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header.

Parameters:

consentHeaderHandling - consentHeaderHandling or null for none

getEnforcedAdminConsents

public List<String> getEnforcedAdminConsents()

The versioned names of the enforced admin Consent resource(s), in the format `projects/{project _id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resour ce_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_st ore_id}/fhir/Consent/{resource_id}`. This field can only be updated using ApplyAdminConsents.

Returns:

value or null for none

setEnforcedAdminConsents

public ConsentConfig setEnforcedAdminConsents(List<String> enforcedAdminConsents)

The versioned names of the enforced admin Consent resource(s), in the format `projects/{project _id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resour ce_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_st ore_id}/fhir/Consent/{resource_id}`. This field can only be updated using ApplyAdminConsents.

Parameters:

enforcedAdminConsents - enforcedAdminConsents or null for none

getVersion

public String getVersion()

Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.

Returns:

value or null for none

setVersion

public ConsentConfig setVersion(String version)

Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.

Parameters:

version - version or null for none

set

public ConsentConfig set(String fieldName,
                         Object value)

Overrides:

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

clone

public ConsentConfig clone()

Overrides:

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