Class: Google::Apis::HealthcareV1::Hl7V2NotificationConfig

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

Overview

Specifies where and whether to send notifications upon changes to a data store.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Hl7V2NotificationConfig

Returns a new instance of Hl7V2NotificationConfig.



1159
1160
1161
# File 'generated/google/apis/healthcare_v1/classes.rb', line 1159

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

Instance Attribute Details

#filterString

Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. Syntax: https://cloud.google.com/appengine/docs/ standard/python/search/query_strings The following fields and functions are available for filtering: * message_type, from the MSH-9.1 field. For example, NOT message_type = "ADT". * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, send_date < "2017-01-02". * send_time, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH- 7 segment. For example, send_time < "2017-01-02T00:00:00-05:00". * send_facility, the care center that the message came from, from the MSH-4 segment. For example, send_facility = "ABC". * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId(" 123456", "MRN"). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels."priority"="high". The operator :* can be used to assert the existence of a label. For example, labels."priority":*. Corresponds to the JSON property filter

Returns:

  • (String)


1139
1140
1141
# File 'generated/google/apis/healthcare_v1/classes.rb', line 1139

def filter
  @filter
end

#pubsub_topicString

The Cloud 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's 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-PROJECT_NUMBER@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 cannot be published to Cloud 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)


1157
1158
1159
# File 'generated/google/apis/healthcare_v1/classes.rb', line 1157

def pubsub_topic
  @pubsub_topic
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1164
1165
1166
1167
# File 'generated/google/apis/healthcare_v1/classes.rb', line 1164

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