Class: Google::Cloud::Redis::V1::PersistenceConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/redis/v1/cloud_redis.rb

Overview

Configuration of the persistence functionality.

Defined Under Namespace

Modules: PersistenceMode, SnapshotPeriod

Instance Attribute Summary collapse

Instance Attribute Details

#persistence_mode ⇒ ::Google::Cloud::Redis::V1::PersistenceConfig::PersistenceMode

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

Returns:



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 364

class PersistenceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Available Persistence modes.
  module PersistenceMode
    # Not set.
    PERSISTENCE_MODE_UNSPECIFIED = 0

    # Persistence is disabled for the instance,
    # and any existing snapshots are deleted.
    DISABLED = 1

    # RDB based Persistence is enabled.
    RDB = 2
  end

  # Available snapshot periods for scheduling.
  module SnapshotPeriod
    # Not set.
    SNAPSHOT_PERIOD_UNSPECIFIED = 0

    # Snapshot every 1 hour.
    ONE_HOUR = 3

    # Snapshot every 6 hours.
    SIX_HOURS = 4

    # Snapshot every 12 hours.
    TWELVE_HOURS = 5

    # Snapshot every 24 hours.
    TWENTY_FOUR_HOURS = 6
  end
end

#rdb_next_snapshot_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 364

class PersistenceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Available Persistence modes.
  module PersistenceMode
    # Not set.
    PERSISTENCE_MODE_UNSPECIFIED = 0

    # Persistence is disabled for the instance,
    # and any existing snapshots are deleted.
    DISABLED = 1

    # RDB based Persistence is enabled.
    RDB = 2
  end

  # Available snapshot periods for scheduling.
  module SnapshotPeriod
    # Not set.
    SNAPSHOT_PERIOD_UNSPECIFIED = 0

    # Snapshot every 1 hour.
    ONE_HOUR = 3

    # Snapshot every 6 hours.
    SIX_HOURS = 4

    # Snapshot every 12 hours.
    TWELVE_HOURS = 5

    # Snapshot every 24 hours.
    TWENTY_FOUR_HOURS = 6
  end
end

#rdb_snapshot_period ⇒ ::Google::Cloud::Redis::V1::PersistenceConfig::SnapshotPeriod

Returns 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:

  • (::Google::Cloud::Redis::V1::PersistenceConfig::SnapshotPeriod) —

    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.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 364

class PersistenceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Available Persistence modes.
  module PersistenceMode
    # Not set.
    PERSISTENCE_MODE_UNSPECIFIED = 0

    # Persistence is disabled for the instance,
    # and any existing snapshots are deleted.
    DISABLED = 1

    # RDB based Persistence is enabled.
    RDB = 2
  end

  # Available snapshot periods for scheduling.
  module SnapshotPeriod
    # Not set.
    SNAPSHOT_PERIOD_UNSPECIFIED = 0

    # Snapshot every 1 hour.
    ONE_HOUR = 3

    # Snapshot every 6 hours.
    SIX_HOURS = 4

    # Snapshot every 12 hours.
    TWELVE_HOURS = 5

    # Snapshot every 24 hours.
    TWENTY_FOUR_HOURS = 6
  end
end

#rdb_snapshot_start_time ⇒ ::Google::Protobuf::Timestamp

Returns 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:

  • (::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.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 364

class PersistenceConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Available Persistence modes.
  module PersistenceMode
    # Not set.
    PERSISTENCE_MODE_UNSPECIFIED = 0

    # Persistence is disabled for the instance,
    # and any existing snapshots are deleted.
    DISABLED = 1

    # RDB based Persistence is enabled.
    RDB = 2
  end

  # Available snapshot periods for scheduling.
  module SnapshotPeriod
    # Not set.
    SNAPSHOT_PERIOD_UNSPECIFIED = 0

    # Snapshot every 1 hour.
    ONE_HOUR = 3

    # Snapshot every 6 hours.
    SIX_HOURS = 4

    # Snapshot every 12 hours.
    TWELVE_HOURS = 5

    # Snapshot every 24 hours.
    TWENTY_FOUR_HOURS = 6
  end
end