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

ProjectsLocationsBackupVaults

class ProjectsLocationsBackupVaults extends Resource (View source)

The "backupVaults" collection of methods.

Typical usage is:

 $backupdrService = new Google\Service\Backupdr(...);
 $backupVaults = $backupdrService->projects_locations_backupVaults;

Methods

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

(backupVaults.create)

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

Deletes a BackupVault. (backupVaults.delete)

FetchUsableBackupVaultsResponse
fetchUsable(string $parent, array $optParams = [])

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission. (backupVaults.fetchUsable)

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

Gets details of a BackupVault. (backupVaults.get)

ListBackupVaultsResponse
listProjectsLocationsBackupVaults(string $parent, array $optParams = [])

Lists BackupVaults in a given project and location.

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

Updates the settings of a BackupVault. (backupVaults.patch)

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

Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.

Details

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

(backupVaults.create)

Parameters

string $parent

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a BackupVault. (backupVaults.delete)

Parameters

string $name

Required. Name of the resource.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 127
FetchUsableBackupVaultsResponse fetchUsable(string $parent, array $optParams = [])

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission. (backupVaults.fetchUsable)

Parameters

string $parent

Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
array $optParams

Optional parameters.

Return Value

FetchUsableBackupVaultsResponse

Exceptions

Exception

at line 143
BackupVault get(string $name, array $optParams = [])

Gets details of a BackupVault. (backupVaults.get)

Parameters

string $name

Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'
array $optParams

Optional parameters.

Return Value

BackupVault

Exceptions

Exception

at line 171
ListBackupVaultsResponse listProjectsLocationsBackupVaults(string $parent, array $optParams = [])

Lists BackupVaults in a given project and location.

(backupVaults.listProjectsLocationsBackupVaults)

Parameters

string $parent

Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
array $optParams

Optional parameters.

Return Value

ListBackupVaultsResponse

Exceptions

Exception

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

Updates the settings of a BackupVault. (backupVaults.patch)

Parameters

string $name

Output only. Identifier. The resource name.
BackupVault $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.

(backupVaults.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