Share via

FileProperties Class

  • Reference

File's properties class.

Inheritance
azure.storage.fileshare._shared.models.DictMixin
FileProperties

Constructor

FileProperties(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get 

get(key, default=None)

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k)

Parameters

Name Description
k
Required

items 

items()

keys 

keys()

update 

update(*args, **kwargs)

values 

values()

Attributes

change_time

Change time for the file.

change_time: datetime | str | None = None

content_length

Size of file in bytes.

content_length: int

content_range

Indicates the range of bytes returned in the event that the client requested a subset of the file.

content_range: str | None = None

content_settings

The content settings for the file.

content_settings: ContentSettings

copy

The copy properties.

copy: CopyProperties

creation_time

Creation time for the file.

creation_time: datetime | str | None = None

etag

The ETag contains a value that can be used to perform operations conditionally.

etag: str

file_attributes

The file system attributes for files and directories.

file_attributes: str | NTFSAttributes

file_id

FileId uniquely identifies the file or directory.

file_id: str

file_type

String indicating the type of file.

file_type: str

is_directory

Whether input is a directory.

is_directory: bool = False

last_access_time

Last access time for the file.

last_access_time: datetime | None = None

last_modified

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

last_modified: datetime

last_write_time

Last write time for the file.

last_write_time: datetime | str | None = None

lease

File lease properties.

lease: LeaseProperties

metadata

Name-value pairs to associate with the file as metadata.

metadata: Dict[str, str]

name

The name of the file.

name: str

parent_id

ParentId uniquely identifies the parent directory of the object.

parent_id: str | None = None

path

The path of the file.

path: str | None = None

permission_key

Key of the permission to be set for the directory/file.

permission_key: str

server_encrypted

Whether encryption is enabled.

server_encrypted: bool

share

The name of the share.

share: str | None = None

size

Size of the file in bytes.

size: int

snapshot

File snapshot.

snapshot: str | None = None