File locks

class b2sdk.v1.LegalHold

Enum holding information about legalHold switch in a file.

ON = 'on'

legal hold set to “on”

OFF = 'off'

legal hold set to “off”

UNSET = None

server default, as for now it is functionally equivalent to OFF

UNKNOWN = 'unknown'

the client is not authorized to read legal hold settings

is_on()

Is the legalHold switch on?

is_off()

Is the legalHold switch off or left as default (which also means off)?

is_unknown()

Is the legalHold switch unknown?

class b2sdk.v1.FileRetentionSetting

Represent file retention settings, i.e. whether the file is retained, in which mode and until when

__init__(mode: b2sdk.file_lock.RetentionMode, retain_until: Optional[int] = None)

Initialize self. See help(type(self)) for accurate signature.

class b2sdk.v1.RetentionMode

Enum class representing retention modes set in files and buckets

GOVERNANCE = 'governance'

retention settings for files in this mode can be modified by clients with appropriate application key capabilities

COMPLIANCE = 'compliance'

retention settings for files in this mode can only be modified by extending the retention dates by clients with appropriate application key capabilities

NONE = None

retention not set

UNKNOWN = 'unknown'

the client is not authorized to read retention settings

class b2sdk.v1.BucketRetentionSetting

Represent bucket’s default file retention settings, i.e. whether the files should be retained, in which mode and for how long

__init__(mode: b2sdk.file_lock.RetentionMode, period: Optional[b2sdk.file_lock.RetentionPeriod] = None)

Initialize self. See help(type(self)) for accurate signature.

class b2sdk.v1.RetentionPeriod

Represent a time period (either in days or in years) that is used as a default for bucket retention

KNOWN_UNITS = ['days', 'years']

__init__(years: Optional[int] = None, days: Optional[int] = None)

Create a retention period, provide exactly one of: days, years

classmethod from_period_dict(period_dict)

Build a RetentionPeriod from an object returned by the server, such as:

{
    "duration": 2,
    "unit": "years"
}

as_dict()

class b2sdk.v1.FileLockConfiguration

Represent bucket’s file lock configuration, i.e. whether the file lock mechanism is enabled and default file retention

__init__(default_retention: b2sdk.file_lock.BucketRetentionSetting, is_file_lock_enabled: Optional[bool])

Initialize self. See help(type(self)) for accurate signature.

b2sdk.v1.UNKNOWN_BUCKET_RETENTION

Commonly used “unknown” default bucket retention setting

b2sdk.v1.UNKNOWN_FILE_LOCK_CONFIGURATION

Commonly used “unknown” bucket file lock setting

b2sdk.v1.NO_RETENTION_BUCKET_SETTING

Commonly used “no retention” default bucket retention

b2sdk.v1.NO_RETENTION_FILE_SETTING

Commonly used “no retention” file setting

b2sdk.v1.UNKNOWN_FILE_RETENTION_SETTING

Commonly used “unknown” file retention setting