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

ProjectsLocationsBackupPlansBackupsVolumeBackups

class ProjectsLocationsBackupPlansBackupsVolumeBackups extends Resource (View source)

The "volumeBackups" collection of methods.

Typical usage is:

 $gkebackupService = new Google\Service\BackupforGKE(...);
 $volumeBackups = $gkebackupService->projects_locations_backupPlans_backups_volumeBackups;

Methods

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

Retrieve the details of a single VolumeBackup. (volumeBackups.get)

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. (volumeBackups.getIamPolicy)

ListVolumeBackupsResponse
listProjectsLocationsBackupPlansBackupsVolumeBackups(string $parent, array $optParams = [])

Lists the VolumeBackups for a given Backup.

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. (volumeBackups.setIamPolicy)

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.

Details

at line 46
VolumeBackup get(string $name, array $optParams = [])

Retrieve the details of a single VolumeBackup. (volumeBackups.get)

Parameters

string $name

Required. Full name of the VolumeBackup resource. Format: projects/locations/backupPlans/backups/volumeBackups
array $optParams

Optional parameters.

Return Value

VolumeBackup

Exceptions

Exception

at line 77
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. (volumeBackups.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

at line 107
ListVolumeBackupsResponse listProjectsLocationsBackupPlansBackupsVolumeBackups(string $parent, array $optParams = [])

Lists the VolumeBackups for a given Backup.

(volumeBackups.listProjectsLocationsBackupPlansBackupsVolumeBackups)

Parameters

string $parent

Required. The Backup that contains the VolumeBackups to list. Format: projects/locations/backupPlans/backups
array $optParams

Optional parameters.

Return Value

ListVolumeBackupsResponse

Exceptions

Exception

at line 127
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. (volumeBackups.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

at line 150
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. (volumeBackups.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