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

ProjectsInstancesClustersBackups

class ProjectsInstancesClustersBackups extends Resource (View source)

The "backups" collection of methods.

Typical usage is:

 $bigtableadminService = new Google\Service\BigtableAdmin(...);
 $backups = $bigtableadminService->projects_instances_clusters_backups;

Methods

Operation
copy(string $parent, CopyBackupRequest $postBody, array $optParams = [])

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project. (backups.copy)

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

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. (backups.create)

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

Deletes a pending or completed Cloud Bigtable backup. (backups.delete)

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

Gets metadata on a pending or completed Cloud Bigtable Backup. (backups.get)

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

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

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

Lists Cloud Bigtable backups. Returns both completed and pending backups.

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

Updates a pending or completed Cloud Bigtable Backup. (backups.patch)

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

Sets the access control policy on a Bigtable resource. Replaces any existing policy. (backups.setIamPolicy)

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

Returns permissions that the caller has on the specified Bigtable resource.

Details

at line 53
Operation copy(string $parent, CopyBackupRequest $postBody, array $optParams = [])

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project. (backups.copy)

Parameters

string $parent

Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: projects/{project}/instances/{instance}/clusters/{cluster}.
CopyBackupRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. (backups.create)

Parameters

string $parent

Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
Backup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a pending or completed Cloud Bigtable backup. (backups.delete)

Parameters

string $name

Required. Name of the backup to delete. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/backups/{bac kup}.
array $optParams

Optional parameters.

Return Value

BigtableadminEmpty

Exceptions

Exception

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

Gets metadata on a pending or completed Cloud Bigtable Backup. (backups.get)

Parameters

string $name

Required. Name of the backup. Values are of the form pro jects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}.
array $optParams

Optional parameters.

Return Value

Backup

Exceptions

Exception

at line 133
Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but 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.
GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 188
ListBackupsResponse listProjectsInstancesClustersBackups(string $parent, array $optParams = [])

Lists Cloud Bigtable backups. Returns both completed and pending backups.

(backups.listProjectsInstancesClustersBackups)

Parameters

string $parent

Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.
array $optParams

Optional parameters.

Return Value

ListBackupsResponse

Exceptions

Exception

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

Updates a pending or completed Cloud Bigtable Backup. (backups.patch)

Parameters

string $name

A globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a- zA-Z0-9* The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.
Backup $postBody
array $optParams

Optional parameters.

Return Value

Backup

Exceptions

Exception

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

Sets the access control policy on a Bigtable resource. Replaces any existing policy. (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

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

Returns permissions that the caller has on the specified Bigtable resource.

(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