Class Progress.Builder (3.21.0)

public static final class Progress.Builder extends GeneratedMessageV3.Builder<Progress.Builder> implements ProgressOrBuilder

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.

Protobuf type google.firestore.admin.v1.Progress

Implements

ProgressOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Progress build()
Returns
Type Description
Progress

buildPartial()

public Progress buildPartial()
Returns
Type Description
Progress

clear()

public Progress.Builder clear()
Returns
Type Description
Progress.Builder
Overrides

clearCompletedWork()

public Progress.Builder clearCompletedWork()

The amount of work completed.

int64 completed_work = 2;

Returns
Type Description
Progress.Builder

This builder for chaining.

clearEstimatedWork()

public Progress.Builder clearEstimatedWork()

The amount of work estimated.

int64 estimated_work = 1;

Returns
Type Description
Progress.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public Progress.Builder clone()
Returns
Type Description
Progress.Builder
Overrides

getCompletedWork()

public long getCompletedWork()

The amount of work completed.

int64 completed_work = 2;

Returns
Type Description
long

The completedWork.

getDefaultInstanceForType()

public Progress getDefaultInstanceForType()
Returns
Type Description
Progress

getDescriptorForType()

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

getEstimatedWork()

public long getEstimatedWork()

The amount of work estimated.

int64 estimated_work = 1;

Returns
Type Description
long

The estimatedWork.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Progress other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCompletedWork(long value)

public Progress.Builder setCompletedWork(long value)

The amount of work completed.

int64 completed_work = 2;

Parameter
Name Description
value long

The completedWork to set.

Returns
Type Description
Progress.Builder

This builder for chaining.

setEstimatedWork(long value)

public Progress.Builder setEstimatedWork(long value)

The amount of work estimated.

int64 estimated_work = 1;

Parameter
Name Description
value long

The estimatedWork to set.

Returns
Type Description
Progress.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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