Represents a FormField.
Package
@google-cloud/documentaiConstructors
(constructor)(properties)
constructor(properties?: google.cloud.documentai.v1beta3.Document.Page.IFormField);Constructs a new FormField.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFormField
Properties to set |
Properties
correctedKeyText
public correctedKeyText: string;FormField correctedKeyText.
correctedValueText
public correctedValueText: string;FormField correctedValueText.
fieldName
public fieldName?: (google.cloud.documentai.v1beta3.Document.Page.ILayout|null);FormField fieldName.
fieldValue
public fieldValue?: (google.cloud.documentai.v1beta3.Document.Page.ILayout|null);FormField fieldValue.
nameDetectedLanguages
public nameDetectedLanguages: google.cloud.documentai.v1beta3.Document.Page.IDetectedLanguage[];FormField nameDetectedLanguages.
provenance
public provenance?: (google.cloud.documentai.v1beta3.Document.IProvenance|null);FormField provenance.
valueDetectedLanguages
public valueDetectedLanguages: google.cloud.documentai.v1beta3.Document.Page.IDetectedLanguage[];FormField valueDetectedLanguages.
valueType
public valueType: string;FormField valueType.
Methods
create(properties)
public static create(properties?: google.cloud.documentai.v1beta3.Document.Page.IFormField): google.cloud.documentai.v1beta3.Document.Page.FormField;Creates a new FormField instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFormField
Properties to set |
| Returns | |
|---|---|
| Type | Description |
FormField | FormField instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.Document.Page.FormField;Decodes a FormField 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 |
FormField | FormField |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.Document.Page.FormField;Decodes a FormField message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FormField | FormField |
encode(message, writer)
public static encode(message: google.cloud.documentai.v1beta3.Document.Page.IFormField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FormField message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFormField
FormField 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.Page.IFormField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FormField message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFormField
FormField 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.Page.FormField;Creates a FormField 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 |
FormField | FormField |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for FormField
| 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 FormField to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.documentai.v1beta3.Document.Page.FormField, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a FormField message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
FormField
FormField |
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 FormField message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|