Class protos.google.cloud.documentai.v1beta3.ReviewDocumentRequest (8.12.0)

Represents a ReviewDocumentRequest.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.IReviewDocumentRequest);

Constructs a new ReviewDocumentRequest.

Parameter
Name Description
properties IReviewDocumentRequest

Properties to set

Properties

document

public document?: (google.cloud.documentai.v1beta3.IDocument|null);

ReviewDocumentRequest document.

documentSchema

public documentSchema?: (google.cloud.documentai.v1beta3.IDocumentSchema|null);

ReviewDocumentRequest documentSchema.

enableSchemaValidation

public enableSchemaValidation: boolean;

ReviewDocumentRequest enableSchemaValidation.

humanReviewConfig

public humanReviewConfig: string;

ReviewDocumentRequest humanReviewConfig.

inlineDocument

public inlineDocument?: (google.cloud.documentai.v1beta3.IDocument|null);

ReviewDocumentRequest inlineDocument.

priority

public priority: (google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority|keyof typeof google.cloud.documentai.v1beta3.ReviewDocumentRequest.Priority);

ReviewDocumentRequest priority.

source

public source?: "inlineDocument";

ReviewDocumentRequest source.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.IReviewDocumentRequest): google.cloud.documentai.v1beta3.ReviewDocumentRequest;

Creates a new ReviewDocumentRequest instance using the specified properties.

Parameter
Name Description
properties IReviewDocumentRequest

Properties to set

Returns
Type Description
ReviewDocumentRequest

ReviewDocumentRequest instance

decode(reader, length)

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

Decodes a ReviewDocumentRequest 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
ReviewDocumentRequest

ReviewDocumentRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.ReviewDocumentRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ReviewDocumentRequest

ReviewDocumentRequest

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta3.IReviewDocumentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ReviewDocumentRequest message. Does not implicitly messages.

Parameters
Name Description
message IReviewDocumentRequest

ReviewDocumentRequest 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.IReviewDocumentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IReviewDocumentRequest

ReviewDocumentRequest 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.ReviewDocumentRequest;

Creates a ReviewDocumentRequest 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
ReviewDocumentRequest

ReviewDocumentRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ReviewDocumentRequest

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ReviewDocumentRequest

ReviewDocumentRequest

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