Package com.google.cloud.documentai.v1

Class Document.Entity.NormalizedValue.Builder

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

  • 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.Builder<Document.Entity.NormalizedValue.Builder>

    • clear

      public Document.Entity.NormalizedValue.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Document.Entity.NormalizedValue.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Document.Entity.NormalizedValue.Builder>

    • getDefaultInstanceForType

      public Document.Entity.NormalizedValue getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public Document.Entity.NormalizedValue.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Entity.NormalizedValue.Builder>

    • mergeFrom

      public Document.Entity.NormalizedValue.Builder mergeFrom(Document.Entity.NormalizedValue other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Document.Entity.NormalizedValue.Builder>

    • mergeFrom

      public Document.Entity.NormalizedValue.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Entity.NormalizedValue.Builder>
      Throws:
      IOException

    • getStructuredValueCase

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

    • clearStructuredValue

      public Document.Entity.NormalizedValue.Builder clearStructuredValue()

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

    • setMoneyValue

      public Document.Entity.NormalizedValue.Builder setMoneyValue(Money value)
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;

    • setMoneyValue

      public Document.Entity.NormalizedValue.Builder setMoneyValue(Money.Builder builderForValue)
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;

    • mergeMoneyValue

      public Document.Entity.NormalizedValue.Builder mergeMoneyValue(Money value)
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;

    • clearMoneyValue

      public Document.Entity.NormalizedValue.Builder clearMoneyValue()
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;

    • getMoneyValueBuilder

      public Money.Builder getMoneyValueBuilder()
       Money value. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
      .google.type.Money money_value = 2;

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

    • setDateValue

      public Document.Entity.NormalizedValue.Builder setDateValue(Date value)
       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;

    • setDateValue

      public Document.Entity.NormalizedValue.Builder setDateValue(Date.Builder builderForValue)
       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;

    • mergeDateValue

      public Document.Entity.NormalizedValue.Builder mergeDateValue(Date value)
       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;

    • clearDateValue

      public Document.Entity.NormalizedValue.Builder clearDateValue()
       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;

    • getDateValueBuilder

      public Date.Builder getDateValueBuilder()
       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;

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

    • setDatetimeValue

      public Document.Entity.NormalizedValue.Builder setDatetimeValue(DateTime value)
       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;

    • setDatetimeValue

      public Document.Entity.NormalizedValue.Builder setDatetimeValue(DateTime.Builder builderForValue)
       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;

    • mergeDatetimeValue

      public Document.Entity.NormalizedValue.Builder mergeDatetimeValue(DateTime value)
       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;

    • clearDatetimeValue

      public Document.Entity.NormalizedValue.Builder clearDatetimeValue()
       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;

    • getDatetimeValueBuilder

      public DateTime.Builder getDatetimeValueBuilder()
       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;

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

    • setAddressValue

      public Document.Entity.NormalizedValue.Builder setAddressValue(PostalAddress value)
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;

    • setAddressValue

      public Document.Entity.NormalizedValue.Builder setAddressValue(PostalAddress.Builder builderForValue)
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;

    • mergeAddressValue

      public Document.Entity.NormalizedValue.Builder mergeAddressValue(PostalAddress value)
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;

    • clearAddressValue

      public Document.Entity.NormalizedValue.Builder clearAddressValue()
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;

    • getAddressValueBuilder

      public PostalAddress.Builder getAddressValueBuilder()
       Postal address. See also:
 https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
      .google.type.PostalAddress address_value = 5;

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

    • setBooleanValue

      public Document.Entity.NormalizedValue.Builder setBooleanValue(boolean value)
       Boolean value. Can be used for entities with binary values, or for
 checkboxes.
      bool boolean_value = 6;
      Parameters:
      value - The booleanValue to set.
      Returns:
      This builder for chaining.

    • clearBooleanValue

      public Document.Entity.NormalizedValue.Builder clearBooleanValue()
       Boolean value. Can be used for entities with binary values, or for
 checkboxes.
      bool boolean_value = 6;
      Returns:
      This builder for chaining.

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

    • setIntegerValue

      public Document.Entity.NormalizedValue.Builder setIntegerValue(int value)
       Integer value.
      int32 integer_value = 7;
      Parameters:
      value - The integerValue to set.
      Returns:
      This builder for chaining.

    • clearIntegerValue

      public Document.Entity.NormalizedValue.Builder clearIntegerValue()
       Integer value.
      int32 integer_value = 7;
      Returns:
      This builder for chaining.

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

    • setFloatValue

      public Document.Entity.NormalizedValue.Builder setFloatValue(float value)
       Float value.
      float float_value = 8;
      Parameters:
      value - The floatValue to set.
      Returns:
      This builder for chaining.

    • clearFloatValue

      public Document.Entity.NormalizedValue.Builder clearFloatValue()
       Float value.
      float float_value = 8;
      Returns:
      This builder for chaining.

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

    • setSignatureValue

      public Document.Entity.NormalizedValue.Builder setSignatureValue(boolean value)
       A signature - a graphical representation of a person's name,
 often used to sign a document.
      bool signature_value = 10;
      Parameters:
      value - The signatureValue to set.
      Returns:
      This builder for chaining.

    • clearSignatureValue

      public Document.Entity.NormalizedValue.Builder clearSignatureValue()
       A signature - a graphical representation of a person's name,
 often used to sign a document.
      bool signature_value = 10;
      Returns:
      This builder for chaining.

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

    • setText

      public Document.Entity.NormalizedValue.Builder setText(String value)
       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];
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.

    • clearText

      public Document.Entity.NormalizedValue.Builder clearText()
       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];
      Returns:
      This builder for chaining.

    • setTextBytes

      public Document.Entity.NormalizedValue.Builder setTextBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for text to set.
      Returns:
      This builder for chaining.