on_metadata_list Event

Fires once for each metadata item returned when listing metadata.

Syntax

class AzureBlobMetadataListEventParams(object):
  @property
  def container() -> str: ...
  @property
  def blob() -> str: ...
  @property
  def snapshot() -> str: ...
  @property
  def name() -> str: ...
  @property
  def value() -> str: ...

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

Remarks

This event fires once for each metadata item returned when get_blob_info or get_container_info is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual blob or container is returned when list_blobs or list_containers is called.

Container is the name of the container that the blob is in (if Blob is non-empty), or that the metadata item is associated with (if Blob is empty).

Blob, if non-empty, is the name of the blob that the metadata item is associated with.

Snapshot, if non-empty, is the opaque DateTime value that identifiers the blob snapshot that the metadata item is associated with.

Name is the name of the metadata item, without the x-ms-meta- prefix.

Value the metadata item's value.