BucketRetentionPolicy class

The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.

Constructors

BucketRetentionPolicy({Input<String>? effectiveTime, Input<bool>? isLocked, Input<String>? retentionPeriod})
Creates a new BucketRetentionPolicy. effectiveTime Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format. isLocked Once locked, an object retention policy cannot be modified. retentionPeriod The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
const
BucketRetentionPolicy.fromMap(Map<String, dynamic> map)
factory

Properties

effectiveTime → Input<String>?
Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
final
hashCode → int
The hash code for this object.
no setterinherited
isLocked → Input<bool>?
Once locked, an object retention policy cannot be modified.
final
retentionPeriod → Input<String>?
The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited