Class protos.google.cloud.documentai.v1.Document.Page.FormField

Represents a FormField.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Document.Page.IFormField);

Constructs a new FormField.

Parameter
NameDescription
properties IFormField

Properties to set

Properties

fieldName

public fieldName?: (google.cloud.documentai.v1.Document.Page.ILayout|null);

FormField fieldName.

fieldValue

public fieldValue?: (google.cloud.documentai.v1.Document.Page.ILayout|null);

FormField fieldValue.

nameDetectedLanguages

public nameDetectedLanguages: google.cloud.documentai.v1.Document.Page.IDetectedLanguage[];

FormField nameDetectedLanguages.

provenance

public provenance?: (google.cloud.documentai.v1.Document.IProvenance|null);

FormField provenance.

valueDetectedLanguages

public valueDetectedLanguages: google.cloud.documentai.v1.Document.Page.IDetectedLanguage[];

FormField valueDetectedLanguages.

valueType

public valueType: string;

FormField valueType.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Document.Page.IFormField): google.cloud.documentai.v1.Document.Page.FormField;

Creates a new FormField instance using the specified properties.

Parameter
NameDescription
properties IFormField

Properties to set

Returns
TypeDescription
google.cloud.documentai.v1.Document.Page.FormField

FormField instance

decode(reader, length)

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

Decodes a FormField message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.documentai.v1.Document.Page.FormField

FormField

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.documentai.v1.Document.Page.FormField

FormField

encode(message, writer)

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

Encodes the specified FormField message. Does not implicitly messages.

Parameters
NameDescription
message IFormField

FormField message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IFormField

FormField message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.documentai.v1.Document.Page.FormField

FormField

toJSON()

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

Converts this FormField to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1.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
NameDescription
message google.cloud.documentai.v1.Document.Page.FormField

FormField

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a FormField message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not