- Resource: DataSource
- State
- BackupConfigState
- BackupConfigInfo
- LastBackupState
- GcpBackupConfig
- BackupApplianceBackupConfig
- DataSourceGcpResource
- ComputeInstanceDataSourceProperties
- DiskDataSourceProperties
- DataSourceBackupApplianceApplication
- Methods
Resource: DataSource
Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.
JSON representation |
---|
{ "name": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. Identifier. Name of the datasource to create. It must have the format |
state |
Output only. The DataSource resource instance state. |
labels |
Optional. Resource labels to represent user provided metadata. No labels currently defined: An object containing a list of |
configState |
Output only. The backup configuration state. |
backupConfigInfo |
Output only. Details of how the resource is configured for backup. |
backupBlockedByVaultAccessRestriction |
Output only. This field is set to true if the backup is blocked by vault access restriction. |
createTime |
Output only. The time when the instance was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. The time when the instance was updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
backupCount |
Number of backups in the data source. |
etag |
Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. |
totalStoredBytes |
The number of bytes (metadata and data) stored in this datasource. |
Union field source_resource . The source resource that is represented by this DataSource. It can be a Google Cloud resource, or one backed up by a Backup Appliance. source_resource can be only one of the following: |
|
dataSourceGcpResource |
The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object. |
dataSourceBackupApplianceApplication |
The backed up resource is a backup appliance application. |
State
Holds the state of the data source resource.
Enums | |
---|---|
STATE_UNSPECIFIED |
State not set. |
CREATING |
The data source is being created. |
ACTIVE |
The data source has been created and is fully usable. |
DELETING |
The data source is being deleted. |
ERROR |
The data source is experiencing an issue and might be unusable. |
BackupConfigState
Backup configuration state. Is the resource configured for backup?
Enums | |
---|---|
BACKUP_CONFIG_STATE_UNSPECIFIED |
The possible states of backup configuration. Status not set. |
ACTIVE |
The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it) |
PASSIVE |
The data source is no longer protected (but may have backups under it) |
BackupConfigInfo
BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.
JSON representation |
---|
{ "lastBackupState": enum ( |
Fields | |
---|---|
lastBackupState |
Output only. The status of the last backup to this BackupVault |
lastSuccessfulBackupConsistencyTime |
Output only. If the last backup were successful, this field has the consistency date. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
lastBackupError |
Output only. If the last backup failed, this field has the error message. |
lastSuccessfulLogBackupConsistencyTime |
Output only. If the last log backup were successful, this field has the consistency date. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
Union field backup_config . Configuration Info has the resource format-specific configuration. backup_config can be only one of the following: |
|
gcpBackupConfig |
Configuration for a Google Cloud resource. |
backupApplianceBackupConfig |
Configuration for an application backed up by a Backup Appliance. |
LastBackupState
LastBackupstate tracks whether the last backup was not yet started, successful, failed, or could not be run because of the lack of permissions.
Enums | |
---|---|
LAST_BACKUP_STATE_UNSPECIFIED |
Status not set. |
FIRST_BACKUP_PENDING |
The first backup has not yet completed |
SUCCEEDED |
The most recent backup was successful |
FAILED |
The most recent backup failed |
PERMISSION_DENIED |
The most recent backup could not be run/failed because of the lack of permissions |
GcpBackupConfig
GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations.
JSON representation |
---|
{ "backupPlan": string, "backupPlanDescription": string, "backupPlanAssociation": string, "backupPlanRules": [ string ] } |
Fields | |
---|---|
backupPlan |
The name of the backup plan. |
backupPlanDescription |
The description of the backup plan. |
backupPlanAssociation |
The name of the backup plan association. |
backupPlanRules[] |
The names of the backup plan rules which point to this backupvault |
BackupApplianceBackupConfig
BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.
JSON representation |
---|
{ "backupApplianceName": string, "backupApplianceId": string, "slaId": string, "applicationName": string, "hostName": string, "sltName": string, "slpName": string } |
Fields | |
---|---|
backupApplianceName |
The name of the backup appliance. |
backupApplianceId |
The ID of the backup appliance. |
slaId |
The ID of the SLA of this application. |
applicationName |
The name of the application. |
hostName |
The name of the host where the application is running. |
sltName |
The name of the SLT associated with the application. |
slpName |
The name of the SLP associated with the application. |
DataSourceGcpResource
DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource
JSON representation |
---|
{ "gcpResourcename": string, "location": string, "type": string, // Union field |
Fields | |
---|---|
gcpResourcename |
Output only. Full resource pathname URL of the source Google Cloud resource. |
location |
Location of the resource: |
type |
The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. |
Union field gcp_resource_properties . gcp_Properties has properties of the Google Cloud Resource. gcp_resource_properties can be only one of the following: |
|
computeInstanceDatasourceProperties |
ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level. |
diskDatasourceProperties |
DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level. |
ComputeInstanceDataSourceProperties
ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource.
JSON representation |
---|
{ "name": string, "description": string, "machineType": string, "totalDiskCount": string, "totalDiskSizeGb": string } |
Fields | |
---|---|
name |
Name of the compute instance backed up by the datasource. |
description |
The description of the Compute Engine instance. |
machineType |
The machine type of the instance. |
totalDiskCount |
The total number of disks attached to the Instance. |
totalDiskSizeGb |
The sum of all the disk sizes. |
DiskDataSourceProperties
DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. .
JSON representation |
---|
{ "name": string, "description": string, "type": string, "sizeGb": string } |
Fields | |
---|---|
name |
Name of the disk backed up by the datasource. |
description |
The description of the disk. |
type |
The type of the disk. |
sizeGb |
The size of the disk in GB. |
DataSourceBackupApplianceApplication
BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.
JSON representation |
---|
{ "applicationName": string, "backupAppliance": string, "applianceId": string, "type": string, "applicationId": string, "hostname": string, "hostId": string } |
Fields | |
---|---|
applicationName |
The name of the Application as known to the Backup Appliance. |
backupAppliance |
Appliance name. |
applianceId |
Appliance Id of the Backup Appliance. |
type |
The type of the application. e.g. VMBackup |
applicationId |
The appid field of the application within the Backup Appliance. |
hostname |
Hostname of the host where the application is running. |
hostId |
Hostid of the application host. |
Methods |
|
---|---|
|
Internal only. |
|
Internal only. |
|
Internal only. |
|
Gets details of a DataSource. |
|
Internal only. |
|
Lists DataSources in a given project and location. |
|
Updates the settings of a DataSource. |
|
Deletes a DataSource. |
|
Sets the internal status of a DataSource. |