Class BatchOperationMetadata (3.28.0)

public final class BatchOperationMetadata extends GeneratedMessageV3 implements BatchOperationMetadataOrBuilder

Metadata for the batch operations such as the current state.

This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.vision.v1.BatchOperationMetadata

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

SUBMIT_TIME_FIELD_NUMBER

public static final int SUBMIT_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchOperationMetadata getDefaultInstance()
Returns
TypeDescription
BatchOperationMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BatchOperationMetadata prototype)

public static BatchOperationMetadata.Builder newBuilder(BatchOperationMetadata prototype)
Parameter
NameDescription
prototypeBatchOperationMetadata
Returns
TypeDescription
BatchOperationMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchOperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
BatchOperationMetadata

getEndTime()

public Timestamp getEndTime()

The time when the batch request is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 3;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time when the batch request is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public BatchOperationMetadata.State getState()

The current state of the batch operation.

.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;

Returns
TypeDescription
BatchOperationMetadata.State

The state.

getStateValue()

public int getStateValue()

The current state of the batch operation.

.google.cloud.vision.v1.BatchOperationMetadata.State state = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getSubmitTime()

public Timestamp getSubmitTime()

The time when the batch request was submitted to the server.

.google.protobuf.Timestamp submit_time = 2;

Returns
TypeDescription
Timestamp

The submitTime.

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

The time when the batch request was submitted to the server.

.google.protobuf.Timestamp submit_time = 2;

Returns
TypeDescription
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

The time when the batch request is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 3;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasSubmitTime()

public boolean hasSubmitTime()

The time when the batch request was submitted to the server.

.google.protobuf.Timestamp submit_time = 2;

Returns
TypeDescription
boolean

Whether the submitTime 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 BatchOperationMetadata.Builder newBuilderForType()
Returns
TypeDescription
BatchOperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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