Class Document.Entity.NormalizedValue (2.34.0)

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

Parsed and normalized entity value.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.Entity.NormalizedValue

Static Fields

ADDRESS_VALUE_FIELD_NUMBER

public static final int ADDRESS_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

BOOLEAN_VALUE_FIELD_NUMBER

public static final int BOOLEAN_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DATETIME_VALUE_FIELD_NUMBER

public static final int DATETIME_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DATE_VALUE_FIELD_NUMBER

public static final int DATE_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

FLOAT_VALUE_FIELD_NUMBER

public static final int FLOAT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

INTEGER_VALUE_FIELD_NUMBER

public static final int INTEGER_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

MONEY_VALUE_FIELD_NUMBER

public static final int MONEY_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Entity.NormalizedValue getDefaultInstance()
Returns
TypeDescription
Document.Entity.NormalizedValue

getDescriptor()

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

newBuilder()

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

newBuilder(Document.Entity.NormalizedValue prototype)

public static Document.Entity.NormalizedValue.Builder newBuilder(Document.Entity.NormalizedValue prototype)
Parameter
NameDescription
prototypeDocument.Entity.NormalizedValue
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder

parseDelimitedFrom(InputStream input)

public static Document.Entity.NormalizedValue parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity.NormalizedValue parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Entity.NormalizedValue parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity.NormalizedValue parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Entity.NormalizedValue parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity.NormalizedValue parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Entity.NormalizedValue parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Document.Entity.NormalizedValue parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity.NormalizedValue parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Entity.NormalizedValue parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity.NormalizedValue parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity.NormalizedValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Document.Entity.NormalizedValue> parser()
Returns
TypeDescription
Parser<NormalizedValue>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

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.

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.

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

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.

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

getParserForType()

public Parser<Document.Entity.NormalizedValue> getParserForType()
Returns
TypeDescription
Parser<NormalizedValue>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Entity.NormalizedValue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Entity.NormalizedValue.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException