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

ProjectsLocationsBackups

class ProjectsLocationsBackups extends Resource (View source)

The "backups" collection of methods.

Typical usage is:

 $alloydbService = new Google\Service\CloudAlloyDBAdmin(...);
 $backups = $alloydbService->projects_locations_backups;

Methods

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

Creates a new Backup in a given project and location. (backups.create)

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

Deletes a single Backup. (backups.delete)

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

Gets details of a single Backup. (backups.get)

ListBackupsResponse
listProjectsLocationsBackups(string $parent, array $optParams = [])

Lists Backups in a given project and location.

Operation
patch(string $name, Backup $postBody, array $optParams = [])

Updates the parameters of a single Backup. (backups.patch)

Details

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

Creates a new Backup in a given project and location. (backups.create)

Parameters

string $parent

Required. Value for parent.
Backup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single Backup. (backups.delete)

Parameters

string $name

Required. Name of the resource. For the required format, see the comment on the Backup.name field.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 104
Backup get(string $name, array $optParams = [])

Gets details of a single Backup. (backups.get)

Parameters

string $name

Required. Name of the resource
array $optParams

Optional parameters.

Return Value

Backup

Exceptions

Exception

at line 126
ListBackupsResponse listProjectsLocationsBackups(string $parent, array $optParams = [])

Lists Backups in a given project and location.

(backups.listProjectsLocationsBackups)

Parameters

string $parent

Required. Parent value for ListBackupsRequest
array $optParams

Optional parameters.

Return Value

ListBackupsResponse

Exceptions

Exception

at line 170
Operation patch(string $name, Backup $postBody, array $optParams = [])

Updates the parameters of a single Backup. (backups.patch)

Parameters

string $name

Output only. The name of the backup resource with the format: projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: projects/{project}/locations/{region}
Backup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception