Package com.google.cloud.documentai.v1

Class BatchProcessMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.BatchProcessMetadata

All Implemented Interfaces:

BatchProcessMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BatchProcessMetadata
extends com.google.protobuf.GeneratedMessageV3
implements BatchProcessMetadataOrBuilder

 The long-running operation metadata for
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
 

Protobuf type google.cloud.documentai.v1.BatchProcessMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatchProcessMetadata.Builder	The long-running operation metadata for [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
static class	BatchProcessMetadata.IndividualProcessStatus	The status of a each individual document in the batch process.
static interface	BatchProcessMetadata.IndividualProcessStatusOrBuilder
static class	BatchProcessMetadata.State	Possible states of the batch processing operation.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	CREATE_TIME_FIELD_NUMBER
static int	INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	STATE_MESSAGE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime()	The creation time of the operation.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder()	The creation time of the operation.
static BatchProcessMetadata	getDefaultInstance()
BatchProcessMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
BatchProcessMetadata.IndividualProcessStatus	getIndividualProcessStatuses(int index)	The list of response details of each document.
int	getIndividualProcessStatusesCount()	The list of response details of each document.
List<BatchProcessMetadata.IndividualProcessStatus>	getIndividualProcessStatusesList()	The list of response details of each document.
BatchProcessMetadata.IndividualProcessStatusOrBuilder	getIndividualProcessStatusesOrBuilder(int index)	The list of response details of each document.
List<? extends BatchProcessMetadata.IndividualProcessStatusOrBuilder>	getIndividualProcessStatusesOrBuilderList()	The list of response details of each document.
com.google.protobuf.Parser<BatchProcessMetadata>	getParserForType()
int	getSerializedSize()
BatchProcessMetadata.State	getState()	The state of the current batch processing.
String	getStateMessage()	A message providing more details about the current state of processing.
com.google.protobuf.ByteString	getStateMessageBytes()	A message providing more details about the current state of processing.
int	getStateValue()	The state of the current batch processing.
com.google.protobuf.Timestamp	getUpdateTime()	The last update time of the operation.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder()	The last update time of the operation.
boolean	hasCreateTime()	The creation time of the operation.
int	hashCode()
boolean	hasUpdateTime()	The last update time of the operation.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BatchProcessMetadata.Builder	newBuilder()
static BatchProcessMetadata.Builder	newBuilder(BatchProcessMetadata prototype)
BatchProcessMetadata.Builder	newBuilderForType()
protected BatchProcessMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchProcessMetadata	parseDelimitedFrom(InputStream input)
static BatchProcessMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessMetadata	parseFrom(byte[] data)
static BatchProcessMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessMetadata	parseFrom(com.google.protobuf.ByteString data)
static BatchProcessMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static BatchProcessMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessMetadata	parseFrom(InputStream input)
static BatchProcessMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchProcessMetadata	parseFrom(ByteBuffer data)
static BatchProcessMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchProcessMetadata>	parser()
BatchProcessMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER

public static final int INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getStateValue

public int getStateValue()

 The state of the current batch processing.
 

.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Specified by:

getStateValue in interface BatchProcessMetadataOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public BatchProcessMetadata.State getState()

 The state of the current batch processing.
 

.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Specified by:

getState in interface BatchProcessMetadataOrBuilder

Returns:

The state.

getStateMessage

public String getStateMessage()

 A message providing more details about the current state of processing.
 For example, the error message if the operation is failed.
 

string state_message = 2;

Specified by:

getStateMessage in interface BatchProcessMetadataOrBuilder

Returns:

The stateMessage.

getStateMessageBytes

public com.google.protobuf.ByteString getStateMessageBytes()

 A message providing more details about the current state of processing.
 For example, the error message if the operation is failed.
 

string state_message = 2;

Specified by:

getStateMessageBytes in interface BatchProcessMetadataOrBuilder

Returns:

The bytes for stateMessage.

hasCreateTime

public boolean hasCreateTime()

 The creation time of the operation.
 

.google.protobuf.Timestamp create_time = 3;

Specified by:

hasCreateTime in interface BatchProcessMetadataOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The creation time of the operation.
 

.google.protobuf.Timestamp create_time = 3;

Specified by:

getCreateTime in interface BatchProcessMetadataOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The creation time of the operation.
 

.google.protobuf.Timestamp create_time = 3;

Specified by:

getCreateTimeOrBuilder in interface BatchProcessMetadataOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 The last update time of the operation.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

hasUpdateTime in interface BatchProcessMetadataOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 The last update time of the operation.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTime in interface BatchProcessMetadataOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 The last update time of the operation.
 

.google.protobuf.Timestamp update_time = 4;

Specified by:

getUpdateTimeOrBuilder in interface BatchProcessMetadataOrBuilder

getIndividualProcessStatusesList

public List<BatchProcessMetadata.IndividualProcessStatus> getIndividualProcessStatusesList()

 The list of response details of each document.
 

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Specified by:

getIndividualProcessStatusesList in interface BatchProcessMetadataOrBuilder

getIndividualProcessStatusesOrBuilderList

public List<? extends BatchProcessMetadata.IndividualProcessStatusOrBuilder> getIndividualProcessStatusesOrBuilderList()

 The list of response details of each document.
 

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Specified by:

getIndividualProcessStatusesOrBuilderList in interface BatchProcessMetadataOrBuilder

getIndividualProcessStatusesCount

public int getIndividualProcessStatusesCount()

 The list of response details of each document.
 

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Specified by:

getIndividualProcessStatusesCount in interface BatchProcessMetadataOrBuilder

getIndividualProcessStatuses

public BatchProcessMetadata.IndividualProcessStatus getIndividualProcessStatuses(int index)

 The list of response details of each document.
 

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Specified by:

getIndividualProcessStatuses in interface BatchProcessMetadataOrBuilder

getIndividualProcessStatusesOrBuilder

public BatchProcessMetadata.IndividualProcessStatusOrBuilder getIndividualProcessStatusesOrBuilder(int index)

 The list of response details of each document.
 

repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Specified by:

getIndividualProcessStatusesOrBuilder in interface BatchProcessMetadataOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BatchProcessMetadata parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessMetadata parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessMetadata parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessMetadata parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessMetadata parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessMetadata parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchProcessMetadata parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static BatchProcessMetadata parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchProcessMetadata parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchProcessMetadata parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static BatchProcessMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static BatchProcessMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public BatchProcessMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BatchProcessMetadata.Builder newBuilder()

newBuilder

public static BatchProcessMetadata.Builder newBuilder(BatchProcessMetadata prototype)

toBuilder

public BatchProcessMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BatchProcessMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BatchProcessMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<BatchProcessMetadata> parser()

getParserForType

public com.google.protobuf.Parser<BatchProcessMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BatchProcessMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder