Class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource

The "messages" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudHealthcare.v1beta1

Assembly: Google.Apis.CloudHealthcare.v1beta1.dll

Syntax

public class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource

Constructors

MessagesResource(IClientService)

Constructs a new resource.

Declaration

public MessagesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

BatchGet(string)

Gets multiple messages in the given HL7v2 store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.BatchGetRequest BatchGet(string parent)

Parameters

Type	Name	Description
string	parent	Required. Name of the HL7v2 store to retrieve messages from, in the format: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.BatchGetRequest

Create(CreateMessageRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.CreateRequest Create(CreateMessageRequest body, string parent)

Parameters

Type	Name	Description
CreateMessageRequest	body	The body of the request.
string	parent	Required. The name of the HL7v2 store this message belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.CreateRequest

Delete(string)

Deletes an HL7v2 message.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the HL7v2 message to delete.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.DeleteRequest

Get(string)

Gets an HL7v2 message.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the HL7v2 message to retrieve.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.GetRequest

Ingest(IngestMessageRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.IngestRequest Ingest(IngestMessageRequest body, string parent)

Parameters

Type	Name	Description
IngestMessageRequest	body	The body of the request.
string	parent	Required. The name of the HL7v2 store this message belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.IngestRequest

List(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. Name of the HL7v2 store to retrieve messages from.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest

Patch(Message, string)

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can't 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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.PatchRequest Patch(Message body, string name)

Parameters

Type	Name	Description
Message	body	The body of the request.
string	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.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.PatchRequest