Class: Google::Apis::HealthcareV1::FhirNotificationConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/healthcare_v1/classes.rb,
lib/google/apis/healthcare_v1/representations.rb,
lib/google/apis/healthcare_v1/representations.rb

Overview

Contains the configuration for FHIR notifications.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FhirNotificationConfig

Returns a new instance of FhirNotificationConfig.



1845
1846
1847
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1845

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

Instance Attribute Details

#pubsub_topicString

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 (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. Corresponds to the JSON property pubsubTopic

Returns:

  • (String)


1825
1826
1827
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1825

def pubsub_topic
  @pubsub_topic
end

#send_full_resourceBoolean Also known as: send_full_resource?

Whether to send full FHIR resource to this Pub/Sub topic. Corresponds to the JSON property sendFullResource

Returns:

  • (Boolean)


1830
1831
1832
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1830

def send_full_resource
  @send_full_resource
end

#send_previous_resource_on_deleteBoolean Also known as: send_previous_resource_on_delete?

Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. 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. Corresponds to the JSON property sendPreviousResourceOnDelete

Returns:

  • (Boolean)


1842
1843
1844
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1842

def send_previous_resource_on_delete
  @send_previous_resource_on_delete
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1850
1851
1852
1853
1854
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1850

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)
  @send_previous_resource_on_delete = args[:send_previous_resource_on_delete] if args.key?(:send_previous_resource_on_delete)
end