Method: hl7V2Stores.rollback

Full name: projects.locations.datasets.hl7V2Stores.rollback

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 operations.get.

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.

HTTP request

POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:rollback

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. The name of the HL7v2 store to rollback, in the format of "projects/{projectId}/locations/{locationId}/datasets/{datasetId} /hl7V2Stores/{hl7v2_store_id}".

name

string

Required. The name of the HL7v2 store to rollback, in the format of "projects/{projectId}/locations/{locationId}/datasets/{datasetId} /hl7V2Stores/{hl7v2_store_id}".

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "rollbackTime": string, "force": boolean, "changeType": enum(`ChangeType`), "resultGcsBucket": string, "inputGcsObject": string, "excludeRollbacks": boolean, "filteringFields": { object(`RollbackHL7MessagesFilteringFields`) } }

{
  "rollbackTime": string,
  "force": boolean,
  "changeType": enum(ChangeType),
  "resultGcsBucket": string,
  "inputGcsObject": string,
  "excludeRollbacks": boolean,
  "filteringFields": {
    object(RollbackHL7MessagesFilteringFields)
  }
}

Fields
`rollbackTime`	`string(Timestamp format)` Required. Times point to rollback to. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`force`	`boolean` Optional. When enabled, changes will be reverted without explicit confirmation.
`changeType`	`enum(ChangeType)` Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type.
`resultGcsBucket`	`string` Required. Bucket to deposit result
`inputGcsObject`	`string` Optional. Cloud storage object containing list of {resourceId} lines, identifying resources to be reverted
`excludeRollbacks`	`boolean` Optional. Specifies whether to exclude earlier rollbacks.
`filteringFields`	`object(RollbackHL7MessagesFilteringFields)` Optional. Parameters for filtering.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-healthcare
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ChangeType

Type of transaction to execute during HL7v2 message rollback

Enums
`CHANGE_TYPE_UNSPECIFIED`	When unspecified, revert all transactions
`ALL`	All transactions
`CREATE`	Revert only CREATE transactions
`UPDATE`	Revert only Update transactions
`DELETE`	Revert only Delete transactions

RollbackHL7MessagesFilteringFields

Filtering fields for an HL7v2 rollback. Currently only supports a list of operation ids to roll back.

JSON representation
{ "operationIds": [ string ] }

Fields

Fields
`operationIds[]`	`string` Optional. A list of operation IDs to roll back.

operationIds[]

string

Optional. A list of operation IDs to roll back.