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

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

ResourceBackupConfig represents a resource along with its backup configurations.

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

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}

↳ uid
string

Output only. The unique identifier of the resource backup config.

↳ target_resource
string

Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType .

↳ target_resource_display_name
string

Output only. The human friendly name of the target resource.

↳ target_resource_type
int

Output only. The type of the target resource.

↳ target_resource_labels
array| Google\Protobuf\Internal\MapField

Labels associated with the target resource.

↳ backup_configs_details
array< BackupConfigDetails >

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

↳ backup_configured
bool

Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.

↳ vaulted
bool

Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.

getName

Identifier. The resource name of the ResourceBackupConfig.

Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}

Returns
Type
Description
string

setName

Identifier. The resource name of the ResourceBackupConfig.

Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

Output only. The unique identifier of the resource backup config.

Returns
Type
Description
string

setUid

Output only. The unique identifier of the resource backup config.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTargetResource

Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType .

Returns
Type
Description
string

setTargetResource

Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are ResourceBackupConfig.ResourceType .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTargetResourceDisplayName

Output only. The human friendly name of the target resource.

Returns
Type
Description
string

setTargetResourceDisplayName

Output only. The human friendly name of the target resource.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTargetResourceType

Output only. The type of the target resource.

Returns
Type
Description
int
Enum of type ResourceType .

setTargetResourceType

Output only. The type of the target resource.

Parameter
Name
Description
var
int

Enum of type ResourceType .

Returns
Type
Description
$this

getTargetResourceLabels

Labels associated with the target resource.

Returns
Type
Description

setTargetResourceLabels

Labels associated with the target resource.

Parameter
Name
Description
Returns
Type
Description
$this

getBackupConfigsDetails

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

Returns
Type
Description

setBackupConfigsDetails

Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.

Parameter
Name
Description
var
Returns
Type
Description
$this

getBackupConfigured

Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.

Returns
Type
Description
bool

setBackupConfigured

Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getVaulted

Output only. Whether the target resource is protected by a backup vault.

This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.

Returns
Type
Description
bool

setVaulted

Output only. Whether the target resource is protected by a backup vault.

This is true if the backup_configs_details is not empty and any of the ResourceBackupConfig.backup_configs_details has a backup configuration with BackupConfigDetails.backup_vault set. set.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: