com.google.api.services.healthcare.v1beta1.model

Class ExportMessagesRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.healthcare.v1beta1.model.ExportMessagesRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExportMessagesRequest
extends com.google.api.client.json.GenericJson

Request to schedule an export.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExportMessagesRequest()

Method Summary

Modifier and Type	Method and Description
ExportMessagesRequest	clone()
String	getEndTime() The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58 C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process.
String	getFilter() Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination.
GcsDestination	getGcsDestination() Export to a Cloud Storage destination.
PubsubDestination	getPubsubDestination() Export messages to a Pub/Sub topic.
String	getStartTime() The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E 58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process.
ExportMessagesRequest	set(String fieldName, Object value)
ExportMessagesRequest	setEndTime(String endTime) The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58 C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process.
ExportMessagesRequest	setFilter(String filter) Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination.
ExportMessagesRequest	setGcsDestination(GcsDestination gcsDestination) Export to a Cloud Storage destination.
ExportMessagesRequest	setPubsubDestination(PubsubDestination pubsubDestination) Export messages to a Pub/Sub topic.
ExportMessagesRequest	setStartTime(String startTime) The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E 58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ExportMessagesRequest

public ExportMessagesRequest()

Method Detail

getEndTime

public String getEndTime()

The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58 C1F9-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.

Returns:

value or null for none

setEndTime

public ExportMessagesRequest setEndTime(String endTime)

The end of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58 C1F9-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.

Parameters:

endTime - endTime or null for none

getFilter

public String getFilter()

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.

Returns:

value or null for none

setFilter

public ExportMessagesRequest setFilter(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.

Parameters:

filter - filter or null for none

getGcsDestination

public GcsDestination getGcsDestination()

Export to a Cloud Storage destination.

Returns:

value or null for none

setGcsDestination

public ExportMessagesRequest setGcsDestination(GcsDestination gcsDestination)

Export to a Cloud Storage destination.

Parameters:

gcsDestination - gcsDestination or null for none

getPubsubDestination

public PubsubDestination getPubsubDestination()

Export messages to a Pub/Sub topic.

Returns:

value or null for none

setPubsubDestination

public ExportMessagesRequest setPubsubDestination(PubsubDestination pubsubDestination)

Export messages to a Pub/Sub topic.

Parameters:

pubsubDestination - pubsubDestination or null for none

getStartTime

public String getStartTime()

The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E 58C1F9-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.

Returns:

value or null for none

setStartTime

public ExportMessagesRequest setStartTime(String startTime)

The start of the range in `send_time` (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E 58C1F9-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.

Parameters:

startTime - startTime or null for none

set

public ExportMessagesRequest set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExportMessagesRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson