Class: Google::Cloud::Firestore::Admin::V1::Field::TtlConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/admin/v1/field.rb

Overview

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.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ ::Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State (readonly)

Returns Output only. The state of the TTL configuration.

Returns:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/firestore/admin/v1/field.rb', line 108

class TtlConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of applying the TTL configuration to all documents.
  module State
    # The state is unspecified or unknown.
    STATE_UNSPECIFIED = 0

    # The TTL is being applied. There is an active long-running operation to
    # track the change. Newly written documents will have TTLs applied as
    # requested. Requested TTLs on existing documents are still being
    # processed. When TTLs on all existing documents have been processed, the
    # state will move to 'ACTIVE'.
    CREATING = 1

    # The TTL is active for all documents.
    ACTIVE = 2

    # The TTL configuration could not be enabled for all existing documents.
    # Newly written documents will continue to have their TTL applied.
    # The LRO returned when last attempting to enable TTL for this `Field`
    # has failed, and may have more details.
    NEEDS_REPAIR = 3
  end
end