Documentation

Google_Service_BigtableAdmin_Resource_ProjectsInstancesClustersBackups extends Google_Service_Resource
in package

The "backups" collection of methods.

Typical usage is: $bigtableadminService = new Google_Service_BigtableAdmin(...); $backups = $bigtableadminService->backups;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_BigtableAdmin_Operation
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)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_BigtableAdmin_BigtableadminEmpty
Deletes a pending or completed Cloud Bigtable backup. (backups.delete)
get()  : Google_Service_BigtableAdmin_Backup
Gets metadata on a pending or completed Cloud Bigtable Backup. (backups.get)
getIamPolicy()  : Google_Service_BigtableAdmin_Policy
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. (backups.getIamPolicy)
listProjectsInstancesClustersBackups()  : Google_Service_BigtableAdmin_ListBackupsResponse
Lists Cloud Bigtable backups. Returns both completed and pending backups.
patch()  : Google_Service_BigtableAdmin_Backup
Updates a pending or completed Cloud Bigtable Backup. (backups.patch)
setIamPolicy()  : Google_Service_BigtableAdmin_Policy
Sets the access control policy on a Table resource. Replaces any existing policy. (backups.setIamPolicy)
testIamPermissions()  : Google_Service_BigtableAdmin_TestIamPermissionsResponse
Returns permissions that the caller has on the specified table resource.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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)

public create(string $parent, Google_Service_BigtableAdmin_Backup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Operation
Parameters
$parent : string

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}.

$postBody : Google_Service_BigtableAdmin_Backup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string backupId Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: pr ojects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id} . This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.

Return values
Google_Service_BigtableAdmin_Operation —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_BigtableadminEmpty
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BigtableAdmin_BigtableadminEmpty —

get()

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

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Backup
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BigtableAdmin_Backup —

getIamPolicy()

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

public getIamPolicy(string $resource, Google_Service_BigtableAdmin_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Policy
Parameters
$resource : string

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

$postBody : Google_Service_BigtableAdmin_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BigtableAdmin_Policy —

listProjectsInstancesClustersBackups()

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

public listProjectsInstancesClustersBackups(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_ListBackupsResponse

(backups.listProjectsInstancesClustersBackups)

Parameters
$parent : string

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/-.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=,

=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are: * name * source_table * state * start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * end_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * size_bytes To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are: * name:"exact" --> The backup's name is the string "exact". * name:howl --> The backup's name contains the string "howl". * source_table:prod --> The source_table's name contains the string "prod". * state:CREATING --> The backup is pending creation. * state:READY --> The backup is fully created and ready for use. * (name:howl) AND (start_time < \"2018-03-28T14:50:00Z\") --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z. * size_bytes > 10000000000 --> The backup's size is greater than 10GB

opt_param

string orderBy An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup.

opt_param

int pageSize Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

opt_param

string pageToken If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter.

Return values
Google_Service_BigtableAdmin_ListBackupsResponse —

patch()

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

public patch(string $name, Google_Service_BigtableAdmin_Backup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Backup
Parameters
$name : string

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}.

$postBody : Google_Service_BigtableAdmin_Backup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Required. A mask specifying which fields (e.g. expire_time) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.

Return values
Google_Service_BigtableAdmin_Backup —

setIamPolicy()

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

public setIamPolicy(string $resource, Google_Service_BigtableAdmin_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Policy
Parameters
$resource : string

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

$postBody : Google_Service_BigtableAdmin_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BigtableAdmin_Policy —

testIamPermissions()

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

public testIamPermissions(string $resource, Google_Service_BigtableAdmin_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_TestIamPermissionsResponse

(backups.testIamPermissions)

Parameters
$resource : string

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

$postBody : Google_Service_BigtableAdmin_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_BigtableAdmin_TestIamPermissionsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results