Documentation

Google_Service_BigtableAdmin_Resource_ProjectsInstances extends Google_Service_Resource
in package

Application

The "instances" collection of methods.

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

$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: Create an instance within a project. (instances.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_BigtableAdmin_BigtableadminEmpty: Delete an instance from a project. (instances.delete)
get() : Google_Service_BigtableAdmin_Instance: Gets information about an instance. (instances.get)
getIamPolicy() : Google_Service_BigtableAdmin_Policy: Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
listProjectsInstances() : Google_Service_BigtableAdmin_ListInstancesResponse: Lists information about instances in a project.
partialUpdateInstance() : Google_Service_BigtableAdmin_Operation: Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
setIamPolicy() : Google_Service_BigtableAdmin_Policy: Sets the access control policy on an instance resource. Replaces any existing policy. (instances.setIamPolicy)
testIamPermissions() : Google_Service_BigtableAdmin_TestIamPermissionsResponse: Returns permissions that the caller has on the specified instance resource.
update() : Google_Service_BigtableAdmin_Instance: Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. (instances.update)
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 —

create()

Create an instance within a project. (instances.create)


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

Parameters

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

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>

Return values

string —

$requestUrl

delete()

Delete an instance from a project. (instances.delete)


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

Parameters

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

Return values

Google_Service_BigtableAdmin_BigtableadminEmpty —

get()

Gets information about an instance. (instances.get)


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

Parameters

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

Return values

Google_Service_BigtableAdmin_Instance —

getIamPolicy()

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


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

(instances.getIamPolicy)

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 —

listProjectsInstances()

Lists information about instances in a project.


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

(instances.listProjectsInstances)

Parameters

$parent : string: Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_ListInstancesResponse —

partialUpdateInstance()

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.


    public
                partialUpdateInstance(string $name, Google_Service_BigtableAdmin_Instance $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Operation

(instances.partialUpdateInstance)

Parameters

$name : string: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
$postBody : Google_Service_BigtableAdmin_Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_Operation —

setIamPolicy()

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


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

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

update()

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. (instances.update)


    public
                update(string $name, Google_Service_BigtableAdmin_Instance $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigtableAdmin_Instance

Parameters

$name : string: The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].
$postBody : Google_Service_BigtableAdmin_Instance
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigtableAdmin_Instance —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —