com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores

java.lang.Object

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets

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

The "hl7V2Stores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.CloudHealthcareImport
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Create
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Delete
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Export
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Get
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.GetHL7v2StoreMetrics
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.GetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.List
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages The "messages" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Patch
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Rollback
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.SetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
Hl7V2Stores()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Create	create(String parent, Hl7V2Store content) Creates a new HL7v2 store within the parent dataset.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Delete	delete(String name) Deletes the specified HL7v2 store and removes all messages that it contains.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Export	export(String name, ExportMessagesRequest content) Exports the messages to a destination.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Get	get(String name) Gets the specified HL7v2 store.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.GetHL7v2StoreMetrics	getHL7v2StoreMetrics(String name) Gets metrics associated with the HL7v2 store.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.CloudHealthcareImport	healthcareImport(String name, ImportMessagesRequest content) Import messages to the HL7v2 store by loading data from the specified sources.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.List	list(String parent) Lists the HL7v2 stores in the given dataset.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages	messages() An accessor for creating requests from the Messages collection.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Patch	patch(String name, Hl7V2Store content) Updates the HL7v2 store.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Rollback	rollback(String name, RollbackHl7V2MessagesRequest content) Rolls back messages from the HL7v2 store to the specified time.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hl7V2Stores

public Hl7V2Stores()

Method Detail

create

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

Creates a new HL7v2 store within the parent dataset. Create a request for the method "hl7V2Stores.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 dataset this HL7v2 store belongs to.

content - the Hl7V2Store

Returns:

the request

Throws:

IOException

delete

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

Deletes the specified HL7v2 store and removes all messages that it contains. Create a request for the method "hl7V2Stores.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 store to delete.

Returns:

the request

Throws:

IOException

export

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Export export(String name,
                                                                             ExportMessagesRequest content)
                                                                      throws IOException

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. Create a request for the method "hl7V2Stores.export". 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 name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_st ore_id}`

content - the ExportMessagesRequest

Returns:

the request

Throws:

IOException

get

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

Gets the specified HL7v2 store. Create a request for the method "hl7V2Stores.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 store to get.

Returns:

the request

Throws:

IOException

getHL7v2StoreMetrics

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.GetHL7v2StoreMetrics getHL7v2StoreMetrics(String name)
                                                                                                  throws IOException

Gets metrics associated with the HL7v2 store. Create a request for the method "hl7V2Stores.getHL7v2StoreMetrics". 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 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_st ore_id}`.

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.GetIamPolicy getIamPolicy(String resource)
                                                                                  throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "hl7V2Stores.getIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

healthcareImport

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.CloudHealthcareImport healthcareImport(String name,
                                                                                                      ImportMessagesRequest content)
                                                                                               throws IOException

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](https://cloud.google.com/healthcare/docs/how-tos/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. Create a request for the method "hl7V2Stores.import". 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 name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_st ore_id}`

content - the ImportMessagesRequest

Returns:

the request

Throws:

IOException

list

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

Lists the HL7v2 stores in the given dataset. Create a request for the method "hl7V2Stores.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 dataset.

Returns:

the request

Throws:

IOException

patch

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

Updates the HL7v2 store. Create a request for the method "hl7V2Stores.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 - Identifier. Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_st ore_id}`.

content - the Hl7V2Store

Returns:

the request

Throws:

IOException

rollback

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Rollback rollback(String name,
                                                                                 RollbackHl7V2MessagesRequest content)
                                                                          throws IOException

Rolls back messages from the HL7v2 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](https://cloud.google.com/healthcare/docs/how-tos/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. Create a request for the method "hl7V2Stores.rollback". 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 name of the HL7v2 store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7V2Stores/{hl7v2_store_id}".

content - the RollbackHl7V2MessagesRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.SetIamPolicy setIamPolicy(String resource,
                                                                                         SetIamPolicyRequest content)
                                                                                  throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "hl7V2Stores.setIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.TestIamPermissions testIamPermissions(String resource,
                                                                                                     TestIamPermissionsRequest content)
                                                                                              throws IOException

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. Create a request for the method "hl7V2Stores.testIamPermissions". 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:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

messages

public CloudHealthcare.Projects.Locations.Datasets.Hl7V2Stores.Messages messages()

An accessor for creating requests from the Messages collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Messages.List request = healthcare.messages().list(parameters ...)
 

Returns:

the resource collection