1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Backupdr
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsBackupPlanAssociations

ProjectsLocationsBackupPlanAssociations

class ProjectsLocationsBackupPlanAssociations extends Resource (View source)

The "backupPlanAssociations" collection of methods.

Typical usage is:

 $backupdrService = new Google\Service\Backupdr(...);
 $backupPlanAssociations = $backupdrService->projects_locations_backupPlanAssociations;

Methods

Operation
create(string $parent, BackupPlanAssociation $postBody, array $optParams = [])

Create a BackupPlanAssociation (backupPlanAssociations.create)

Operation
delete(string $name, array $optParams = [])

Deletes a single BackupPlanAssociation. (backupPlanAssociations.delete)

BackupPlanAssociation
get(string $name, array $optParams = [])

Gets details of a single BackupPlanAssociation. (backupPlanAssociations.get)

ListBackupPlanAssociationsResponse
listProjectsLocationsBackupPlanAssociations(string $parent, array $optParams = [])

Lists BackupPlanAssociations in a given project and location.

Operation
triggerBackup(string $name, TriggerBackupRequest $postBody, array $optParams = [])

Triggers a new Backup. (backupPlanAssociations.triggerBackup)

Details

at line 61
Operation create(string $parent, BackupPlanAssociation $postBody, array $optParams = [])

Create a BackupPlanAssociation (backupPlanAssociations.create)

Parameters

string $parent

Required. The backup plan association project and location in the format projects/{project_id}/locations/{location}. In Cloud BackupDR locations map to GCP regions, for example us-central1.
BackupPlanAssociation $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 89
Operation delete(string $name, array $optParams = [])

Deletes a single BackupPlanAssociation. (backupPlanAssociations.delete)

Parameters

string $name

Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations /{backupPlanAssociationId}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 105
BackupPlanAssociation get(string $name, array $optParams = [])

Gets details of a single BackupPlanAssociation. (backupPlanAssociations.get)

Parameters

string $name

Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations /{backupPlanAssociationId}
array $optParams

Optional parameters.

Return Value

BackupPlanAssociation

Exceptions

Exception

at line 131
ListBackupPlanAssociationsResponse listProjectsLocationsBackupPlanAssociations(string $parent, array $optParams = [])

Lists BackupPlanAssociations in a given project and location.

(backupPlanAssociations.listProjectsLocationsBackupPlanAssociations)

Parameters

string $parent

Required. The project and location for which to retrieve backup Plan Associations information, in the format projects/{project_id}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve backup plan associations for all locations, use "-" for the {location} value.
array $optParams

Optional parameters.

Return Value

ListBackupPlanAssociationsResponse

Exceptions

Exception

at line 148
Operation triggerBackup(string $name, TriggerBackupRequest $postBody, array $optParams = [])

Triggers a new Backup. (backupPlanAssociations.triggerBackup)

Parameters

string $name

Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations /{backupPlanAssociationId}
TriggerBackupRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception