class ProjectsLocationsDatasetsHl7V2Stores extends Resource (View source)

The "hl7V2Stores" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $hl7V2Stores = $healthcareService->projects_locations_datasets_hl7V2Stores;

Methods

create(string $parent, Hl7V2Store $postBody, array $optParams = [])

Creates a new HL7v2 store within the parent dataset. (hl7V2Stores.create)

delete(string $name, array $optParams = [])

Deletes the specified HL7v2 store and removes all messages that it contains.

export(string $name, ExportMessagesRequest $postBody, array $optParams = [])

Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field.

get(string $name, array $optParams = [])

Gets the specified HL7v2 store. (hl7V2Stores.get)

getHL7v2StoreMetrics(string $name, array $optParams = [])

Gets metrics associated with the HL7v2 store.

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (hl7V2Stores.getIamPolicy)

import(string $name, ImportMessagesRequest $postBody, array $optParams = [])

Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

listProjectsLocationsDatasetsHl7V2Stores(string $parent, array $optParams = [])

Lists the HL7v2 stores in the given dataset.

patch(string $name, Hl7V2Store $postBody, array $optParams = [])

Updates the HL7v2 store. (hl7V2Stores.patch)

rollback(string $name, RollbackHl7V2MessagesRequest $postBody, array $optParams = [])

Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (hl7V2Stores.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

Hl7V2Store create(string $parent, Hl7V2Store $postBody, array $optParams = [])

Creates a new HL7v2 store within the parent dataset. (hl7V2Stores.create)

Parameters

string $parent

Required. The name of the dataset this HL7v2 store belongs to.

Hl7V2Store $postBody
array $optParams

Optional parameters.

Return Value

Hl7V2Store

Exceptions

Exception

HealthcareEmpty delete(string $name, array $optParams = [])

Deletes the specified HL7v2 store and removes all messages that it contains.

(hl7V2Stores.delete)

Parameters

string $name

Required. The resource name of the HL7v2 store to delete.

array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

Operation export(string $name, ExportMessagesRequest $postBody, array $optParams = [])

Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field.

The metadata field type for this operation is OperationMetadata. (hl7V2Stores.export)

Parameters

string $name

Required. The name of the source HL7v2 store, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/h l7v2Stores/{hl7v2_store_id}

ExportMessagesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Hl7V2Store get(string $name, array $optParams = [])

Gets the specified HL7v2 store. (hl7V2Stores.get)

Parameters

string $name

Required. The resource name of the HL7v2 store to get.

array $optParams

Optional parameters.

Return Value

Hl7V2Store

Exceptions

Exception

Hl7V2StoreMetrics getHL7v2StoreMetrics(string $name, array $optParams = [])

Gets metrics associated with the HL7v2 store.

(hl7V2Stores.getHL7v2StoreMetrics)

Parameters

string $name

Required. The resource name of the HL7v2 store to get metrics for, in the format projects/{project_id}/locations/{location_id}/dat asets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

array $optParams

Optional parameters.

Return Value

Hl7V2StoreMetrics

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (hl7V2Stores.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation import(string $name, ImportMessagesRequest $postBody, array $optParams = [])

Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. (hl7V2Stores.import)

Parameters

string $name

Required. The name of the target HL7v2 store, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/h l7v2Stores/{hl7v2_store_id}

ImportMessagesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

ListHl7V2StoresResponse listProjectsLocationsDatasetsHl7V2Stores(string $parent, array $optParams = [])

Lists the HL7v2 stores in the given dataset.

(hl7V2Stores.listProjectsLocationsDatasetsHl7V2Stores)

Parameters

string $parent

Required. Name of the dataset.

array $optParams

Optional parameters.

Return Value

ListHl7V2StoresResponse

Exceptions

Exception

Hl7V2Store patch(string $name, Hl7V2Store $postBody, array $optParams = [])

Updates the HL7v2 store. (hl7V2Stores.patch)

Parameters

string $name

Identifier. Resource name of the HL7v2 store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Sto res/{hl7v2_store_id}.

Hl7V2Store $postBody
array $optParams

Optional parameters.

Return Value

Hl7V2Store

Exceptions

Exception

Operation rollback(string $name, RollbackHl7V2MessagesRequest $postBody, array $optParams = [])

Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. (hl7V2Stores.rollback)

Parameters

string $name

Required. The name of the HL7v2 store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7V2Stores/{hl7v2_store_id}".

RollbackHl7V2MessagesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (hl7V2Stores.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (hl7V2Stores.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception