Google Cloud Redis V1beta1 Client - Class PersistenceConfig (1.7.0)

Reference documentation and code samples for the Google Cloud Redis V1beta1 Client class PersistenceConfig.

Configuration of the persistence functionality.

Generated from protobuf message google.cloud.redis.v1beta1.PersistenceConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ persistence_mode int

Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used.

↳ rdb_snapshot_period int

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default.

↳ rdb_next_snapshot_time Google\Protobuf\Timestamp

Output only. The next time that a snapshot attempt is scheduled to occur.

↳ rdb_snapshot_start_time Google\Protobuf\Timestamp

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used.

getPersistenceMode

Optional. Controls whether Persistence features are enabled.

If not provided, the existing value will be used.

Returns
TypeDescription
int

setPersistenceMode

Optional. Controls whether Persistence features are enabled.

If not provided, the existing value will be used.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRdbSnapshotPeriod

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on.

If not provided, TWENTY_FOUR_HOURS will be used as default.

Returns
TypeDescription
int

setRdbSnapshotPeriod

Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on.

If not provided, TWENTY_FOUR_HOURS will be used as default.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRdbNextSnapshotTime

Output only. The next time that a snapshot attempt is scheduled to occur.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasRdbNextSnapshotTime

clearRdbNextSnapshotTime

setRdbNextSnapshotTime

Output only. The next time that a snapshot attempt is scheduled to occur.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getRdbSnapshotStartTime

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned.

If not provided, the current time will be used.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasRdbSnapshotStartTime

clearRdbSnapshotStartTime

setRdbSnapshotStartTime

Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned.

If not provided, the current time will be used.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this