KMP PHP API Reference

TenantRestoreDrillService
in package

Table of Contents

Constants

JOB_TYPE  : mixed = 'tenant_restore_drill'

Properties

$platformConnection  : Connection
$verifier  : TenantRestoreDrillVerifierInterface

Methods

__construct()  : mixed
planRecentDrill()  : TenantRestoreDrillResult
assertBackupStillCompleted()  : void
assertSafeSlug()  : void
findRecentCompletedBackup()  : array<string, mixed>|null
finishJob()  : void
insertJob()  : string
lockBackupArchive()  : bool
nullableString()  : string|null
scrubError()  : string
unlockBackupArchive()  : void

Constants

Properties

Methods

planRecentDrill()

public planRecentDrill([string|null $tenantSlug = null ][, int $lookbackHours = 36 ][, bool $executeRestore = false ][, bool $confirmDestructive = false ]) : TenantRestoreDrillResult
Parameters
$tenantSlug : string|null = null
$lookbackHours : int = 36
$executeRestore : bool = false
$confirmDestructive : bool = false
Return values
TenantRestoreDrillResult

assertBackupStillCompleted()

private assertBackupStillCompleted(string $backupId) : void
Parameters
$backupId : string

findRecentCompletedBackup()

private findRecentCompletedBackup(string|null $tenantSlug, int $lookbackHours) : array<string, mixed>|null
Parameters
$tenantSlug : string|null
$lookbackHours : int
Return values
array<string, mixed>|null

finishJob()

private finishJob(string $jobId, string $status, string|null $lastError) : void
Parameters
$jobId : string
$status : string
$lastError : string|null

insertJob()

private insertJob(string|null $tenantId, string $status, array<string, mixed> $parameters[, string|null $lastError = null ]) : string
Parameters
$tenantId : string|null
$status : string
$parameters : array<string, mixed>

Job parameters

$lastError : string|null = null
Return values
string

lockBackupArchive()

private lockBackupArchive(string $backupId) : bool
Parameters
$backupId : string
Return values
bool

nullableString()

private nullableString(mixed $value) : string|null
Parameters
$value : mixed
Return values
string|null

scrubError()

private scrubError(string $message) : string
Parameters
$message : string
Return values
string
On this page

Search results