com.google.api.services.healthcare.v1

Class CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages

java.lang.Object

com.google.api.services.healthcare.v1.CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores

public class CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages
extends Object

The "messages" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Create
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Delete
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Get
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Ingest
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.List
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Patch

Constructor Summary

Constructors

Constructor and Description
Messages()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Create	create(String parent, CreateMessageRequest content) Parses and stores an HL7v2 message.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Delete	delete(String name) Deletes an HL7v2 message.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Get	get(String name) Gets an HL7v2 message.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Ingest	ingest(String parent, IngestMessageRequest content) Parses and stores an HL7v2 message.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.List	list(String parent) Lists all the messages in the given HL7v2 store with support for filtering.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Patch	patch(String name, Message content) Update the message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Messages

public Messages()

Method Detail

create

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Create create(String parent,
                                                                                      CreateMessageRequest content)
                                                                               throws IOException

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. Create a request for the method "messages.create". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the HL7v2 store this message belongs to.

content - the CreateMessageRequest

Returns:

the request

Throws:

IOException

delete

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Delete delete(String name)
                                                                               throws IOException

Deletes an HL7v2 message. Create a request for the method "messages.delete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the HL7v2 message to delete.

Returns:

the request

Throws:

IOException

get

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Get get(String name)
                                                                         throws IOException

Gets an HL7v2 message. Create a request for the method "messages.get". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the HL7v2 message to retrieve.

Returns:

the request

Throws:

IOException

ingest

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Ingest ingest(String parent,
                                                                                      IngestMessageRequest content)
                                                                               throws IOException

Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments. Create a request for the method "messages.ingest". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the HL7v2 store this message belongs to.

content - the IngestMessageRequest

Returns:

the request

Throws:

IOException

list

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.List list(String parent)
                                                                           throws IOException

Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter. Create a request for the method "messages.list". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the HL7v2 store to retrieve messages from.

Returns:

the request

Throws:

IOException

patch

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages.Patch patch(String name,
                                                                                    Message content)
                                                                             throws IOException

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated. Create a request for the method "messages.patch". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id }/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.

content - the Message

Returns:

the request

Throws:

IOException