Class Backup.QuantityBasedExpiry (0.34.0)

public static final class Backup.QuantityBasedExpiry extends GeneratedMessageV3 implements Backup.QuantityBasedExpiryOrBuilder

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected.

Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention).

Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

Protobuf type google.cloud.alloydb.v1.Backup.QuantityBasedExpiry

Static Fields

RETENTION_COUNT_FIELD_NUMBER

public static final int RETENTION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_RETENTION_COUNT_FIELD_NUMBER

public static final int TOTAL_RETENTION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Backup.QuantityBasedExpiry getDefaultInstance()
Returns
Type Description
Backup.QuantityBasedExpiry

getDescriptor()

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

newBuilder()

public static Backup.QuantityBasedExpiry.Builder newBuilder()
Returns
Type Description
Backup.QuantityBasedExpiry.Builder

newBuilder(Backup.QuantityBasedExpiry prototype)

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

parseDelimitedFrom(InputStream input)

public static Backup.QuantityBasedExpiry parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Backup.QuantityBasedExpiry
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Backup.QuantityBasedExpiry parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Backup.QuantityBasedExpiry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Backup.QuantityBasedExpiry parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Backup.QuantityBasedExpiry
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Backup.QuantityBasedExpiry parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Backup.QuantityBasedExpiry
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Backup.QuantityBasedExpiry parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Backup.QuantityBasedExpiry
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Backup.QuantityBasedExpiry> parser()
Returns
Type Description
Parser<QuantityBasedExpiry>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Backup.QuantityBasedExpiry getDefaultInstanceForType()
Returns
Type Description
Backup.QuantityBasedExpiry

getParserForType()

public Parser<Backup.QuantityBasedExpiry> getParserForType()
Returns
Type Description
Parser<QuantityBasedExpiry>
Overrides

getRetentionCount()

public int getRetentionCount()

Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).

int32 retention_count = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The retentionCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalRetentionCount()

public int getTotalRetentionCount()

Output only. The length of the quantity-based queue, specified by the backup's retention policy.

int32 total_retention_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The totalRetentionCount.

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 Backup.QuantityBasedExpiry.Builder newBuilderForType()
Returns
Type Description
Backup.QuantityBasedExpiry.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Backup.QuantityBasedExpiry.Builder toBuilder()
Returns
Type Description
Backup.QuantityBasedExpiry.Builder

writeTo(CodedOutputStream output)

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