Class PersistenceConfig (2.37.0)

public final class PersistenceConfig extends GeneratedMessageV3 implements PersistenceConfigOrBuilder

Configuration of the persistence functionality.

Protobuf type google.cloud.redis.v1.PersistenceConfig

Static Fields

PERSISTENCE_MODE_FIELD_NUMBER

public static final int PERSISTENCE_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

RDB_NEXT_SNAPSHOT_TIME_FIELD_NUMBER

public static final int RDB_NEXT_SNAPSHOT_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

RDB_SNAPSHOT_PERIOD_FIELD_NUMBER

public static final int RDB_SNAPSHOT_PERIOD_FIELD_NUMBER
Field Value
TypeDescription
int

RDB_SNAPSHOT_START_TIME_FIELD_NUMBER

public static final int RDB_SNAPSHOT_START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PersistenceConfig getDefaultInstance()
Returns
TypeDescription
PersistenceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PersistenceConfig.Builder newBuilder()
Returns
TypeDescription
PersistenceConfig.Builder

newBuilder(PersistenceConfig prototype)

public static PersistenceConfig.Builder newBuilder(PersistenceConfig prototype)
Parameter
NameDescription
prototypePersistenceConfig
Returns
TypeDescription
PersistenceConfig.Builder

parseDelimitedFrom(InputStream input)

public static PersistenceConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PersistenceConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PersistenceConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PersistenceConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PersistenceConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PersistenceConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PersistenceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PersistenceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PersistenceConfig> parser()
Returns
TypeDescription
Parser<PersistenceConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PersistenceConfig getDefaultInstanceForType()
Returns
TypeDescription
PersistenceConfig

getParserForType()

public Parser<PersistenceConfig> getParserForType()
Returns
TypeDescription
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.v1.PersistenceConfig.PersistenceMode persistence_mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.v1.PersistenceConfig.PersistenceMode persistence_mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1.PersistenceConfig.SnapshotPeriod rdb_snapshot_period = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.v1.PersistenceConfig.SnapshotPeriod rdb_snapshot_period = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the rdbSnapshotStartTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PersistenceConfig.Builder newBuilderForType()
Returns
TypeDescription
PersistenceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PersistenceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PersistenceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PersistenceConfig.Builder toBuilder()
Returns
TypeDescription
PersistenceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException