Interface BucketMetadata (7.16.0)
Stay organized with collections
Save and categorize content based on your preferences.
Inheritance
BaseMetadata
>
BucketMetadata
Package
@google-cloud/storage
Properties
acl
?:
AclMetadata
[]
|
null
;
autoclass
?:
{
enabled
?:
boolean
;
toggleTime
?:
string
;
terminalStorageClass
?:
string
;
terminalStorageClassUpdateTime
?:
string
;
};
billing
?:
{
requesterPays
?:
boolean
;
};
customPlacementConfig
?:
{
dataLocations
?:
string
[];
};
defaultEventBasedHold
?:
boolean
;
defaultObjectAcl
?:
AclMetadata
[];
encryption
?:
{
defaultKmsKeyName
?:
string
;
}
|
null
;
hardDeleteTime
?:
string
;
hierarchicalNamespace
?:
{
enabled
?:
boolean
;
};
iamConfiguration
?:
{
publicAccessPrevention
?:
string
;
uniformBucketLevelAccess
?:
{
enabled
?:
boolean
;
lockedTime
?:
string
;
};
};
labels
?:
{
[
key
:
string
]
:
string
|
null
;
};
lifecycle
?:
{
rule
?:
LifecycleRule
[];
}
|
null
;
logging
?:
{
logBucket
?:
string
;
logObjectPrefix
?:
string
;
};
metageneration
?:
string
;
objectRetention
?:
{
mode
?:
string
;
};
owner
?:
{
entity
?:
string
;
entityId
?:
string
;
};
projectNumber
?:
string
|
number
;
retentionPolicy
?:
{
effectiveTime
?:
string
;
isLocked
?:
boolean
;
retentionPeriod
?:
string
|
number
;
}
|
null
;
softDeletePolicy
?:
{
retentionDurationSeconds
?:
string
|
number
;
readonly
effectiveTime
?:
string
;
};
softDeleteTime
?:
string
;
versioning
?:
{
enabled
?:
boolean
;
};
website
?:
{
mainPageSuffix
?:
string
;
notFoundPage
?:
string
;
};
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Interface BucketMetadata (7.16.0)\n\nVersion latestkeyboard_arrow_down\n\n- [7.16.0 (latest)](/nodejs/docs/reference/storage/latest/storage/bucketmetadata)\n- [7.13.0](/nodejs/docs/reference/storage/7.13.0/storage/bucketmetadata)\n- [7.3.2](/nodejs/docs/reference/storage/7.3.2/storage/bucketmetadata)\n- [7.2.0](/nodejs/docs/reference/storage/7.2.0/storage/bucketmetadata)\n- [7.1.0](/nodejs/docs/reference/storage/7.1.0/storage/bucketmetadata)\n- [7.0.1](/nodejs/docs/reference/storage/7.0.1/storage/bucketmetadata)\n- [6.12.0](/nodejs/docs/reference/storage/6.12.0/storage/bucketmetadata)\n- [6.11.0](/nodejs/docs/reference/storage/6.11.0/storage/bucketmetadata)\n- [6.7.0](/nodejs/docs/reference/storage/6.7.0/storage/bucketmetadata)\n- [6.6.0](/nodejs/docs/reference/storage/6.6.0/storage/bucketmetadata)\n- [6.5.4](/nodejs/docs/reference/storage/6.5.4/storage/bucketmetadata)\n- [6.4.2](/nodejs/docs/reference/storage/6.4.2/storage/bucketmetadata)\n- [6.3.0](/nodejs/docs/reference/storage/6.3.0/storage/bucketmetadata)\n- [6.2.3](/nodejs/docs/reference/storage/6.2.3/storage/bucketmetadata)\n- [5.19.1](/nodejs/docs/reference/storage/5.19.1/storage/bucketmetadata)\n- [5.18.3](/nodejs/docs/reference/storage/5.18.3/storage/bucketmetadata)\n- [5.17.0](/nodejs/docs/reference/storage/5.17.0/storage/bucketmetadata)\n- [5.16.1](/nodejs/docs/reference/storage/5.16.1/storage/bucketmetadata)\n- [5.15.6](/nodejs/docs/reference/storage/5.15.6/storage/bucketmetadata)\n- [5.14.8](/nodejs/docs/reference/storage/5.14.8/storage/bucketmetadata)\n- [5.13.2](/nodejs/docs/reference/storage/5.13.2/storage/bucketmetadata)\n- [5.12.0](/nodejs/docs/reference/storage/5.12.0/storage/bucketmetadata)\n- [5.11.1](/nodejs/docs/reference/storage/5.11.1/storage/bucketmetadata)\n- [5.10.0](/nodejs/docs/reference/storage/5.10.0/storage/bucketmetadata)\n- [5.9.0](/nodejs/docs/reference/storage/5.9.0/storage/bucketmetadata)\n- [5.8.5](/nodejs/docs/reference/storage/5.8.5/storage/bucketmetadata) \n\nInheritance\n-----------\n\nBaseMetadata \\\u003e BucketMetadata\n\nPackage\n-------\n\n[@google-cloud/storage](../overview.html)\n\nProperties\n----------\n\n### acl\n\n acl?: AclMetadata[] | null;\n\n### autoclass\n\n autoclass?: {\n enabled?: boolean;\n toggleTime?: string;\n terminalStorageClass?: string;\n terminalStorageClassUpdateTime?: string;\n };\n\n### billing\n\n billing?: {\n requesterPays?: boolean;\n };\n\n### cors\n\n cors?: Cors[];\n\n### customPlacementConfig\n\n customPlacementConfig?: {\n dataLocations?: string[];\n };\n\n### defaultEventBasedHold\n\n defaultEventBasedHold?: boolean;\n\n### defaultObjectAcl\n\n defaultObjectAcl?: AclMetadata[];\n\n### encryption\n\n encryption?: {\n defaultKmsKeyName?: string;\n } | null;\n\n### generation\n\n generation?: string;\n\n### hardDeleteTime\n\n hardDeleteTime?: string;\n\n### hierarchicalNamespace\n\n hierarchicalNamespace?: {\n enabled?: boolean;\n };\n\n### iamConfiguration\n\n iamConfiguration?: {\n publicAccessPrevention?: string;\n uniformBucketLevelAccess?: {\n enabled?: boolean;\n lockedTime?: string;\n };\n };\n\n### labels\n\n labels?: {\n [key: string]: string | null;\n };\n\n### lifecycle\n\n lifecycle?: {\n rule?: LifecycleRule[];\n } | null;\n\n### location\n\n location?: string;\n\n### locationType\n\n locationType?: string;\n\n### logging\n\n logging?: {\n logBucket?: string;\n logObjectPrefix?: string;\n };\n\n### metageneration\n\n metageneration?: string;\n\n### name\n\n name?: string;\n\n### objectRetention\n\n objectRetention?: {\n mode?: string;\n };\n\n### owner\n\n owner?: {\n entity?: string;\n entityId?: string;\n };\n\n### projectNumber\n\n projectNumber?: string | number;\n\n### retentionPolicy\n\n retentionPolicy?: {\n effectiveTime?: string;\n isLocked?: boolean;\n retentionPeriod?: string | number;\n } | null;\n\n### rpo\n\n rpo?: string;\n\n### softDeletePolicy\n\n softDeletePolicy?: {\n retentionDurationSeconds?: string | number;\n readonly effectiveTime?: string;\n };\n\n### softDeleteTime\n\n softDeleteTime?: string;\n\n### storageClass\n\n storageClass?: string;\n\n### timeCreated\n\n timeCreated?: string;\n\n### updated\n\n updated?: string;\n\n### versioning\n\n versioning?: {\n enabled?: boolean;\n };\n\n### website\n\n website?: {\n mainPageSuffix?: string;\n notFoundPage?: string;\n };"]]