Class protos.google.cloud.documentai.v1.Document.PageAnchor.PageRef (3.3.0)

Represents a PageRef.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1.Document.PageAnchor.IPageRef);

Constructs a new PageRef.

Parameter

Name	Description
properties	`IPageRef` Properties to set

Properties

boundingPoly

public boundingPoly?: (google.cloud.documentai.v1.IBoundingPoly|null);

PageRef boundingPoly.

confidence

public confidence: number;

PageRef confidence.

layoutId

public layoutId: string;

PageRef layoutId.

layoutType

public layoutType: (google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType|keyof typeof google.cloud.documentai.v1.Document.PageAnchor.PageRef.LayoutType);

PageRef layoutType.

page

public page: (number|Long|string);

PageRef page.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Document.PageAnchor.IPageRef): google.cloud.documentai.v1.Document.PageAnchor.PageRef;

Creates a new PageRef instance using the specified properties.

Parameter

Name	Description
properties	`IPageRef` Properties to set

Returns

Type	Description
google.cloud.documentai.v1.Document.PageAnchor.PageRef	PageRef instance

decode(reader, length)

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

Decodes a PageRef 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.PageAnchor.PageRef	PageRef

decodeDelimited(reader)

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

Decodes a PageRef 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.PageAnchor.PageRef	PageRef

encode(message, writer)

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

Encodes the specified PageRef message. Does not implicitly messages.

Parameters

Name	Description
message	`IPageRef` PageRef 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.PageAnchor.IPageRef, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPageRef` PageRef 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.PageAnchor.PageRef;

Creates a PageRef 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.PageAnchor.PageRef	PageRef

toJSON()

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

Converts this PageRef to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.documentai.v1.Document.PageAnchor.PageRef` PageRef
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 PageRef 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