Package com.google.cloud.documentai.v1

Class BatchProcessMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class BatchProcessMetadata extends com.google.protobuf.GeneratedMessage implements BatchProcessMetadataOrBuilder
 The long-running operation metadata for
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
Protobuf type google.cloud.documentai.v1.BatchProcessMetadata
See Also:

  • Field Details

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • STATE_MESSAGE_FIELD_NUMBER

      public static final int STATE_MESSAGE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER

      public static final int INDIVIDUAL_PROCESS_STATUSES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public BatchProcessMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder