Class protos.google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock (9.2.0)
Stay organized with collections Save and categorize content based on your preferences.

Represents a LayoutImageBlock.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.ILayoutImageBlock);

Constructs a new LayoutImageBlock.

Parameter
Name	Description
`properties`	`ILayoutImageBlock` Properties to set

Properties

annotations

public annotations?: (google.cloud.documentai.v1beta3.Document.IAnnotations|null);

LayoutImageBlock annotations.

blobAssetId

public blobAssetId?: (string|null);

LayoutImageBlock blobAssetId.

dataUri

public dataUri?: (string|null);

LayoutImageBlock dataUri.

gcsUri

public gcsUri?: (string|null);

LayoutImageBlock gcsUri.

imageSource

public imageSource?: ("blobAssetId"|"gcsUri"|"dataUri");

LayoutImageBlock imageSource.

imageText

public imageText: string;

LayoutImageBlock imageText.

mimeType

public mimeType: string;

LayoutImageBlock mimeType.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.ILayoutImageBlock): google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock;

Creates a new LayoutImageBlock instance using the specified properties.

Parameter
Name	Description
`properties`	`ILayoutImageBlock` Properties to set

Returns
Type	Description
`LayoutImageBlock`	LayoutImageBlock instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock;

Decodes a LayoutImageBlock 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
`LayoutImageBlock`	LayoutImageBlock

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`LayoutImageBlock`	LayoutImageBlock

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.ILayoutImageBlock, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LayoutImageBlock message. Does not implicitly messages.

Parameters
Name	Description
`message`	`ILayoutImageBlock` LayoutImageBlock 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.DocumentLayout.DocumentLayoutBlock.ILayoutImageBlock, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`ILayoutImageBlock` LayoutImageBlock 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.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock;

Creates a LayoutImageBlock 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
`LayoutImageBlock`	LayoutImageBlock

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for LayoutImageBlock

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 LayoutImageBlock to JSON.

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

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
`message`	`LayoutImageBlock` LayoutImageBlock
`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 LayoutImageBlock 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

Class protos.google.cloud.documentai.v1beta3.Document.DocumentLayout.DocumentLayoutBlock.LayoutImageBlock (9.2.0) Stay organized with collections Save and categorize content based on your preferences.