class ProjectsLocationsBackupPlansBackups extends Resource (View source)

The "backups" collection of methods.

Typical usage is:

 $gkebackupService = new Google\Service\BackupforGKE(...);
 $backups = $gkebackupService->projects_locations_backupPlans_backups;

Methods

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

Creates a Backup for the given BackupPlan. (backups.create)

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

Deletes an existing Backup. (backups.delete)

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

Retrieve the details of a single Backup. (backups.get)

getBackupIndexDownloadUrl(string $backup, array $optParams = [])

Retrieve the link to the backupIndex. (backups.getBackupIndexDownloadUrl)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (backups.getIamPolicy)

listProjectsLocationsBackupPlansBackups(string $parent, array $optParams = [])

Lists the Backups for a given BackupPlan.

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

Update a Backup. (backups.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (backups.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

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

Creates a Backup for the given BackupPlan. (backups.create)

Parameters

string $parent

Required. The BackupPlan within which to create the Backup. Format: projects/locations/backupPlans

Backup $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes an existing Backup. (backups.delete)

Parameters

string $name

Required. Name of the Backup resource. Format: projects/locations/backupPlans/backups

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Retrieve the details of a single Backup. (backups.get)

Parameters

string $name

Required. Full name of the Backup resource. Format: projects/locations/backupPlans/backups

array $optParams

Optional parameters.

Return Value

Backup

Exceptions

Exception

GetBackupIndexDownloadUrlResponse getBackupIndexDownloadUrl(string $backup, array $optParams = [])

Retrieve the link to the backupIndex. (backups.getBackupIndexDownloadUrl)

Parameters

string $backup

Required. Full name of Backup resource. Format: project s/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

array $optParams

Optional parameters.

Return Value

GetBackupIndexDownloadUrlResponse

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (backups.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

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

Lists the Backups for a given BackupPlan.

(backups.listProjectsLocationsBackupPlansBackups)

Parameters

string $parent

Required. The BackupPlan that contains the Backups to list. Format: projects/locations/backupPlans

array $optParams

Optional parameters.

Return Value

ListBackupsResponse

Exceptions

Exception

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

Update a Backup. (backups.patch)

Parameters

string $name

Output only. The fully qualified name of the Backup. projects/locations/backupPlans/backups

Backup $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (backups.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (backups.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception