Class: Google::Apis::HealthcareV1::ExportMessagesRequest
- Inherits:
-
Object
- Object
- Google::Apis::HealthcareV1::ExportMessagesRequest
- 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
Request to schedule an export.
Instance Attribute Summary collapse
-
#end_time ⇒ String
The end of the range in
send_time
(MSH.7, https://www.hl7.org/documentcenter/ public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. -
#filter ⇒ String
Restricts messages exported to those matching a filter, only applicable to PubsubDestination.
-
#gcs_destination ⇒ Google::Apis::HealthcareV1::GcsDestination
The Cloud Storage output destination.
-
#pubsub_destination ⇒ Google::Apis::HealthcareV1::PubsubDestination
The Pub/Sub output destination.
-
#start_time ⇒ String
The start of the range in
send_time
(MSH.7, https://www.hl7.org/ documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH. htm) to process.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ExportMessagesRequest
constructor
A new instance of ExportMessagesRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ExportMessagesRequest
Returns a new instance of ExportMessagesRequest.
1638 1639 1640 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1638 def initialize(**args) update!(**args) end |
Instance Attribute Details
#end_time ⇒ String
The end of the range in send_time
(MSH.7, https://www.hl7.org/documentcenter/
public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process.
If not specified, the time when the export is scheduled is used. This value
has to come after the start_time
defined below. Only messages whose
send_time
lies in the range start_time
(inclusive) to end_time
(exclusive)
are exported.
Corresponds to the JSON property endTime
1573 1574 1575 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1573 def end_time @end_time end |
#filter ⇒ String
Restricts messages exported to those matching a filter, only applicable to
PubsubDestination. The following syntax is available: * A string field value
can be written as text inside quotation marks, for example "query text"
. The
only valid relational operation for text fields is equality (=
), where text
is searched within the field, rather than having the field be equal to the
text. For example, "Comment = great"
returns messages with great
in the
comment field. * A number field value can be written as an integer, a decimal,
or an exponential. The valid relational operators for number fields are the
equality operator (=
), along with the less than/greater than operators (<
,
<=
, >
, >=
). Note that there is no inequality (!=
) operator. You can
prepend the NOT
operator to an expression to negate it. * A date field value
must be written in the yyyy-mm-dd
format. Fields with date and time use the
RFC3339 time format. Leading zeros are required for one-digit months and days.
The valid relational operators for date fields are the equality operator (=
)
, along with the less than/greater than operators (<
, <=
, >
, >=
). Note
that there is no inequality (!=
) operator. You can prepend the NOT
operator to an expression to negate it. * Multiple field query expressions can
be combined in one query by adding AND
or OR
operators between the
expressions. If a boolean operator appears within a quoted string, it is not
treated as special, and is just another part of the character string to be
matched. You can prepend the NOT
operator to an expression to negate it. 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"
. * create_time
, the timestamp when the message
was created in the HL7v2 store. Use the RFC3339 time format for comparisons.
For example, create_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"
. Note: The filter will be applied to every
message in the HL7v2 store whose send_time
lies in the range defined by the
start_time
and the end_time
. Even if the filter only matches a small set of
messages, the export operation can still take a long time to finish when a lot
of messages are between the specified start_time
and end_time
range.
Corresponds to the JSON property filter
1613 1614 1615 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1613 def filter @filter end |
#gcs_destination ⇒ Google::Apis::HealthcareV1::GcsDestination
The Cloud Storage output destination. The Cloud Healthcare Service Agent
requires the roles/storage.objectAdmin
Cloud IAM roles on the Cloud Storage
location.
Corresponds to the JSON property gcsDestination
1620 1621 1622 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1620 def gcs_destination @gcs_destination end |
#pubsub_destination ⇒ Google::Apis::HealthcareV1::PubsubDestination
The Pub/Sub output destination. The Cloud Healthcare Service Agent requires
the roles/pubsub.publisher
Cloud IAM role on the Pub/Sub topic.
Corresponds to the JSON property pubsubDestination
1626 1627 1628 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1626 def pubsub_destination @pubsub_destination end |
#start_time ⇒ String
The start of the range in send_time
(MSH.7, https://www.hl7.org/
documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.
htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is
used. This value has to come before the end_time
defined below. Only
messages whose send_time
lies in the range start_time
(inclusive) to
end_time
(exclusive) are exported.
Corresponds to the JSON property startTime
1636 1637 1638 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1636 def start_time @start_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1643 1644 1645 1646 1647 1648 1649 |
# File 'lib/google/apis/healthcare_v1/classes.rb', line 1643 def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @filter = args[:filter] if args.key?(:filter) @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) @pubsub_destination = args[:pubsub_destination] if args.key?(:pubsub_destination) @start_time = args[:start_time] if args.key?(:start_time) end |