Firestore Admin v1 API - Class Field.Types.TtlConfig (3.8.0)

Version latest

• 3.8.0 (latest)
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.4.0
• 2.3.0
• 2.2.0

public sealed class Field.Types.TtlConfig : IMessage<Field.Types.TtlConfig>, IEquatable<Field.Types.TtlConfig>, IDeepCloneable<Field.Types.TtlConfig>, IBufferMessage, IMessage

Reference 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. Using any other data type or leaving the field absent will disable the TTL for the individual document.

Inheritance

object > Field.Types.TtlConfig

Implements

IMessageFieldTypesTtlConfig, IEquatableFieldTypesTtlConfig, IDeepCloneableFieldTypesTtlConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

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