Class Backup.Stats.Builder (3.36.0)

public static final class Backup.Stats.Builder extends GeneratedMessage.Builder<Backup.Stats.Builder> implements Backup.StatsOrBuilder

Backup specific statistics.

Protobuf type google.firestore.admin.v1.Backup.Stats

Static Methods

getDescriptor()

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

Methods

build()

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

buildPartial()

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

clear()

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

clearDocumentCount()

public Backup.Stats.Builder clearDocumentCount()

Output only. The total number of documents contained in the backup.

int64 document_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.Stats.Builder

This builder for chaining.

clearIndexCount()

public Backup.Stats.Builder clearIndexCount()

Output only. The total number of index entries contained in the backup.

int64 index_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.Stats.Builder

This builder for chaining.

clearSizeBytes()

public Backup.Stats.Builder clearSizeBytes()

Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.

int64 size_bytes = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Backup.Stats.Builder

This builder for chaining.

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocumentCount()

public long getDocumentCount()

Output only. The total number of documents contained in the backup.

int64 document_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The documentCount.

getIndexCount()

public long getIndexCount()

Output only. The total number of index entries contained in the backup.

int64 index_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The indexCount.

getSizeBytes()

public long getSizeBytes()

Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.

int64 size_bytes = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The sizeBytes.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Backup.Stats other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setDocumentCount(long value)

public Backup.Stats.Builder setDocumentCount(long value)

Output only. The total number of documents contained in the backup.

int64 document_count = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The documentCount to set.

Returns
Type Description
Backup.Stats.Builder

This builder for chaining.

setIndexCount(long value)

public Backup.Stats.Builder setIndexCount(long value)

Output only. The total number of index entries contained in the backup.

int64 index_count = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The indexCount to set.

Returns
Type Description
Backup.Stats.Builder

This builder for chaining.

setSizeBytes(long value)

public Backup.Stats.Builder setSizeBytes(long value)

Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.

int64 size_bytes = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

The sizeBytes to set.

Returns
Type Description
Backup.Stats.Builder

This builder for chaining.