Class BatchProcessMetadata (2.24.0)

public final class BatchProcessMetadata extends GeneratedMessageV3 implements BatchProcessMetadataOrBuilder

The long-running operation metadata for BatchProcessDocuments.

Protobuf type google.cloud.documentai.v1.BatchProcessMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER

public static final int INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchProcessMetadata getDefaultInstance()
Returns
TypeDescription
BatchProcessMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BatchProcessMetadata prototype)

public static BatchProcessMetadata.Builder newBuilder(BatchProcessMetadata prototype)
Parameter
NameDescription
prototypeBatchProcessMetadata
Returns
TypeDescription
BatchProcessMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public BatchProcessMetadata getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatusOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public BatchProcessMetadata.State getState()

The state of the current batch processing.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the operation.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The creation time of the operation.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
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
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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