Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.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.

Instance Attribute Summary

• #state ⇒ String

  Output only.

Instance Method Summary

• #initialize(**args) ⇒ GoogleFirestoreAdminV1TtlConfig constructor

  A new instance of GoogleFirestoreAdminV1TtlConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1TtlConfig

Returns a new instance of GoogleFirestoreAdminV1TtlConfig.

# File 'lib/google/apis/firestore_v1/classes.rb', line 2213

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#state ⇒ String

Output only. The state of the TTL configuration. Corresponds to the JSON property state

Returns:

• (String)

# File 'lib/google/apis/firestore_v1/classes.rb', line 2211

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 2218

def update!(**args)
  @state = args[:state] if args.key?(:state)
end