on_key_list Event

Fires once for each key when listing keys.

Syntax

class GoogleKMSKeyListEventParams(object):
  @property
  def name() -> str: ...
  @property
  def purpose() -> int: ...
  @property
  def creation_date() -> str: ...
  @property
  def primary_version() -> str: ...

# In class GoogleKMS:
@property
def on_key_list() -> Callable[[GoogleKMSKeyListEventParams], None]: ...
@on_key_list.setter
def on_key_list(event_hook: Callable[[GoogleKMSKeyListEventParams], None]) -> None: ...

Remarks

This event fires once for each key returned when list_keys or get_key_info is called.

Name reflects the name of the key.

Purpose reflects the key's purpose. Possible values are:

• 0: Unspecified.
• 1: A symmetric key used for encryption and decryption.
• 2: An asymmetric key used for signing and verification.
• 3: An asymmetric key used for encryption and decryption.

CreationDate reflects the key's creation date, formatted as an RFC 3339 UTC timestamp.

PrimaryVersion reflects the Id of the key's primary version if it is symmetric. For asymmetric keys, it is always empty, since asymmetric keys cannot have a primary version.