Class protos.google.cloud.documentai.v1.Document.Page.Token.DetectedBreak

Represents a DetectedBreak.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

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

Constructs a new DetectedBreak.

Parameter
NameDescription
properties IDetectedBreak

Properties to set

Properties

type

public type: (google.cloud.documentai.v1.Document.Page.Token.DetectedBreak.Type|keyof typeof google.cloud.documentai.v1.Document.Page.Token.DetectedBreak.Type);

DetectedBreak type.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1.Document.Page.Token.IDetectedBreak): google.cloud.documentai.v1.Document.Page.Token.DetectedBreak;

Creates a new DetectedBreak instance using the specified properties.

Parameter
NameDescription
properties IDetectedBreak

Properties to set

Returns
TypeDescription
google.cloud.documentai.v1.Document.Page.Token.DetectedBreak

DetectedBreak instance

decode(reader, length)

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

Decodes a DetectedBreak 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.Token.DetectedBreak

DetectedBreak

decodeDelimited(reader)

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

Decodes a DetectedBreak 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.Token.DetectedBreak

DetectedBreak

encode(message, writer)

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

Encodes the specified DetectedBreak message. Does not implicitly messages.

Parameters
NameDescription
message IDetectedBreak

DetectedBreak 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.Token.IDetectedBreak, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDetectedBreak

DetectedBreak 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.Token.DetectedBreak;

Creates a DetectedBreak 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.Token.DetectedBreak

DetectedBreak

toJSON()

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

Converts this DetectedBreak to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.documentai.v1.Document.Page.Token.DetectedBreak

DetectedBreak

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 DetectedBreak 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