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

Class FhirNotificationConfig

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Contains the configuration for FHIR notifications.

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

Method Summary

Modifier and Type	Method and Description
FhirNotificationConfig	clone()
String	getPubsubTopic() The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on.
Boolean	getSendFullResource() Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation.
Boolean	getSendPreviousResourceOnDelete() Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource.
FhirNotificationConfig	set(String fieldName, Object value)
FhirNotificationConfig	setPubsubTopic(String pubsubTopic) The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on.
FhirNotificationConfig	setSendFullResource(Boolean sendFullResource) Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation.
FhirNotificationConfig	setSendPreviousResourceOnDelete(Boolean sendPreviousResourceOnDelete) Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource.

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

FhirNotificationConfig

public FhirNotificationConfig()

Method Detail

getPubsubTopic

public String getPubsubTopic()

The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare- api/docs/permissions-healthcare-api-gcp- products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).

Returns:

value or null for none

setPubsubTopic

public FhirNotificationConfig setPubsubTopic(String pubsubTopic)

The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare- api/docs/permissions-healthcare-api-gcp- products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).

Parameters:

pubsubTopic - pubsubTopic or null for none

getSendFullResource

public Boolean getSendFullResource()

Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.

Returns:

value or null for none

setSendFullResource

public FhirNotificationConfig setSendFullResource(Boolean sendFullResource)

Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.

Parameters:

sendFullResource - sendFullResource or null for none

getSendPreviousResourceOnDelete

public Boolean getSendPreviousResourceOnDelete()

Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.

Returns:

value or null for none

setSendPreviousResourceOnDelete

public FhirNotificationConfig setSendPreviousResourceOnDelete(Boolean sendPreviousResourceOnDelete)

Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.

Parameters:

sendPreviousResourceOnDelete - sendPreviousResourceOnDelete or null for none

set

public FhirNotificationConfig set(String fieldName,
                                  Object value)

Overrides:

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

clone

public FhirNotificationConfig clone()

Overrides:

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