public sealed class Field.Types.TtlConfig : IMessage<Field.Types.TtlConfig>, IEquatable<Field.Types.TtlConfig>, IDeepCloneable<Field.Types.TtlConfig>, IBufferMessage, IMessageReference documentation and code samples for the Firestore Admin v1 API class Field.Types.TtlConfig.
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.
Implements
IMessageFieldTypesTtlConfig, IEquatableFieldTypesTtlConfig, IDeepCloneableFieldTypesTtlConfig, IBufferMessage, IMessageNamespace
Google.Cloud.Firestore.Admin.V1Assembly
Google.Cloud.Firestore.Admin.V1.dll
Constructors
TtlConfig()
public TtlConfig()TtlConfig(TtlConfig)
public TtlConfig(Field.Types.TtlConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
FieldTypesTtlConfig |
Properties
ExpirationOffset
public Duration ExpirationOffset { get; set; }Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time.
expiration_offset.seconds must be between 0 and 2,147,483,647
inclusive. Values more precise than seconds are rejected.
If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field.
| Property Value | |
|---|---|
| Type | Description |
Duration |
|
State
public Field.Types.TtlConfig.Types.State State { get; set; }Output only. The state of the TTL configuration.
| Property Value | |
|---|---|
| Type | Description |
FieldTypesTtlConfigTypesState |
|