Method: projects.locations.backupVaults.dataSources.finalizeBackup

Internal only. Finalize a backup that was started by a call to dataSources.initiateBackup.

HTTP request

POST https://backupdr.googleapis.com/v1/{dataSource=projects/*/locations/*/backupVaults/*/dataSources/*}:finalizeBackup

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataSource

string

Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requestId": string,
  "backupId": string,
  "description": string,
  "consistencyTime": string,
  "recoveryRangeStartTime": string,
  "recoveryRangeEndTime": string,
  "retentionDuration": string
}
Fields
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
backupId

string

Required. Resource ID of the Backup resource to be finalized. This must be the same backupId that was used in the InitiateBackupRequest.
description

string

This will be assigned to the description field of the newly created Backup.
consistencyTime

string (Timestamp format)

The point in time when this backup was captured from the source. This will be assigned to the consistencyTime field of the newly created Backup.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
recoveryRangeStartTime

string (Timestamp format)

The earliest timestamp of data available in this Backup. This will set on the newly created Backup.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
recoveryRangeEndTime

string (Timestamp format)

The latest timestamp of data available in this Backup. This will be set on the newly created Backup.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
retentionDuration

string (Duration format)

The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the dataSource resource:

  • backupdr.bvdataSources.finalizeBackup

For more information, see the IAM documentation.