Google Cloud Backup Dr V1 Client - Class CleanupPhaseInfo (0.17.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class CleanupPhaseInfo.

Info for Cleanup phase execution.

Generated from protobuf message google.cloud.backupdr.v1.CleanupPhaseInfo

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ phase_state int

Output only. The state of this phase.

↳ error Google\Rpc\Status

Output only. Error details if the phase failed.

↳ start_time Google\Protobuf\Timestamp

Output only. Start time of the phase.

↳ end_time Google\Protobuf\Timestamp

Output only. End time of the phase.

↳ cleanup_duration Google\Protobuf\Duration

Output only. Time taken to perform the cleanup of restored resource.

↳ success_cleanup_rule RestoreVerificationCleanupRule

Output only. Snapshot of cleanup rule provided for this execution when execution is successful.

↳ failure_cleanup_rule RestoreVerificationCleanupRule

Output only. Snapshot of cleanup rule provided for this execution when execution is failed.

↳ cleanup_time Google\Protobuf\Timestamp

Output only. The time when the resources will be cleaned up.

getPhaseState

Output only. The state of this phase.

Returns
Type Description
int Enum of type PhaseState.

setPhaseState

Output only. The state of this phase.

Parameter
Name Description
var int

Enum of type PhaseState.

Returns
Type Description
$this

getError

Output only. Error details if the phase failed.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. Error details if the phase failed.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getStartTime

Output only. Start time of the phase.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. Start time of the phase.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Output only. End time of the phase.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. End time of the phase.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCleanupDuration

Output only. Time taken to perform the cleanup of restored resource.

Returns
Type Description
Google\Protobuf\Duration|null

hasCleanupDuration

clearCleanupDuration

setCleanupDuration

Output only. Time taken to perform the cleanup of restored resource.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getSuccessCleanupRule

Output only. Snapshot of cleanup rule provided for this execution when execution is successful.

Returns
Type Description
RestoreVerificationCleanupRule|null

hasSuccessCleanupRule

clearSuccessCleanupRule

setSuccessCleanupRule

Output only. Snapshot of cleanup rule provided for this execution when execution is successful.

Parameter
Name Description
var RestoreVerificationCleanupRule
Returns
Type Description
$this

getFailureCleanupRule

Output only. Snapshot of cleanup rule provided for this execution when execution is failed.

Returns
Type Description
RestoreVerificationCleanupRule|null

hasFailureCleanupRule

clearFailureCleanupRule

setFailureCleanupRule

Output only. Snapshot of cleanup rule provided for this execution when execution is failed.

Parameter
Name Description
var RestoreVerificationCleanupRule
Returns
Type Description
$this

getCleanupTime

Output only. The time when the resources will be cleaned up.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCleanupTime

clearCleanupTime

setCleanupTime

Output only. The time when the resources will be cleaned up.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this