Class HMACKeyMetadata (2.19.0)

Version 2.19.0

• 3.0.0-rc1 (latest)
• 2.19.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.44.0
• 1.43.0
• 1.42.3
• 1.41.1
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.1
• 1.36.2
• 1.35.1
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.2
• 1.30.0
• 1.29.0
• 1.28.1
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0

HMACKeyMetadata(client, access_id=None, project_id=None, user_project=None)

Metadata about an HMAC service account key withn Cloud Storage.

Parameters
Name	Description
client	Client client associated with the key metadata.
access_id	str (Optional) Unique ID of an existing key.
project_id	str (Optional) Project ID of an existing key. Defaults to client's project.
user_project	str (Optional) This parameter is currently ignored.

Properties

access_id

Access ID of the key.

Returns
Type	Description
str or None	unique identifier of the key within a project.

etag

ETag identifying the version of the key metadata.

Returns
Type	Description
str or None	ETag for the version of the key's metadata.

id

ID of the key, including the Project ID and the Access ID.

Returns
Type	Description
str or None	ID of the key.

path

Resource path for the metadata's key.

project

Project ID associated with the key.

Returns
Type	Description
str or None	project identfier for the key.

service_account_email

Service account e-mail address associated with the key.

Returns
Type	Description
str or None	e-mail address for the service account which created the key.

state

Get / set key's state.

One of:

• ACTIVE
• INACTIVE
• DELETED

Returns
Type	Description
str or None	key's current state.

time_created

Retrieve the timestamp at which the HMAC key was created.

Returns
Type	Description
datetime.datetime or NoneType	Datetime object parsed from RFC3339 valid timestamp, or None if the bucket's resource has not been loaded from the server.

updated

Retrieve the timestamp at which the HMAC key was created.

Returns
Type	Description
datetime.datetime or NoneType	Datetime object parsed from RFC3339 valid timestamp, or None if the bucket's resource has not been loaded from the server.

user_project

Project ID to be billed for API requests made via this bucket.

This property is currently ignored by the server.

Methods

delete

delete(timeout=60, retry=<google.api_core.retry.retry_unary.Retry object>)

Delete the key from Cloud Storage.

Exceptions
Type	Description
google.api_core.exceptions.NotFound	if the key does not exist on the back-end.

exists

exists(timeout=60, retry=<google.api_core.retry.retry_unary.Retry object>)

Determine whether or not the key for this metadata exists.

Returns
Type	Description
bool	True if the key exists in Cloud Storage.

reload

reload(timeout=60, retry=<google.api_core.retry.retry_unary.Retry object>)

Reload properties from Cloud Storage.

Exceptions
Type	Description
google.api_core.exceptions.NotFound	if the key does not exist on the back-end.

update

update(timeout=60, retry=<google.cloud.storage.retry.ConditionalRetryPolicy object>)

Save writable properties to Cloud Storage.

Exceptions
Type	Description
google.api_core.exceptions.NotFound	if the key does not exist on the back-end.