Class BatchProcessMetadata (2.24.0)

Version 2.24.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public final class BatchProcessMetadata extends GeneratedMessageV3 implements BatchProcessMetadataOrBuilder

The long-running operation metadata for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1.BatchProcessMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchProcessMetadata

Implements

BatchProcessMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER

public static final int INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static BatchProcessMetadata getDefaultInstance()

Returns
Type	Description
BatchProcessMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BatchProcessMetadata.Builder newBuilder()

Returns
Type	Description
BatchProcessMetadata.Builder

newBuilder(BatchProcessMetadata prototype)

public static BatchProcessMetadata.Builder newBuilder(BatchProcessMetadata prototype)

Parameter
Name	Description
prototype	BatchProcessMetadata

Returns
Type	Description
BatchProcessMetadata.Builder

parseDelimitedFrom(InputStream input)

public static BatchProcessMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BatchProcessMetadata parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchProcessMetadata parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchProcessMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BatchProcessMetadata parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchProcessMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BatchProcessMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchProcessMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchProcessMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BatchProcessMetadata> parser()

Returns
Type	Description
Parser<BatchProcessMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCreateTime()

public Timestamp getCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public BatchProcessMetadata getDefaultInstanceForType()

Returns
Type	Description
BatchProcessMetadata

getIndividualProcessStatuses(int index)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
BatchProcessMetadata.IndividualProcessStatus

getIndividualProcessStatusesCount()

public int getIndividualProcessStatusesCount()

The list of response details of each document.

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

Returns
Type	Description
int

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;

Returns
Type	Description
List<IndividualProcessStatus>

getIndividualProcessStatusesOrBuilder(int index)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
BatchProcessMetadata.IndividualProcessStatusOrBuilder

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;

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatusOrBuilder>

getParserForType()

public Parser<BatchProcessMetadata> getParserForType()

Returns
Type	Description
Parser<BatchProcessMetadata>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public BatchProcessMetadata.State getState()

The state of the current batch processing.

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

Returns
Type	Description
BatchProcessMetadata.State	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;

Returns
Type	Description
String	The stateMessage.

getStateMessageBytes()

public 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;

Returns
Type	Description
ByteString	The bytes for stateMessage.

getStateValue()

public int getStateValue()

The state of the current batch processing.

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

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BatchProcessMetadata.Builder newBuilderForType()

Returns
Type	Description
BatchProcessMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchProcessMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BatchProcessMetadata.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BatchProcessMetadata.Builder toBuilder()

Returns
Type	Description
BatchProcessMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException