Package com.google.cloud.documentai.v1

Interface CommonOperationMetadataOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CommonOperationMetadata, CommonOperationMetadata.Builder
    public interface CommonOperationMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Timestamp getCreateTime()
      The creation time of the operation.
      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      The creation time of the operation.
      String getResource()
      A related resource to this operation.
      com.google.protobuf.ByteString getResourceBytes()
      A related resource to this operation.
      CommonOperationMetadata.State getState()
      The state of the operation.
      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 operation.
      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.
      boolean hasUpdateTime()
      The last update time of the operation.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getStateValue

        int getStateValue()
         The state of the operation.
        .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        CommonOperationMetadata.State getState()
         The state of the operation.
        .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
        Returns:
        The state.

      • getStateMessage

        String getStateMessage()
         A message providing more details about the current state of processing.
        string state_message = 2;
        Returns:
        The stateMessage.

      • getStateMessageBytes

        com.google.protobuf.ByteString getStateMessageBytes()
         A message providing more details about the current state of processing.
        string state_message = 2;
        Returns:
        The bytes for stateMessage.

      • getResource

        String getResource()
         A related resource to this operation.
        string resource = 5;
        Returns:
        The resource.

      • getResourceBytes

        com.google.protobuf.ByteString getResourceBytes()
         A related resource to this operation.
        string resource = 5;
        Returns:
        The bytes for resource.

      • hasCreateTime

        boolean hasCreateTime()
         The creation time of the operation.
        .google.protobuf.Timestamp create_time = 3;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         The creation time of the operation.
        .google.protobuf.Timestamp create_time = 3;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The creation time of the operation.
        .google.protobuf.Timestamp create_time = 3;

      • hasUpdateTime

        boolean hasUpdateTime()
         The last update time of the operation.
        .google.protobuf.Timestamp update_time = 4;
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         The last update time of the operation.
        .google.protobuf.Timestamp update_time = 4;
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         The last update time of the operation.
        .google.protobuf.Timestamp update_time = 4;