Send feedback
Class BatchProcessMetadata (2.18.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.18.0keyboard_arrow_down
public final class BatchProcessMetadata extends GeneratedMessageV3 implements BatchProcessMetadataOrBuilder
The long running operation metadata for batch process method.
Protobuf type google.cloud.documentai.v1.BatchProcessMetadata
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static BatchProcessMetadata getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static BatchProcessMetadata . Builder newBuilder ()
public static BatchProcessMetadata . Builder newBuilder ( BatchProcessMetadata prototype )
public static BatchProcessMetadata parseDelimitedFrom ( InputStream input )
public static BatchProcessMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static BatchProcessMetadata parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static BatchProcessMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static BatchProcessMetadata parseFrom ( ByteString data )
public static BatchProcessMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static BatchProcessMetadata parseFrom ( CodedInputStream input )
public static BatchProcessMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static BatchProcessMetadata parseFrom ( InputStream input )
public static BatchProcessMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static BatchProcessMetadata parseFrom ( ByteBuffer data )
public static BatchProcessMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<BatchProcessMetadata> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public Timestamp getCreateTime ()
The creation time of the operation.
.google.protobuf.Timestamp create_time = 3;
Returns
Type Description
Timestamp The createTime.
public TimestampOrBuilder getCreateTimeOrBuilder ()
The creation time of the operation.
.google.protobuf.Timestamp create_time = 3;
public BatchProcessMetadata getDefaultInstanceForType ()
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
indexint
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
public List<BatchProcessMetadata . IndividualProcessStatus > getIndividualProcessStatusesList ()
The list of response details of each document.
repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;
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
indexint
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 >
public Parser<BatchProcessMetadata> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public BatchProcessMetadata . State getState ()
The state of the current batch processing.
.google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;
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.
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.
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.
public final UnknownFieldSet getUnknownFields ()
Overrides
public Timestamp getUpdateTime ()
The last update time of the operation.
.google.protobuf.Timestamp update_time = 4;
Returns
Type Description
Timestamp The updateTime.
public TimestampOrBuilder getUpdateTimeOrBuilder ()
The last update time of the operation.
.google.protobuf.Timestamp update_time = 4;
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.
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.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public BatchProcessMetadata . Builder newBuilderForType ()
protected BatchProcessMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public BatchProcessMetadata . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-16 UTC."],[],[]]
