on_blob_list Event
Fires once for each blob returned when listing blobs.
Syntax
class AzureBlobBlobListEventParams(object): @property def name() -> str: ... @property def container() -> str: ... @property def blob_type() -> int: ... @property def snapshot() -> str: ... @property def content_length() -> int: ... @property def content_type() -> str: ... @property def created_time() -> str: ... @property def modified_time() -> str: ... @property def e_tag() -> str: ... @property def soft_deleted() -> bool: ... @property def is_leased() -> bool: ... @property def lease_state() -> int: ... # In class AzureBlob: @property def on_blob_list() -> Callable[[AzureBlobBlobListEventParams], None]: ... @on_blob_list.setter def on_blob_list(event_hook: Callable[[AzureBlobBlobListEventParams], None]) -> None: ...
Remarks
This event fires once for each blob returned when list_blobs or get_blob_info is called.
Name is the name of the blob.
Container is the name of the blob's container.
BlobType is the blob's type. Possible values are:
abtBlockBlob (0) | Block blob |
abtPageBlob (1) | Page blob |
abtAppendBlob (2) | Append blob |
Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.
Snapshot is the snapshot identifier, if the current item represents a blob snapshot; empty otherwise.
ContentLength is the size of the blob's committed data in bytes, for block blobs and append blobs. For page blobs, its the capacity in bytes.
ContentType is the blob's content type. Always empty for uncommitted block blobs.
CreatedTime and ModifiedTime reflect the creation and last modified times of the blob, formatted according to RFC 1123. The latter is always empty for uncommitted block blobs.
ETag is the blob's ETag. Always empty for uncommitted block blobs.
SoftDeleted indicates whether the blob (or snapshot, if Snapshot is non-empty) has been soft-deleted.
IsLeased indicates whether the blob is currently leased. Always False if SoftDeleted is True and/or Snapshot is non-empty.
LeaseState reflects the lease state of the blob. Possible values are:
ablsAvailable (0) | The blob's lease is unlocked and can be acquired. |
ablsLeased (1) | The blob's lease is locked. |
ablsExpired (2) | The lease duration has expired. |
ablsBreaking (3) | The lease has been broken, but will continue to be locked until the break period expires. |
ablsBroken (4) | The lease has been broken, and the break period has expired. |