Interface BucketFileLockConfigurationResult

Normalized bucket file-lock configuration returned by B2.

interface BucketFileLockConfigurationResult {
    isClientAuthorizedToRead: boolean;
    value:
        | {
            defaultRetention: BucketRetentionPolicyResult;
            isFileLockEnabled: boolean;
        }
        | null;
}

Index

Properties

isClientAuthorizedToRead value

Properties

isClientAuthorizedToRead

isClientAuthorizedToRead: boolean

Whether the current key may read the file-lock configuration value.

value

value:
    | {
        defaultRetention: BucketRetentionPolicyResult;
        isFileLockEnabled: boolean;
    }
    | null

File-lock configuration value, or null when B2 withholds it.

Type Declaration

{ defaultRetention: BucketRetentionPolicyResult; isFileLockEnabled: boolean }
- defaultRetention: BucketRetentionPolicyResult
  
  Default retention policy applied to newly uploaded objects.
- isFileLockEnabled: boolean
  
  Whether Object Lock is enabled for the bucket.
null

Interface BucketFileLockConfigurationResult

Index

Properties

Properties

isClientAuthorizedToRead

value

Type Declaration

defaultRetention: BucketRetentionPolicyResult

isFileLockEnabled: boolean

Settings

On This Page