PathProperties Class

Path properties listed by get_paths api.

Constructor

PathProperties(**kwargs: Any)

Variables

Name	Description
encryption_scope	str A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the file system, this value will override it if the file system level scope is configured to allow overrides. Otherwise an error will be raised.
encryption_context	str Specifies the encryption context to set on the file.

Methods

get
has_key
items
keys
update
values

get

get(key, default=None)

Parameters

Name	Description
key Required
default Required	Default value: None

has_key

has_key(k)

Parameters

Name	Description
k Required

items

items()

keys

keys()

update

update(*args, **kwargs)

values

values()

Attributes

content_length

The size of file if the path is a file.

content_length: int

creation_time

The creation time of the file/directory.

creation_time: datetime

encryption_context

Specifies the encryption context to set on the file.

encryption_context: str | None = None

encryption_scope

A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the file system, this value will override it if the file system level scope is configured to allow overrides. Otherwise an error will be raised.

encryption_scope: str | None = None

etag

The ETag contains a value that you can use to perform operations conditionally.

etag: str

expiry_time

The expiry time of the file/directory.

expiry_time: datetime | None = None

group

The owning group of the file or directory.

group: str

is_directory

Whether the path a directory.

is_directory: bool

last_modified

A datetime object representing the last time the directory/file was modified.

last_modified: datetime

name

The full path for a file or directory.

name: str

owner

The owner of the file or directory.

owner: str

permissions

The permissions that are set for user, group, and other on the file or directory. Each individual permission is in [r,w,x,-]{3} format.

permissions: str