Message (Cloud Healthcare API v1beta1-rev20241009-2.0.0)

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.Message

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Message
extends com.google.api.client.json.GenericJson
```
A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
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

Message()

Constructors
Constructor and Description
`Message()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`clone()`
`byte[]`	`decodeData()` Required.
`Message`	`encodeData(byte[] data)` Required.
`String`	`getCreateTime()` Output only.
`String`	`getData()` Required.
`Map<String,String>`	`getLabels()` User-supplied key-value pairs used to organize HL7v2 stores.
`String`	`getMessageType()` The message type for this message.
`String`	`getName()` Output only.
`ParsedData`	`getParsedData()` Output only.
`List<PatientId>`	`getPatientIds()` All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
`SchematizedData`	`getSchematizedData()` The parsed version of the raw message data schematized according to this store's schemas and type definitions.
`String`	`getSendFacility()` The hospital that this message came from.
`String`	`getSendTime()` The datetime the sending application sent this message.
`Message`	`set(String fieldName, Object value)`
`Message`	`setCreateTime(String createTime)` Output only.
`Message`	`setData(String data)` Required.
`Message`	`setLabels(Map<String,String> labels)` User-supplied key-value pairs used to organize HL7v2 stores.
`Message`	`setMessageType(String messageType)` The message type for this message.
`Message`	`setName(String name)` Output only.
`Message`	`setParsedData(ParsedData parsedData)` Output only.
`Message`	`setPatientIds(List<PatientId> patientIds)` All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
`Message`	`setSchematizedData(SchematizedData schematizedData)` The parsed version of the raw message data schematized according to this store's schemas and type definitions.
`Message`	`setSendFacility(String sendFacility)` The hospital that this message came from.
`Message`	`setSendTime(String sendTime)` The datetime the sending application sent this message.

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
  - Message
```
public Message()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The datetime when the message was created. Set by the server.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Message setCreateTime(String createTime)
```
    Output only. The datetime when the message was created. Set by the server.
    
    Parameters:
    
    createTime - createTime or null for none
  - getData
```
public String getData()
```
    Required. Raw message bytes.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeData()
  - decodeData
```
public byte[] decodeData()
```
    Required. Raw message bytes.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getData()
  - setData
```
public Message setData(String data)
```
    Required. Raw message bytes.
    
    Parameters:
    
    data - data or null for none
    
    See Also:
    
    #encodeData()
  - encodeData
```
public Message encodeData(byte[] data)
```
    Required. Raw message bytes.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getLabels
```
public Map<String,String> getLabels()
```
    User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Message setLabels(Map<String,String> labels)
```
    User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.
    
    Parameters:
    
    labels - labels or null for none
  - getMessageType
```
public String getMessageType()
```
    The message type for this message. MSH-9.1.
    
    Returns:
    
    value or null for none
  - setMessageType
```
public Message setMessageType(String messageType)
```
    The message type for this message. MSH-9.1.
    
    Parameters:
    
    messageType - messageType or null for none
  - getName
```
public String getName()
```
    Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{locati on_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
    
    Returns:
    
    value or null for none
  - setName
```
public Message setName(String name)
```
    Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{locati on_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
    
    Parameters:
    
    name - name or null for none
  - getParsedData
```
public ParsedData getParsedData()
```
    Output only. The parsed version of the raw message data.
    
    Returns:
    
    value or null for none
  - setParsedData
```
public Message setParsedData(ParsedData parsedData)
```
    Output only. The parsed version of the raw message data.
    
    Parameters:
    
    parsedData - parsedData or null for none
  - getPatientIds
```
public List<PatientId> getPatientIds()
```
    All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
    
    Returns:
    
    value or null for none
  - setPatientIds
```
public Message setPatientIds(List<PatientId> patientIds)
```
    All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
    
    Parameters:
    
    patientIds - patientIds or null for none
  - getSchematizedData
```
public SchematizedData getSchematizedData()
```
    The parsed version of the raw message data schematized according to this store's schemas and type definitions.
    
    Returns:
    
    value or null for none
  - setSchematizedData
```
public Message setSchematizedData(SchematizedData schematizedData)
```
    The parsed version of the raw message data schematized according to this store's schemas and type definitions.
    
    Parameters:
    
    schematizedData - schematizedData or null for none
  - getSendFacility
```
public String getSendFacility()
```
    The hospital that this message came from. MSH-4.
    
    Returns:
    
    value or null for none
  - setSendFacility
```
public Message setSendFacility(String sendFacility)
```
    The hospital that this message came from. MSH-4.
    
    Parameters:
    
    sendFacility - sendFacility or null for none
  - getSendTime
```
public String getSendTime()
```
    The datetime the sending application sent this message. MSH-7.
    
    Returns:
    
    value or null for none
  - setSendTime
```
public Message setSendTime(String sendTime)
```
    The datetime the sending application sent this message. MSH-7.
    
    Parameters:
    
    sendTime - sendTime or null for none
  - set
```
public Message set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Message clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Message

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Message

Method Detail

getCreateTime

setCreateTime

getData

decodeData

setData

encodeData

getLabels

setLabels

getMessageType

setMessageType

getName

setName

getParsedData

setParsedData

getPatientIds

setPatientIds

getSchematizedData

setSchematizedData

getSendFacility

setSendFacility

getSendTime

setSendTime

set

clone