Class PersistenceConfig (2.49.0)

public final class PersistenceConfig extends GeneratedMessageV3 implements PersistenceConfigOrBuilder

Configuration of the persistence functionality.

Protobuf type google.cloud.redis.v1beta1.PersistenceConfig

Static Fields

PERSISTENCE_MODE_FIELD_NUMBER

public static final int PERSISTENCE_MODE_FIELD_NUMBER
Field Value
Type Description
int

RDB_NEXT_SNAPSHOT_TIME_FIELD_NUMBER

public static final int RDB_NEXT_SNAPSHOT_TIME_FIELD_NUMBER
Field Value
Type Description
int

RDB_SNAPSHOT_PERIOD_FIELD_NUMBER

public static final int RDB_SNAPSHOT_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

RDB_SNAPSHOT_START_TIME_FIELD_NUMBER

public static final int RDB_SNAPSHOT_START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PersistenceConfig getDefaultInstance()
Returns
Type Description
PersistenceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PersistenceConfig.Builder newBuilder()
Returns
Type Description
PersistenceConfig.Builder

newBuilder(PersistenceConfig prototype)

public static PersistenceConfig.Builder newBuilder(PersistenceConfig prototype)
Parameter
Name Description
prototype PersistenceConfig
Returns
Type Description
PersistenceConfig.Builder

parseDelimitedFrom(InputStream input)

public static PersistenceConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PersistenceConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PersistenceConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PersistenceConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PersistenceConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PersistenceConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PersistenceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PersistenceConfig> parser()
Returns
Type Description
Parser<PersistenceConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PersistenceConfig getDefaultInstanceForType()
Returns
Type Description
PersistenceConfig

getParserForType()

public Parser<PersistenceConfig> getParserForType()
Returns
Type Description
Parser<PersistenceConfig>
Overrides

getPersistenceMode()

public PersistenceConfig.PersistenceMode getPersistenceMode()

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

.google.cloud.redis.v1beta1.PersistenceConfig.PersistenceMode persistence_mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistenceConfig.PersistenceMode

The persistenceMode.

getPersistenceModeValue()

public int getPersistenceModeValue()

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

.google.cloud.redis.v1beta1.PersistenceConfig.PersistenceMode persistence_mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for persistenceMode.

getRdbNextSnapshotTime()

public Timestamp getRdbNextSnapshotTime()

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

.google.protobuf.Timestamp rdb_next_snapshot_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The rdbNextSnapshotTime.

getRdbNextSnapshotTimeOrBuilder()

public TimestampOrBuilder getRdbNextSnapshotTimeOrBuilder()

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

.google.protobuf.Timestamp rdb_next_snapshot_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRdbSnapshotPeriod()

public PersistenceConfig.SnapshotPeriod 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.

.google.cloud.redis.v1beta1.PersistenceConfig.SnapshotPeriod rdb_snapshot_period = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PersistenceConfig.SnapshotPeriod

The rdbSnapshotPeriod.

getRdbSnapshotPeriodValue()

public int getRdbSnapshotPeriodValue()

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.

.google.cloud.redis.v1beta1.PersistenceConfig.SnapshotPeriod rdb_snapshot_period = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for rdbSnapshotPeriod.

getRdbSnapshotStartTime()

public Timestamp 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.

.google.protobuf.Timestamp rdb_snapshot_start_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The rdbSnapshotStartTime.

getRdbSnapshotStartTimeOrBuilder()

public TimestampOrBuilder getRdbSnapshotStartTimeOrBuilder()

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.

.google.protobuf.Timestamp rdb_snapshot_start_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasRdbNextSnapshotTime()

public boolean hasRdbNextSnapshotTime()

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

.google.protobuf.Timestamp rdb_next_snapshot_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the rdbNextSnapshotTime field is set.

hasRdbSnapshotStartTime()

public boolean hasRdbSnapshotStartTime()

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.

.google.protobuf.Timestamp rdb_snapshot_start_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rdbSnapshotStartTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PersistenceConfig.Builder newBuilderForType()
Returns
Type Description
PersistenceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PersistenceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PersistenceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PersistenceConfig.Builder toBuilder()
Returns
Type Description
PersistenceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException