Class Progress (3.2.0)

public final class Progress extends GeneratedMessageV3 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 Fields

COMPLETED_WORK_FIELD_NUMBER

public static final int COMPLETED_WORK_FIELD_NUMBER
Field Value
TypeDescription
int

ESTIMATED_WORK_FIELD_NUMBER

public static final int ESTIMATED_WORK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Progress getDefaultInstance()
Returns
TypeDescription
Progress

getDescriptor()

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

newBuilder()

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

newBuilder(Progress prototype)

public static Progress.Builder newBuilder(Progress prototype)
Parameter
NameDescription
prototypeProgress
Returns
TypeDescription
Progress.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCompletedWork()

public long getCompletedWork()

The amount of work completed.

int64 completed_work = 2;

Returns
TypeDescription
long

The completedWork.

getDefaultInstanceForType()

public Progress getDefaultInstanceForType()
Returns
TypeDescription
Progress

getEstimatedWork()

public long getEstimatedWork()

The amount of work estimated.

int64 estimated_work = 1;

Returns
TypeDescription
long

The estimatedWork.

getParserForType()

public Parser<Progress> getParserForType()
Returns
TypeDescription
Parser<Progress>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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 Progress.Builder newBuilderForType()
Returns
TypeDescription
Progress.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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