GoogleFirestoreAdminV1TtlConfig class
The TTL (time-to-live) configuration for documents that have this Field
set.
A timestamp stored in a TTL-enabled field will be used to determine the
expiration time of the document. The expiration time is the sum of the
timestamp value and the expiration_offset. For Enterprise edition
databases, the timestamp value may alternatively be stored in an array value
in the TTL-enabled field. An expiration time in the past indicates that the
document is eligible for immediate expiration. Using any other data type or
leaving the field absent will disable expiration for the individual
document.
Constructors
- GoogleFirestoreAdminV1TtlConfig({String? expirationOffset, String? state})
- GoogleFirestoreAdminV1TtlConfig.fromJson(Map json_)
Properties
- expirationOffset ↔ String?
-
The offset, relative to the timestamp value from the TTL-enabled field,
used to determine the document's expiration time.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state ↔ String?
-
The state of the TTL configuration.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited