Google Cloud Backup Dr V1 Client - Class BackupConfigDetails (0.13.0)

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

BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.

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

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ backup_config_source
string

Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".

↳ backup_config_source_display_name
string

Output only. The display name of the backup config source resource.

↳ type
int

Output only. The type of the backup config resource.

↳ state
int

Output only. The state of the backup config resource.

↳ pitr_settings
PitrSettings

Output only. Point in time recovery settings of the backup configuration resource.

↳ latest_successful_backup_time
Google\Protobuf\Timestamp

Output only. Timestamp of the latest successful backup created via this backup configuration.

↳ applicable_resource
string

Output only. The full resource name of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"

↳ backup_vault
string

Output only. The full resource name of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"

↳ backup_locations
array< BackupLocation >

The locations where the backups are to be stored.

↳ backup_dr_plan_config
BackupDrPlanConfig

Google Cloud Backup and DR's Backup Plan specific data.

↳ backup_dr_template_config
BackupDrTemplateConfig

Google Cloud Backup and DR's Template specific data.

getBackupConfigSource

Output only. The full resource name of the backup config source resource.

For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".

Returns
Type
Description
string

setBackupConfigSource

Output only. The full resource name of the backup config source resource.

For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBackupConfigSourceDisplayName

Output only. The display name of the backup config source resource.

Returns
Type
Description
string

setBackupConfigSourceDisplayName

Output only. The display name of the backup config source resource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getType

Output only. The type of the backup config resource.

Returns
Type
Description
int
Enum of type Type .

setType

Output only. The type of the backup config resource.

Parameter
Name
Description
var
int

Enum of type Type .

Returns
Type
Description
$this

getState

Output only. The state of the backup config resource.

Returns
Type
Description
int
Enum of type State .

setState

Output only. The state of the backup config resource.

Parameter
Name
Description
var
int

Enum of type State .

Returns
Type
Description
$this

getPitrSettings

Output only. Point in time recovery settings of the backup configuration resource.

Returns
Type
Description
PitrSettings |null

hasPitrSettings

clearPitrSettings

setPitrSettings

Output only. Point in time recovery settings of the backup configuration resource.

Parameter
Name
Description
Returns
Type
Description
$this

getLatestSuccessfulBackupTime

Output only. Timestamp of the latest successful backup created via this backup configuration.

Returns
Type
Description

hasLatestSuccessfulBackupTime

clearLatestSuccessfulBackupTime

setLatestSuccessfulBackupTime

Output only. Timestamp of the latest successful backup created via this backup configuration.

Parameter
Name
Description
Returns
Type
Description
$this

getApplicableResource

Output only. The full resource name of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"

Returns
Type
Description
string

setApplicableResource

Output only. The full resource name of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBackupVault

Output only. The full resource name of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"

Returns
Type
Description
string

setBackupVault

Output only. The full resource name of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBackupLocations

The locations where the backups are to be stored.

Returns
Type
Description

setBackupLocations

The locations where the backups are to be stored.

Parameter
Name
Description
var
array< BackupLocation >
Returns
Type
Description
$this

getBackupDrPlanConfig

Google Cloud Backup and DR's Backup Plan specific data.

Returns
Type
Description

hasBackupDrPlanConfig

setBackupDrPlanConfig

Google Cloud Backup and DR's Backup Plan specific data.

Parameter
Name
Description
Returns
Type
Description
$this

getBackupDrTemplateConfig

Google Cloud Backup and DR's Template specific data.

Returns
Type
Description

hasBackupDrTemplateConfig

setBackupDrTemplateConfig

Google Cloud Backup and DR's Template specific data.

Parameter
Name
Description
Returns
Type
Description
$this

getPlanSpecificConfig

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: