Cloud Firestore V1 Client - Class TtlConfig (1.47.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. 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.

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

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Field

Methods

__construct

Constructor.

Parameters
Name Description
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
Type Description
int

setState

Output only. The state of the TTL configuration.

Parameter
Name Description
var int
Returns
Type Description
$this