Class protos.google.cloud.documentai.v1.Document.Entity.NormalizedValue (3.0.2)

Represents a NormalizedValue.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Document.Entity.INormalizedValue);

Constructs a new NormalizedValue.

Parameter

Name	Description
properties	`INormalizedValue` Properties to set

Properties

addressValue

public addressValue?: (google.type.IPostalAddress|null);

NormalizedValue addressValue.

Property Value

Type	Description
(google.type.IPostalAddress\|null)

booleanValue

public booleanValue?: (boolean|null);

NormalizedValue booleanValue.

Property Value

Type	Description
(boolean\|null)

datetimeValue

public datetimeValue?: (google.type.IDateTime|null);

NormalizedValue datetimeValue.

Property Value

Type	Description
(google.type.IDateTime\|null)

dateValue

public dateValue?: (google.type.IDate|null);

NormalizedValue dateValue.

Property Value

Type	Description
(google.type.IDate\|null)

moneyValue

public moneyValue?: (google.type.IMoney|null);

NormalizedValue moneyValue.

Property Value

Type	Description
(google.type.IMoney\|null)

structuredValue

public structuredValue?: ("moneyValue"|"dateValue"|"datetimeValue"|"addressValue"|"booleanValue");

NormalizedValue structuredValue.

Property Value

Type	Description
("moneyValue"\|"dateValue"\|"datetimeValue"\|"addressValue"\|"booleanValue")

text

public text: string;

NormalizedValue text.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Document.Entity.INormalizedValue): google.cloud.documentai.v1.Document.Entity.NormalizedValue;

Creates a new NormalizedValue instance using the specified properties.

Parameter

Name	Description
properties	`INormalizedValue` Properties to set

Returns

Type	Description
google.cloud.documentai.v1.Document.Entity.NormalizedValue	NormalizedValue instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1.Document.Entity.NormalizedValue;

Decodes a NormalizedValue message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.documentai.v1.Document.Entity.NormalizedValue	NormalizedValue

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1.Document.Entity.NormalizedValue;

Decodes a NormalizedValue message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.documentai.v1.Document.Entity.NormalizedValue	NormalizedValue

encode(message, writer)

public static encode(message: google.cloud.documentai.v1.Document.Entity.INormalizedValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified NormalizedValue message. Does not implicitly messages.

Parameters

Name	Description
message	`INormalizedValue` NormalizedValue message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.documentai.v1.Document.Entity.INormalizedValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified NormalizedValue message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`INormalizedValue` NormalizedValue message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1.Document.Entity.NormalizedValue;

Creates a NormalizedValue message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.documentai.v1.Document.Entity.NormalizedValue	NormalizedValue

toJSON()

public toJSON(): { [k: string]: any };

Converts this NormalizedValue to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1.Document.Entity.NormalizedValue, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a NormalizedValue message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.documentai.v1.Document.Entity.NormalizedValue` NormalizedValue
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a NormalizedValue message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not