Class Document.Entity.NormalizedValue.Builder (2.34.0)

public static final class Document.Entity.NormalizedValue.Builder extends GeneratedMessageV3.Builder<Document.Entity.NormalizedValue.Builder> implements Document.Entity.NormalizedValueOrBuilder

Parsed and normalized entity value.

Protobuf type google.cloud.documentai.v1beta2.Document.Entity.NormalizedValue

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Entity.NormalizedValue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

build()

public Document.Entity.NormalizedValue build()
Returns
TypeDescription
Document.Entity.NormalizedValue

buildPartial()

public Document.Entity.NormalizedValue buildPartial()
Returns
TypeDescription
Document.Entity.NormalizedValue

clear()

public Document.Entity.NormalizedValue.Builder clear()
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

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;

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

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

This builder for chaining.

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;

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

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;

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Entity.NormalizedValue.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

clearFloatValue()

public Document.Entity.NormalizedValue.Builder clearFloatValue()

Float value.

float float_value = 8;

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

clearIntegerValue()

public Document.Entity.NormalizedValue.Builder clearIntegerValue()

Integer value.

int32 integer_value = 7;

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

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;

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Entity.NormalizedValue.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

clearStructuredValue()

public Document.Entity.NormalizedValue.Builder clearStructuredValue()
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

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

This builder for chaining.

clone()

public Document.Entity.NormalizedValue.Builder clone()
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

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;

Returns
TypeDescription
com.google.type.PostalAddress

The addressValue.

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;

Returns
TypeDescription
com.google.type.PostalAddress.Builder

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;

Returns
TypeDescription
com.google.type.PostalAddressOrBuilder

getBooleanValue()

public boolean getBooleanValue()

Boolean value. Can be used for entities with binary values, or for checkboxes.

bool boolean_value = 6;

Returns
TypeDescription
boolean

The booleanValue.

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;

Returns
TypeDescription
com.google.type.Date

The dateValue.

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;

Returns
TypeDescription
com.google.type.Date.Builder

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;

Returns
TypeDescription
com.google.type.DateOrBuilder

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;

Returns
TypeDescription
com.google.type.DateTime

The datetimeValue.

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;

Returns
TypeDescription
com.google.type.DateTime.Builder

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;

Returns
TypeDescription
com.google.type.DateTimeOrBuilder

getDefaultInstanceForType()

public Document.Entity.NormalizedValue getDefaultInstanceForType()
Returns
TypeDescription
Document.Entity.NormalizedValue

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFloatValue()

public float getFloatValue()

Float value.

float float_value = 8;

Returns
TypeDescription
float

The floatValue.

getIntegerValue()

public int getIntegerValue()

Integer value.

int32 integer_value = 7;

Returns
TypeDescription
int

The integerValue.

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;

Returns
TypeDescription
com.google.type.Money

The moneyValue.

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;

Returns
TypeDescription
com.google.type.Money.Builder

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;

Returns
TypeDescription
com.google.type.MoneyOrBuilder

getStructuredValueCase()

public Document.Entity.NormalizedValue.StructuredValueCase getStructuredValueCase()
Returns
TypeDescription
Document.Entity.NormalizedValue.StructuredValueCase

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];

Returns
TypeDescription
String

The text.

getTextBytes()

public 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];

Returns
TypeDescription
ByteString

The bytes for text.

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;

Returns
TypeDescription
boolean

Whether the addressValue field is set.

hasBooleanValue()

public boolean hasBooleanValue()

Boolean value. Can be used for entities with binary values, or for checkboxes.

bool boolean_value = 6;

Returns
TypeDescription
boolean

Whether the booleanValue field is set.

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;

Returns
TypeDescription
boolean

Whether the dateValue field is set.

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;

Returns
TypeDescription
boolean

Whether the datetimeValue field is set.

hasFloatValue()

public boolean hasFloatValue()

Float value.

float float_value = 8;

Returns
TypeDescription
boolean

Whether the floatValue field is set.

hasIntegerValue()

public boolean hasIntegerValue()

Integer value.

int32 integer_value = 7;

Returns
TypeDescription
boolean

Whether the integerValue field is set.

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;

Returns
TypeDescription
boolean

Whether the moneyValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAddressValue(PostalAddress value)

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;

Parameter
NameDescription
valuecom.google.type.PostalAddress
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

mergeDateValue(Date value)

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;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

mergeDatetimeValue(DateTime value)

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;

Parameter
NameDescription
valuecom.google.type.DateTime
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

mergeFrom(Document.Entity.NormalizedValue other)

public Document.Entity.NormalizedValue.Builder mergeFrom(Document.Entity.NormalizedValue other)
Parameter
NameDescription
otherDocument.Entity.NormalizedValue
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Entity.NormalizedValue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Document.Entity.NormalizedValue.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

mergeMoneyValue(Money value)

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;

Parameter
NameDescription
valuecom.google.type.Money
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Entity.NormalizedValue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

setAddressValue(PostalAddress value)

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;

Parameter
NameDescription
valuecom.google.type.PostalAddress
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setAddressValue(PostalAddress.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuecom.google.type.PostalAddress.Builder
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setBooleanValue(boolean value)

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;

Parameter
NameDescription
valueboolean

The booleanValue to set.

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

setDateValue(Date value)

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;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setDateValue(Date.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuecom.google.type.Date.Builder
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setDatetimeValue(DateTime value)

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;

Parameter
NameDescription
valuecom.google.type.DateTime
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setDatetimeValue(DateTime.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuecom.google.type.DateTime.Builder
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Entity.NormalizedValue.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

setFloatValue(float value)

public Document.Entity.NormalizedValue.Builder setFloatValue(float value)

Float value.

float float_value = 8;

Parameter
NameDescription
valuefloat

The floatValue to set.

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

setIntegerValue(int value)

public Document.Entity.NormalizedValue.Builder setIntegerValue(int value)

Integer value.

int32 integer_value = 7;

Parameter
NameDescription
valueint

The integerValue to set.

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

setMoneyValue(Money value)

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;

Parameter
NameDescription
valuecom.google.type.Money
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setMoneyValue(Money.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuecom.google.type.Money.Builder
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Entity.NormalizedValue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

setText(String value)

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];

Parameter
NameDescription
valueString

The text to set.

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

setTextBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for text to set.

Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Entity.NormalizedValue.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides