REST Resource: projects.locations.backupPlanAssociations

Resource: BackupPlanAssociation

A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc

JSON representation 
{
  "name": string,
  "resourceType": string,
  "resource": string,
  "backupPlan": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "rulesConfigInfo": [
    {
      object (RuleConfigInfo)
    }
  ],
  "dataSource": string,
  "backupPlanRevisionId": string,
  "backupPlanRevisionName": string,

  // Union field resource_properties can be only one of the following:
  "cloudSqlInstanceBackupPlanAssociationProperties": {
    object (CloudSqlInstanceBackupPlanAssociationProperties)
  }
  // End of list of possible types for union field resource_properties.
}
Fields
name

string

Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
resourceType

string

Required. Immutable. Resource type of workload on which backupplan is applied
resource

string

Required. Immutable. Resource name of workload on which the backup plan is applied.

The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").
backupPlan

string

Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
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".
state

enum (State)

Output only. The BackupPlanAssociation resource state.
rulesConfigInfo[]

object (RuleConfigInfo)

Output only. The config info related to backup rules.
dataSource

string

Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}
backupPlanRevisionId

string

Output only. The user friendly revision ID of the BackupPlanRevision.

Example: v0, v1, v2, etc.
backupPlanRevisionName

string

Output only. The resource id of the BackupPlanRevision.

Format: projects/{project}/locations/{location}/backupPlans/{backupPlan}/revisions/{revisionId}
Union field resource_properties. Properties of the protected GCP resource. resource_properties can be only one of the following:
cloudSqlInstanceBackupPlanAssociationProperties

object (CloudSqlInstanceBackupPlanAssociationProperties)

Output only. Cloud SQL instance's backup plan association properties.

State

Enum for State of BackupPlan Association

Enums
STATE_UNSPECIFIED State not set.
CREATING The resource is being created.
ACTIVE The resource has been created and is fully usable.
DELETING The resource is being deleted.
INACTIVE The resource has been created but is not usable.
UPDATING The resource is being updated.

RuleConfigInfo

Message for rules config info.

JSON representation 
{
  "ruleId": string,
  "lastBackupState": enum (LastBackupState),
  "lastBackupError": {
    object (Status)
  },
  "lastSuccessfulBackupConsistencyTime": string
}
Fields
ruleId

string

Output only. Backup Rule id fetched from backup plan.
lastBackupState

enum (LastBackupState)

Output only. The last backup state for rule.
lastBackupError

object (Status)

Output only. google.rpc.Status object to store the last backup error.
lastSuccessfulBackupConsistencyTime

string (Timestamp format)

Output only. The point in time when the last successful backup was captured from the source.

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".

LastBackupState

Enum for LastBackupState

Enums
LAST_BACKUP_STATE_UNSPECIFIED State not set.
FIRST_BACKUP_PENDING The first backup is pending.
PERMISSION_DENIED The most recent backup could not be run/failed because of the lack of permissions.
SUCCEEDED The last backup operation succeeded.
FAILED The last backup operation failed.

CloudSqlInstanceBackupPlanAssociationProperties

Cloud SQL instance's BPA properties.

JSON representation 
{
  "instanceCreateTime": string
}
Fields
instanceCreateTime

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".

Methods

create

 Create a BackupPlanAssociation

delete

 Deletes a single BackupPlanAssociation.

fetchForResourceType

 List BackupPlanAssociations for a given resource type.

get

 Gets details of a single BackupPlanAssociation.

list

 Lists BackupPlanAssociations in a given project and location.

patch

 Update a BackupPlanAssociation.

triggerBackup

 Triggers a new Backup.