1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Storage
  7. \
  8. Resource
  9. \
  10. ProjectsHmacKeys

ProjectsHmacKeys

class ProjectsHmacKeys extends Resource (View source)

The "hmacKeys" collection of methods.

Typical usage is:

 $storageService = new Google\Service\Storage(...);
 $hmacKeys = $storageService->projects_hmacKeys;

Methods

HmacKey
create(string $projectId, string $serviceAccountEmail, array $optParams = [])

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

delete(string $projectId, string $accessId, array $optParams = [])

Deletes an HMAC key. (hmacKeys.delete)

HmacKeyMetadata
get(string $projectId, string $accessId, array $optParams = [])

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

HmacKeysMetadata
listProjectsHmacKeys(string $projectId, array $optParams = [])

Retrieves a list of HMAC keys matching the criteria.

HmacKeyMetadata
update(string $projectId, string $accessId, HmacKeyMetadata $postBody, array $optParams = [])

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

Details

at line 45
HmacKey create(string $projectId, string $serviceAccountEmail, array $optParams = [])

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

Parameters

string $projectId

Project ID owning the service account.
string $serviceAccountEmail

Email address of the service account.
array $optParams

Optional parameters.

Return Value

HmacKey

Exceptions

Exception

at line 61
delete(string $projectId, string $accessId, array $optParams = [])

Deletes an HMAC key. (hmacKeys.delete)

Parameters

string $projectId

Project ID owning the requested key
string $accessId

Name of the HMAC key to be deleted.
array $optParams

Optional parameters.

Exceptions

Exception

at line 79
HmacKeyMetadata get(string $projectId, string $accessId, array $optParams = [])

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

Parameters

string $projectId

Project ID owning the service account of the requested key.
string $accessId

Name of the HMAC key.
array $optParams

Optional parameters.

Return Value

HmacKeyMetadata

Exceptions

Exception

at line 108
HmacKeysMetadata listProjectsHmacKeys(string $projectId, array $optParams = [])

Retrieves a list of HMAC keys matching the criteria.

(hmacKeys.listProjectsHmacKeys)

Parameters

string $projectId

Name of the project in which to look for HMAC keys.
array $optParams

Optional parameters.

Return Value

HmacKeysMetadata

Exceptions

Exception

at line 129
HmacKeyMetadata update(string $projectId, string $accessId, HmacKeyMetadata $postBody, array $optParams = [])

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

Parameters

string $projectId

Project ID owning the service account of the updated key.
string $accessId

Name of the HMAC key being updated.
HmacKeyMetadata $postBody
array $optParams

Optional parameters.

Return Value

HmacKeyMetadata

Exceptions

Exception