on_metadata_list Event

Fires once for each metadata item returned when bucket or file information and metadata is retrieved.

Syntax

class BackblazeB2MetadataListEventParams(object):
  @property
  def bucket_id() -> str: ...
  @property
  def file_id() -> str: ...
  @property
  def name() -> str: ...
  @property
  def value() -> str: ...

# In class BackblazeB2:
@property
def on_metadata_list() -> Callable[[BackblazeB2MetadataListEventParams], None]: ...
@on_metadata_list.setter
def on_metadata_list(event_hook: Callable[[BackblazeB2MetadataListEventParams], None]) -> None: ...

Remarks

This event fires once for each metadata item returned when get_bucket_info or get_file_info is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual bucket or file is returned when list_buckets, list_files, list_file_versions, or list_multipart_uploads is called.

BucketId reflects the Id of the bucket that the file is in (if FileId is non-empty), or that the metadata item is associated with (if FileId is empty).

FileId, if non-empty, reflects the Id of the file that the metadata item is associated with.

Name reflects the name of the metadata item.

Value reflects the value of the metadata item.