REST Resource: projects.locations.backupVaults.dataSources

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 (State),
  "labels": {
    string: string,
    ...
  },
  "configState": enum (BackupConfigState),
  "backupConfigInfo": {
    object (BackupConfigInfo)
  },
  "backupBlockedByVaultAccessRestriction": boolean,
  "createTime": string,
  "updateTime": string,
  "backupCount": string,
  "etag": string,
  "totalStoredBytes": string,

  // Union field source_resource can be only one of the following:
  "dataSourceGcpResource": {
    object (DataSourceGcpResource)
  },
  "dataSourceBackupApplianceApplication": {
    object (DataSourceBackupApplianceApplication)
  }
  // End of list of possible types for union field source_resource.
}
Fields
name

string

Output only. Identifier. Name of the datasource to create. It must have the format"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}". {datasource} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.
state

enum (State)

Output only. The DataSource resource instance state.
labels

map (key: string, value: string)

Optional. Resource labels to represent user provided metadata. No labels currently defined:

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
configState

enum (BackupConfigState)

Output only. The backup configuration state.
backupConfigInfo

object (BackupConfigInfo)

Output only. Details of how the resource is configured for backup.
backupBlockedByVaultAccessRestriction

boolean

Output only. This field is set to true if the backup is blocked by vault access restriction.
createTime

string (Timestamp format)

Output only. The time when the instance was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time when the instance was updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
backupCount

string (int64 format)

Number of backups in the data source.
etag

string

Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
totalStoredBytes

string (int64 format)

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

object (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

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.

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 (LastBackupState),
  "lastSuccessfulBackupConsistencyTime": string,
  "lastBackupError": {
    object (Status)
  },

  // Union field backup_config can be only one of the following:
  "gcpBackupConfig": {
    object (GcpBackupConfig)
  },
  "backupApplianceBackupConfig": {
    object (BackupApplianceBackupConfig)
  }
  // End of list of possible types for union field backup_config.
}
Fields
lastBackupState

enum (LastBackupState)

Output only. The status of the last backup to this BackupVault
lastSuccessfulBackupConsistencyTime

string (Timestamp format)

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 use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastBackupError

object (Status)

Output only. If the last backup failed, this field has the error message.
Union field backup_config. Configuration Info has the resource format-specific configuration. backup_config can be only one of the following:
gcpBackupConfig

object (GcpBackupConfig)

Configuration for a Google Cloud resource.
backupApplianceBackupConfig

object (BackupApplianceBackupConfig)

Configuration for an application backed up by a Backup Appliance.

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
  ],
  "backupPlanRevisionName": string,
  "backupPlanRevisionId": string
}
Fields
backupPlan

string

The name of the backup plan.
backupPlanDescription

string

The description of the backup plan.
backupPlanAssociation

string

The name of the backup plan association.
backupPlanRules[]

string

The names of the backup plan rules which point to this backupvault
backupPlanRevisionName

string

The name of the backup plan revision.
backupPlanRevisionId

string

The user friendly id of the backup plan revision. E.g. v0, v1 etc.

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

string

The name of the backup appliance.
backupApplianceId

string (int64 format)

The ID of the backup appliance.
slaId

string (int64 format)

The ID of the SLA of this application.
applicationName

string

The name of the application.
hostName

string

The name of the host where the application is running.
sltName

string

The name of the SLT associated with the application.
slpName

string

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 gcp_resource_properties can be only one of the following:
  "computeInstanceDatasourceProperties": {
    object (ComputeInstanceDataSourceProperties)
  },
  "cloudSqlInstanceDatasourceProperties": {
    object (CloudSqlInstanceDataSourceProperties)
  },
  "alloyDbClusterDatasourceProperties": {
    object (AlloyDBClusterDataSourceProperties)
  },
  "diskDatasourceProperties": {
    object (DiskDataSourceProperties)
  }
  // End of list of possible types for union field gcp_resource_properties.
}
Fields
gcpResourcename

string

Output only. Full resource pathname URL of the source Google Cloud resource.
location

string

Location of the resource: //"global"/"unspecified".
type

string

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

object (ComputeInstanceDataSourceProperties)

ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level.
cloudSqlInstanceDatasourceProperties

object (CloudSqlInstanceDataSourceProperties)

Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.
alloyDbClusterDatasourceProperties

object (AlloyDBClusterDataSourceProperties)

Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.
diskDatasourceProperties

object (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

string

Name of the compute instance backed up by the datasource.
description

string

The description of the Compute Engine instance.
machineType

string

The machine type of the instance.
totalDiskCount

string (int64 format)

The total number of disks attached to the Instance.
totalDiskSizeGb

string (int64 format)

The sum of all the disk sizes.

CloudSqlInstanceDataSourceProperties

CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource.

JSON representation 
{
  "name": string,
  "databaseInstalledVersion": string,
  "instanceCreateTime": string,
  "instanceTier": string
}
Fields
name

string

Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
databaseInstalledVersion

string

Output only. The installed database version of the Cloud SQL instance.
instanceCreateTime

string (Timestamp format)

Output only. The instance creation timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
instanceTier

string

Output only. The tier (or machine type) for this instance. Example: db-custom-1-3840

AlloyDBClusterDataSourceProperties

AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. .

JSON representation 
{
  "name": string
}
Fields
name

string

Output only. Name of the AlloyDB cluster backed up by the datasource.

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

string

Name of the disk backed up by the datasource.
description

string

The description of the disk.
type

string

The type of the disk.
sizeGb

string (int64 format)

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

string

The name of the Application as known to the Backup Appliance.
backupAppliance

string

Appliance name.
applianceId

string (int64 format)

Appliance Id of the Backup Appliance.
type

string

The type of the application. e.g. VMBackup
applicationId

string (int64 format)

The appid field of the application within the Backup Appliance.
hostname

string

Hostname of the host where the application is running.
hostId

string (int64 format)

Hostid of the application host.

Methods

abandonBackup

 Internal only.

fetchAccessToken

 Internal only.

finalizeBackup

 Internal only.

get

 Gets details of a DataSource.

initiateBackup

 Internal only.

list

 Lists DataSources in a given project and location.

patch

 Updates the settings of a DataSource.

remove

 Deletes a DataSource.

setInternalStatus

 Sets the internal status of a DataSource.