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

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.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#expiration_offset

def expiration_offset() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — 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.

#expiration_offset=

def expiration_offset=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — 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.

Returns
  • (::Google::Protobuf::Duration) — 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.

#state

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