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.
Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Timestamp values in the past indicate 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
State
public Field.Types.TtlConfig.Types.State State { get; set; }Output only. The state of the TTL configuration.
| Property Value | |
|---|---|
| Type | Description |
FieldTypesTtlConfigTypesState |
|