Class ExportMessagesRequest

Request to schedule an export.

Inheritance
object
ExportMessagesRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1beta1.Data
Assembly: Google.Apis.CloudHealthcare.v1beta1.dll
Syntax
public class ExportMessagesRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

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.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

Filter

Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination. 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.

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

GcsDestination

Export to a Cloud Storage destination.

Declaration
[JsonProperty("gcsDestination")]
public virtual GcsDestination GcsDestination { get; set; }
Property Value
Type Description
GcsDestination

PubsubDestination

Export messages to a Pub/Sub topic.

Declaration
[JsonProperty("pubsubDestination")]
public virtual PubsubDestination PubsubDestination { get; set; }
Property Value
Type Description
PubsubDestination

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

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.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

Implements