Reference documentation and code samples for the Cloud Firestore V1 Client class TtlConfigDelta.
Information about a TTL configuration change.
Generated from protobuf message google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ FieldOperationMetadataMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ change_type |
int
Specifies how the TTL configuration is changing. |
↳ expiration_offset |
Google\Protobuf\Duration
The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time. |
getChangeType
Specifies how the TTL configuration is changing.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ChangeType. |
setChangeType
Specifies how the TTL configuration is changing.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ChangeType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpirationOffset
The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasExpirationOffset
clearExpirationOffset
setExpirationOffset
The offset, relative to the timestamp value in the TTL-enabled field, used determine the document's expiration time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|