Cloud Firestore V1 Client - Class TtlConfig (1.31.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class 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.

Generated from protobuf message google.firestore.admin.v1.Field.TtlConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ state int

Output only. The state of the TTL configuration.

getState

Output only. The state of the TTL configuration.

Returns
TypeDescription
int

setState

Output only. The state of the TTL configuration.

Parameter
NameDescription
var int
Returns
TypeDescription
$this