Package com.google.cloud.documentai.v1

Class Document.Entity.NormalizedValue

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.Document.Entity.NormalizedValue
All Implemented Interfaces:
Document.Entity.NormalizedValueOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Document.Entity
public static final class Document.Entity.NormalizedValue extends com.google.protobuf.GeneratedMessage implements Document.Entity.NormalizedValueOrBuilder
 Parsed and normalized entity value.
Protobuf type google.cloud.documentai.v1.Document.Entity.NormalizedValue
See Also:

  • Field Details

    • MONEY_VALUE_FIELD_NUMBER

      public static final int MONEY_VALUE_FIELD_NUMBER
      See Also:

    • DATE_VALUE_FIELD_NUMBER

      public static final int DATE_VALUE_FIELD_NUMBER
      See Also:

    • DATETIME_VALUE_FIELD_NUMBER

      public static final int DATETIME_VALUE_FIELD_NUMBER
      See Also:

    • ADDRESS_VALUE_FIELD_NUMBER

      public static final int ADDRESS_VALUE_FIELD_NUMBER
      See Also:

    • BOOLEAN_VALUE_FIELD_NUMBER

      public static final int BOOLEAN_VALUE_FIELD_NUMBER
      See Also:

    • INTEGER_VALUE_FIELD_NUMBER

      public static final int INTEGER_VALUE_FIELD_NUMBER
      See Also:

    • FLOAT_VALUE_FIELD_NUMBER

      public static final int FLOAT_VALUE_FIELD_NUMBER
      See Also:

    • SIGNATURE_VALUE_FIELD_NUMBER

      public static final int SIGNATURE_VALUE_FIELD_NUMBER
      See Also:

    • TEXT_FIELD_NUMBER

      public static final int TEXT_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

    • getStructuredValueCase

      public Document.Entity.NormalizedValue.StructuredValueCase getStructuredValueCase()
      Specified by:
      getStructuredValueCase in interface Document.Entity.NormalizedValueOrBuilder

    • hasMoneyValue

      public boolean hasMoneyValue()
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;
      Specified by:
      hasMoneyValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the moneyValue field is set.

    • getMoneyValue

      public Money getMoneyValue()
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;
      Specified by:
      getMoneyValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The moneyValue.

    • getMoneyValueOrBuilder

      public MoneyOrBuilder getMoneyValueOrBuilder()
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;
      Specified by:
      getMoneyValueOrBuilder in interface Document.Entity.NormalizedValueOrBuilder

    • hasDateValue

      public boolean hasDateValue()
       Date value. Includes year, month, day. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
      .google.type.Date date_value = 3;
      Specified by:
      hasDateValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the dateValue field is set.

    • getDateValue

      public Date getDateValue()
       Date value. Includes year, month, day. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
      .google.type.Date date_value = 3;
      Specified by:
      getDateValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The dateValue.

    • getDateValueOrBuilder

      public DateOrBuilder getDateValueOrBuilder()
       Date value. Includes year, month, day. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
      .google.type.Date date_value = 3;
      Specified by:
      getDateValueOrBuilder in interface Document.Entity.NormalizedValueOrBuilder

    • hasDatetimeValue

      public boolean hasDatetimeValue()
       DateTime value. Includes date, time, and timezone. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
      .google.type.DateTime datetime_value = 4;
      Specified by:
      hasDatetimeValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the datetimeValue field is set.

    • getDatetimeValue

      public DateTime getDatetimeValue()
       DateTime value. Includes date, time, and timezone. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
      .google.type.DateTime datetime_value = 4;
      Specified by:
      getDatetimeValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The datetimeValue.

    • getDatetimeValueOrBuilder

      public DateTimeOrBuilder getDatetimeValueOrBuilder()
       DateTime value. Includes date, time, and timezone. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
      .google.type.DateTime datetime_value = 4;
      Specified by:
      getDatetimeValueOrBuilder in interface Document.Entity.NormalizedValueOrBuilder

    • hasAddressValue

      public boolean hasAddressValue()
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;
      Specified by:
      hasAddressValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the addressValue field is set.

    • getAddressValue

      public PostalAddress getAddressValue()
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;
      Specified by:
      getAddressValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The addressValue.

    • getAddressValueOrBuilder

      public PostalAddressOrBuilder getAddressValueOrBuilder()
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;
      Specified by:
      getAddressValueOrBuilder in interface Document.Entity.NormalizedValueOrBuilder

    • hasBooleanValue

      public boolean hasBooleanValue()
       Boolean value. Can be used for entities with binary values, or for
 checkboxes.
      bool boolean_value = 6;
      Specified by:
      hasBooleanValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the booleanValue field is set.

    • getBooleanValue

      public boolean getBooleanValue()
       Boolean value. Can be used for entities with binary values, or for
 checkboxes.
      bool boolean_value = 6;
      Specified by:
      getBooleanValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The booleanValue.

    • hasIntegerValue

      public boolean hasIntegerValue()
       Integer value.
      int32 integer_value = 7;
      Specified by:
      hasIntegerValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the integerValue field is set.

    • getIntegerValue

      public int getIntegerValue()
       Integer value.
      int32 integer_value = 7;
      Specified by:
      getIntegerValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The integerValue.

    • hasFloatValue

      public boolean hasFloatValue()
       Float value.
      float float_value = 8;
      Specified by:
      hasFloatValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the floatValue field is set.

    • getFloatValue

      public float getFloatValue()
       Float value.
      float float_value = 8;
      Specified by:
      getFloatValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The floatValue.

    • hasSignatureValue

      public boolean hasSignatureValue()
       A signature - a graphical representation of a person's name,
 often used to sign a document.
      bool signature_value = 10;
      Specified by:
      hasSignatureValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      Whether the signatureValue field is set.

    • getSignatureValue

      public boolean getSignatureValue()
       A signature - a graphical representation of a person's name,
 often used to sign a document.
      bool signature_value = 10;
      Specified by:
      getSignatureValue in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The signatureValue.

    • getText

      public String getText()
       Optional. An optional field to store a normalized string.
 For some entity types, one of respective `structured_value` fields may
 also be populated. Also not all the types of `structured_value` will be
 normalized. For example, some processors may not generate `float`
 or `integer` normalized text by default.

 Below are sample formats mapped to structured values.

 - Money/Currency type (`money_value`) is in the ISO 4217 text format.
 - Date type (`date_value`) is in the ISO 8601 text format.
 - Datetime type (`datetime_value`) is in the ISO 8601 text format.
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getText in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       Optional. An optional field to store a normalized string.
 For some entity types, one of respective `structured_value` fields may
 also be populated. Also not all the types of `structured_value` will be
 normalized. For example, some processors may not generate `float`
 or `integer` normalized text by default.

 Below are sample formats mapped to structured values.

 - Money/Currency type (`money_value`) is in the ISO 4217 text format.
 - Date type (`date_value`) is in the ISO 8601 text format.
 - Datetime type (`datetime_value`) is in the ISO 8601 text format.
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTextBytes in interface Document.Entity.NormalizedValueOrBuilder
      Returns:
      The bytes for text.

    • 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 Document.Entity.NormalizedValue parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document.Entity.NormalizedValue parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document.Entity.NormalizedValue parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.Entity.NormalizedValue parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Document.Entity.NormalizedValue.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Document.Entity.NormalizedValue.Builder newBuilder()

    • newBuilder

      public static Document.Entity.NormalizedValue.Builder newBuilder(Document.Entity.NormalizedValue prototype)

    • toBuilder

      public Document.Entity.NormalizedValue.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Document.Entity.NormalizedValue.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Document.Entity.NormalizedValue getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Document.Entity.NormalizedValue> parser()

    • getParserForType

      public com.google.protobuf.Parser<Document.Entity.NormalizedValue> 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 Document.Entity.NormalizedValue getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder