Documentation

Google_Service_BigtableAdmin_Resource_ProjectsInstancesTables extends Google_Service_Resource
in package

Application

The "tables" collection of methods.

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

$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.
checkConsistency() : Google_Service_BigtableAdmin_CheckConsistencyResponse: Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. (tables.checkConsistency)
create() : Google_Service_BigtableAdmin_Table: Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_BigtableAdmin_BigtableadminEmpty: Permanently deletes a specified table and all of its data. (tables.delete)
dropRowRange() : Google_Service_BigtableAdmin_BigtableadminEmpty: Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. (tables.dropRowRange)
generateConsistencyToken() : Google_Service_BigtableAdmin_GenerateConsistencyTokenResponse: Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. (tables.generateConsistencyToken)
get() : Google_Service_BigtableAdmin_Table: Gets metadata information about the specified table. (tables.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. (tables.getIamPolicy)
listProjectsInstancesTables() : Google_Service_BigtableAdmin_ListTablesResponse: Lists all tables served from a specified instance.
modifyColumnFamilies() : Google_Service_BigtableAdmin_Table: Performs a series of column family modifications on the specified table.
restore() : Google_Service_BigtableAdmin_Operation: Create a new table by restoring from a completed backup. The new table must be in the same instance as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata.
setIamPolicy() : Google_Service_BigtableAdmin_Policy: Sets the access control policy on a Table resource. Replaces any existing policy. (tables.setIamPolicy)
testIamPermissions() : Google_Service_BigtableAdmin_TestIamPermissionsResponse: Returns permissions that the caller has on the specified table resource.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

checkConsistency()

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. (tables.checkConsistency)


    public
                checkConsistency(string $name, Google_Service_BigtableAdmin_CheckConsistencyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_CheckConsistencyResponse

Parameters

$name : string: Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
$postBody : Google_Service_BigtableAdmin_CheckConsistencyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_CheckConsistencyResponse —

create()

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.


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

(tables.create)

Parameters

$parent : string: Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}.
$postBody : Google_Service_BigtableAdmin_CreateTableRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_Table —

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>

Return values

string —

$requestUrl

delete()

Permanently deletes a specified table and all of its data. (tables.delete)


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

Parameters

$name : string: Required. The unique name of the table to be deleted. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_BigtableadminEmpty —

dropRowRange()

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. (tables.dropRowRange)


    public
                dropRowRange(string $name, Google_Service_BigtableAdmin_DropRowRangeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_BigtableadminEmpty

Parameters

$name : string: Required. The unique name of the table on which to drop a range of rows. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
$postBody : Google_Service_BigtableAdmin_DropRowRangeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_BigtableadminEmpty —

generateConsistencyToken()

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. (tables.generateConsistencyToken)


    public
                generateConsistencyToken(string $name, Google_Service_BigtableAdmin_GenerateConsistencyTokenRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_GenerateConsistencyTokenResponse

Parameters

$name : string: Required. The unique name of the Table for which to create a consistency token. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
$postBody : Google_Service_BigtableAdmin_GenerateConsistencyTokenRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_GenerateConsistencyTokenResponse —

get()

Gets metadata information about the specified table. (tables.get)


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

Parameters

$name : string: Required. The unique name of the requested table. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_Table —

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. (tables.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 —

listProjectsInstancesTables()

Lists all tables served from a specified instance.


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

(tables.listProjectsInstancesTables)

Parameters

$parent : string: Required. The unique name of the instance for which tables should be listed. Values are of the form projects/{project}/instances/{instance}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_ListTablesResponse —

modifyColumnFamilies()

Performs a series of column family modifications on the specified table.


    public
                modifyColumnFamilies(string $name, Google_Service_BigtableAdmin_ModifyColumnFamiliesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Table

Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect. (tables.modifyColumnFamilies)

Parameters

$name : string: Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.
$postBody : Google_Service_BigtableAdmin_ModifyColumnFamiliesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_Table —

restore()

Create a new table by restoring from a completed backup. The new table must be in the same instance as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata.


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

The response type is Table, if successful. (tables.restore)

Parameters

$parent : string: Required. The name of the instance in which to create the restored table. This instance must be the parent of the source backup. Values are of the form projects//instances/.
$postBody : Google_Service_BigtableAdmin_RestoreTableRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_Operation —

setIamPolicy()

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

(tables.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 —