Class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource

The "hl7V2Stores" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource

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

Assembly: Google.Apis.CloudHealthcare.v1.dll

Syntax

public class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource

Constructors

Hl7V2StoresResource(IClientService)

Constructs a new resource.

Declaration

public Hl7V2StoresResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Messages

Gets the Messages resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource Messages { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource

Methods

Create(Hl7V2Store, string)

Creates a new HL7v2 store within the parent dataset.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.CreateRequest

Delete(string)

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

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.DeleteRequest

Export(ExportMessagesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ExportRequest Export(ExportMessagesRequest body, string name)

Parameters

Type	Name	Description
ExportMessagesRequest	body	The body of the request.
string	name	Required. The name of the source HL7v2 store, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ExportRequest

Get(string)

Gets the specified HL7v2 store.

Declaration

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

Parameters

Type	Name	Description
string	name	Required. The resource name of the HL7v2 store to get.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetRequest

GetHL7v2StoreMetrics(string)

Gets metrics associated with the HL7v2 store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetHL7v2StoreMetricsRequest GetHL7v2StoreMetrics(string name)

Parameters

Type	Name	Description
string	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_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetHL7v2StoreMetricsRequest

GetIamPolicy(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetIamPolicyRequest

Import(ImportMessagesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ImportRequest Import(ImportMessagesRequest body, string name)

Parameters

Type	Name	Description
ImportMessagesRequest	body	The body of the request.
string	name	Required. The name of the target HL7v2 store, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ImportRequest

List(string)

Lists the HL7v2 stores in the given dataset.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. Name of the dataset.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ListRequest

Patch(Hl7V2Store, string)

Updates the HL7v2 store.

Declaration

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

Parameters

Type	Name	Description
Hl7V2Store	body	The body of the request.
string	name	Identifier. Resource name of the HL7v2 store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.PatchRequest

Rollback(RollbackHl7V2MessagesRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.RollbackRequest Rollback(RollbackHl7V2MessagesRequest body, string name)

Parameters

Type	Name	Description
RollbackHl7V2MessagesRequest	body	The body of the request.
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}".

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.RollbackRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.TestIamPermissionsRequest