Class: Google::Apis::HealthcareV1beta1::FhirNotificationConfig

Inherits:

Object

• Object
• Google::Apis::HealthcareV1beta1::FhirNotificationConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/healthcare_v1beta1/classes.rb,
lib/google/apis/healthcare_v1beta1/representations.rb,
lib/google/apis/healthcare_v1beta1/representations.rb

Overview

Contains the configuration for FHIR notifications.

Instance Attribute Summary

• #pubsub_topic ⇒ String

  The Pub/Sub topic that notifications of changes are published on.

• #send_full_resource ⇒ Boolean (also: #send_full_resource?)

  Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation.

Instance Method Summary

• #initialize(**args) ⇒ FhirNotificationConfig constructor

  A new instance of FhirNotificationConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ FhirNotificationConfig

Returns a new instance of FhirNotificationConfig.

# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2102

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#pubsub_topic ⇒ String

The Pub/Sub 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 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. 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. Corresponds to the JSON property pubsubTopic

Returns:

• (String)

# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2088

def pubsub_topic
  @pubsub_topic
end

#send_full_resource ⇒ Boolean Also known as: send_full_resource?

Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. 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. Corresponds to the JSON property sendFullResource

Returns:

• (Boolean)

# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2099

def send_full_resource
  @send_full_resource
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/healthcare_v1beta1/classes.rb', line 2107

def update!(**args)
  @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
  @send_full_resource = args[:send_full_resource] if args.key?(:send_full_resource)
end