Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Field::TtlConfig (v1.9.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Field::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#state

def state() -> ::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State
Returns