Documentation

Google_Service_BigtableAdmin_Resource_ProjectsInstancesAppProfiles extends Google_Service_Resource
in package

The "appProfiles" collection of methods.

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

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_AppProfile
Creates an app profile within an instance. (appProfiles.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_BigtableAdmin_BigtableadminEmpty
Deletes an app profile from an instance. (appProfiles.delete)
get()  : Google_Service_BigtableAdmin_AppProfile
Gets information about an app profile. (appProfiles.get)
listProjectsInstancesAppProfiles()  : Google_Service_BigtableAdmin_ListAppProfilesResponse
Lists information about app profiles in an instance.
patch()  : Google_Service_BigtableAdmin_Operation
Updates an app profile within an instance. (appProfiles.patch)
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()

Creates an app profile within an instance. (appProfiles.create)

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

Required. The unique name of the instance in which to create the new app profile. Values are of the form projects/{project}/instances/{instance}.

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

Optional parameters.

Tags
opt_param

bool ignoreWarnings If true, ignore safety checks when creating the app profile.

opt_param

string appProfileId Required. The ID to be used when referring to the new app profile within its instance, e.g., just myprofile rather than projects/myproject/instances/myinstance/appProfiles/myprofile.

Return values
Google_Service_BigtableAdmin_AppProfile —

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 an app profile from an instance. (appProfiles.delete)

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

Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

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

Optional parameters.

Tags
opt_param

bool ignoreWarnings Required. If true, ignore safety checks when deleting the app profile.

Return values
Google_Service_BigtableAdmin_BigtableadminEmpty —

get()

Gets information about an app profile. (appProfiles.get)

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

Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

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

Optional parameters.

Return values
Google_Service_BigtableAdmin_AppProfile —

listProjectsInstancesAppProfiles()

Lists information about app profiles in an instance.

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

(appProfiles.listProjectsInstancesAppProfiles)

Parameters
$parent : string

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

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

Optional parameters.

Tags
opt_param

string pageToken The value of next_page_token returned by a previous call.

opt_param

int pageSize Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

Return values
Google_Service_BigtableAdmin_ListAppProfilesResponse —

patch()

Updates an app profile within an instance. (appProfiles.patch)

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

The unique name of the app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*.

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

Optional parameters.

Tags
opt_param

string updateMask Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

opt_param

bool ignoreWarnings If true, ignore safety checks when updating the app profile.

Return values
Google_Service_BigtableAdmin_Operation —

convertToArrayAndStripNulls()

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

Search results