Class Backup.QuantityBasedExpiry.Builder (0.34.0)

public static final class Backup.QuantityBasedExpiry.Builder extends GeneratedMessageV3.Builder<Backup.QuantityBasedExpiry.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Backup.QuantityBasedExpiry.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Backup.QuantityBasedExpiry.Builder clear()
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Backup.QuantityBasedExpiry.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Backup.QuantityBasedExpiry.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

clearRetentionCount()

public Backup.QuantityBasedExpiry.Builder clearRetentionCount()

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
Backup.QuantityBasedExpiry.Builder

This builder for chaining.

clearTotalRetentionCount()

public Backup.QuantityBasedExpiry.Builder clearTotalRetentionCount()

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
Backup.QuantityBasedExpiry.Builder

This builder for chaining.

clone()

public Backup.QuantityBasedExpiry.Builder clone()
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Backup.QuantityBasedExpiry other)

public Backup.QuantityBasedExpiry.Builder mergeFrom(Backup.QuantityBasedExpiry other)
Parameter
Name Description
other Backup.QuantityBasedExpiry
Returns
Type Description
Backup.QuantityBasedExpiry.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Backup.QuantityBasedExpiry.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Backup.QuantityBasedExpiry.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Backup.QuantityBasedExpiry.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Backup.QuantityBasedExpiry.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Backup.QuantityBasedExpiry.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides

setRetentionCount(int value)

public Backup.QuantityBasedExpiry.Builder setRetentionCount(int value)

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];

Parameter
Name Description
value int

The retentionCount to set.

Returns
Type Description
Backup.QuantityBasedExpiry.Builder

This builder for chaining.

setTotalRetentionCount(int value)

public Backup.QuantityBasedExpiry.Builder setTotalRetentionCount(int value)

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];

Parameter
Name Description
value int

The totalRetentionCount to set.

Returns
Type Description
Backup.QuantityBasedExpiry.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Backup.QuantityBasedExpiry.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Backup.QuantityBasedExpiry.Builder
Overrides