Represents a NormalizedValue.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1beta3.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.
booleanValue
public booleanValue?: (boolean|null);
NormalizedValue booleanValue.
datetimeValue
public datetimeValue?: (google.type.IDateTime|null);
NormalizedValue datetimeValue.
dateValue
public dateValue?: (google.type.IDate|null);
NormalizedValue dateValue.
floatValue
public floatValue?: (number|null);
NormalizedValue floatValue.
integerValue
public integerValue?: (number|null);
NormalizedValue integerValue.
moneyValue
public moneyValue?: (google.type.IMoney|null);
NormalizedValue moneyValue.
structuredValue
public structuredValue?: ("moneyValue"|"dateValue"|"datetimeValue"|"addressValue"|"booleanValue"|"integerValue"|"floatValue");
NormalizedValue structuredValue.
text
public text: string;
NormalizedValue text.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1beta3.Document.Entity.INormalizedValue): google.cloud.documentai.v1beta3.Document.Entity.NormalizedValue;
Creates a new NormalizedValue instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
INormalizedValue
Properties to set |
Returns | |
---|---|
Type | Description |
NormalizedValue |
NormalizedValue instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.Document.Entity.NormalizedValue;
Decodes a NormalizedValue message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
NormalizedValue |
NormalizedValue |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.Document.Entity.NormalizedValue;
Decodes a NormalizedValue message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
NormalizedValue |
NormalizedValue |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.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 |
NormalizedValue |
NormalizedValue |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for NormalizedValue
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
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.v1beta3.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 |
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) |
|