Documentation

Google_Service_Storage_Resource_ProjectsHmacKeys extends Google_Service_Resource
in package

Application

The "hmacKeys" collection of methods.

Typical usage is: $storageService = new Google_Service_Storage(...); $hmacKeys = $storageService->hmacKeys;

$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_Storage_HmacKey: Creates a new HMAC key for the specified service account. (hmacKeys.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes an HMAC key. (hmacKeys.delete)
get() : Google_Service_Storage_HmacKeyMetadata: Retrieves an HMAC key's metadata (hmacKeys.get)
listProjectsHmacKeys() : Google_Service_Storage_HmacKeysMetadata: Retrieves a list of HMAC keys matching the criteria.
update() : Google_Service_Storage_HmacKeyMetadata: Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. (hmacKeys.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()

Creates a new HMAC key for the specified service account. (hmacKeys.create)


    public
                create(string $projectId, string $serviceAccountEmail[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_HmacKey

Parameters

$projectId : string: Project ID owning the service account.
$serviceAccountEmail : string: Email address of the service account.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_HmacKey —

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 an HMAC key. (hmacKeys.delete)


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

Parameters

$projectId : string: Project ID owning the requested key
$accessId : string: Name of the HMAC key to be deleted.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Retrieves an HMAC key's metadata (hmacKeys.get)


    public
                get(string $projectId, string $accessId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_HmacKeyMetadata

Parameters

$projectId : string: Project ID owning the service account of the requested key.
$accessId : string: Name of the HMAC key.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_HmacKeyMetadata —

listProjectsHmacKeys()

Retrieves a list of HMAC keys matching the criteria.


    public
                listProjectsHmacKeys(string $projectId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_HmacKeysMetadata

(hmacKeys.listProjectsHmacKeys)

Parameters

$projectId : string: Name of the project in which to look for HMAC keys.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_HmacKeysMetadata —

update()

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. (hmacKeys.update)


    public
                update(string $projectId, string $accessId, Google_Service_Storage_HmacKeyMetadata $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_HmacKeyMetadata

Parameters

$projectId : string: Project ID owning the service account of the updated key.
$accessId : string: Name of the HMAC key being updated.
$postBody : Google_Service_Storage_HmacKeyMetadata
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_HmacKeyMetadata —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —