Documentation

Google_Service_AppState_Resource_States extends Google_Service_Resource
in package

Application

The "states" collection of methods.

Typical usage is: $appstateService = new Google_Service_AppState(...); $states = $appstateService->states;

$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.
clear() : Google_Service_AppState_WriteResult: Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch. (states.clear)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption. (states.delete)
get() : Google_Service_AppState_GetResponse: Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned. (states.get)
listStates() : Google_Service_AppState_ListResponse: Lists all the states keys, and optionally the state data. (states.listStates)
update() : Google_Service_AppState_WriteResult: Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB. (states.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 —

clear()

Clears (sets to empty) the data for the passed key if and only if the passed version matches the currently stored version. This method results in a conflict error on version mismatch. (states.clear)


    public
                clear(int $stateKey[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AppState_WriteResult

Parameters

$stateKey : int: The key for the data to be retrieved.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AppState_WriteResult —

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()

Deletes a key and the data associated with it. The key is removed and no longer counts against the key quota. Note that since this method is not safe in the face of concurrent modifications, it should only be used for development and testing purposes. Invoking this method in shipping code can result in data loss and data corruption. (states.delete)


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

Parameters

$stateKey : int: The key for the data to be retrieved.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Retrieves the data corresponding to the passed key. If the key does not exist on the server, an HTTP 404 will be returned. (states.get)


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

Parameters

$stateKey : int: The key for the data to be retrieved.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AppState_GetResponse —

listStates()

Lists all the states keys, and optionally the state data. (states.listStates)


    public
                listStates([array<string|int, mixed> $optParams = array() ]) : Google_Service_AppState_ListResponse

Parameters

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

Return values

Google_Service_AppState_ListResponse —

update()

Update the data associated with the input key if and only if the passed version matches the currently stored version. This method is safe in the face of concurrent writes. Maximum per-key size is 128KB. (states.update)


    public
                update(int $stateKey, Google_Service_AppState_UpdateRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AppState_WriteResult

Parameters

$stateKey : int: The key for the data to be retrieved.
$postBody : Google_Service_AppState_UpdateRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AppState_WriteResult —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —