@backblaze-labs/b2-sdk - v0.4.0
    Preparing search index...

    Interface BucketInfo

    Complete bucket metadata as returned by the B2 API. Corresponds to the bucket object in responses from b2_list_buckets, b2_create_bucket, and b2_update_bucket.

    interface BucketInfo {
        accountId: AccountId;
        bucketId: BucketId;
        bucketInfo: Record<string, string>;
        bucketName: string;
        bucketType: BucketResponseType;
        corsRules: readonly CorsRule[];
        defaultServerSideEncryption: {
            isClientAuthorizedToRead: boolean;
            value: PublicEncryptionSetting | null;
        };
        fileLockConfiguration: {
            isClientAuthorizedToRead: boolean;
            value: | {
                defaultRetention: BucketDefaultRetention;
                isFileLockEnabled: boolean;
            }
            | null;
        };
        lifecycleRules: readonly LifecycleRule[];
        options: readonly BucketKeyOption[];
        replicationConfiguration: ReadableReplicationConfiguration;
        revision: number;
    }
    Index
    accountId bucketId bucketInfo bucketName bucketType corsRules defaultServerSideEncryption fileLockConfiguration lifecycleRules options replicationConfiguration revision
    accountId: AccountId

    Account that owns this bucket.

    bucketId: BucketId

    Unique identifier for this bucket.

    bucketInfo: Record<string, string>

    User-defined key-value metadata stored on the bucket.

    bucketName: string

    Globally unique name of this bucket.

    bucketType: BucketResponseType

    Access level or response-only type of this bucket.

    corsRules: readonly CorsRule[]

    CORS rules configured on this bucket.

    defaultServerSideEncryption: {
        isClientAuthorizedToRead: boolean;
        value: PublicEncryptionSetting | null;
    }

    Default server-side encryption setting for new files in this bucket.

    Type Declaration

    • ReadonlyisClientAuthorizedToRead: boolean

      Whether the caller is authorized to read default server-side encryption settings.

    • Readonlyvalue: PublicEncryptionSetting | null

      Default server-side encryption settings, or null if the caller lacks read authorization.

    fileLockConfiguration: {
        isClientAuthorizedToRead: boolean;
        value:
            | {
                defaultRetention: BucketDefaultRetention;
                isFileLockEnabled: boolean;
            }
            | null;
    }

    File Lock configuration including authorization status and current settings.

    Type Declaration

    • ReadonlyisClientAuthorizedToRead: boolean

      Whether the caller is authorized to read file lock settings.

    • Readonlyvalue: { defaultRetention: BucketDefaultRetention; isFileLockEnabled: boolean } | null

      File lock settings, or null if the caller lacks read authorization.

    lifecycleRules: readonly LifecycleRule[]

    Lifecycle rules configured on this bucket.

    options: readonly BucketKeyOption[]

    Set of options enabled on this bucket (e.g., BucketKeyOption.S3).

    replicationConfiguration: ReadableReplicationConfiguration

    Cross-region replication configuration, filtered by caller authorization.

    revision: number

    Monotonically increasing revision number, incremented on each bucket update.

    Settings
    Member Visibility

    On This Page
    Properties