Class OperationProgress (6.56.0)

public final class OperationProgress extends GeneratedMessageV3 implements OperationProgressOrBuilder

Encapsulates progress related information for a Cloud Spanner long running operation.

Protobuf type google.spanner.admin.database.v1.OperationProgress

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_PERCENT_FIELD_NUMBER

public static final int PROGRESS_PERCENT_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OperationProgress getDefaultInstance()
Returns
TypeDescription
OperationProgress

getDescriptor()

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

newBuilder()

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

newBuilder(OperationProgress prototype)

public static OperationProgress.Builder newBuilder(OperationProgress prototype)
Parameter
NameDescription
prototypeOperationProgress
Returns
TypeDescription
OperationProgress.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public OperationProgress getDefaultInstanceForType()
Returns
TypeDescription
OperationProgress

getEndTime()

public Timestamp getEndTime()

If set, the time at which this operation failed or was completed successfully.

.google.protobuf.Timestamp end_time = 3;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

If set, the time at which this operation failed or was completed successfully.

.google.protobuf.Timestamp end_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getParserForType()

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

getProgressPercent()

public int getProgressPercent()

Percent completion of the operation. Values are between 0 and 100 inclusive.

int32 progress_percent = 1;

Returns
TypeDescription
int

The progressPercent.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

Time the request was received.

.google.protobuf.Timestamp start_time = 2;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Time the request was received.

.google.protobuf.Timestamp start_time = 2;

Returns
TypeDescription
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

If set, the time at which this operation failed or was completed successfully.

.google.protobuf.Timestamp end_time = 3;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Time the request was received.

.google.protobuf.Timestamp start_time = 2;

Returns
TypeDescription
boolean

Whether the startTime field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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