ReviewDocumentRequest

google.cloud.documentai.v1beta3. ReviewDocumentRequest

Represents a ReviewDocumentRequest.

Constructor

new ReviewDocumentRequest(propertiesopt)

Constructs a new ReviewDocumentRequest.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.IReviewDocumentRequest <optional>

Properties to set
Implements:
  • IReviewDocumentRequest

Members

Priority

Priority enum.

Properties:
Name Type Description
DEFAULT number

DEFAULT value
URGENT number

URGENT value

document

ReviewDocumentRequest document.

enableSchemaValidation

ReviewDocumentRequest enableSchemaValidation.

humanReviewConfig

ReviewDocumentRequest humanReviewConfig.

inlineDocument

ReviewDocumentRequest inlineDocument.

priority

ReviewDocumentRequest priority.

source

ReviewDocumentRequest source.

Methods

(static) create(propertiesopt) → {google.cloud.documentai.v1beta3.ReviewDocumentRequest}

Creates a new ReviewDocumentRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta3.IReviewDocumentRequest <optional>

Properties to set
Returns:
Type Description
google.cloud.documentai.v1beta3.ReviewDocumentRequest

ReviewDocumentRequest instance

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta3.ReviewDocumentRequest}

Decodes a ReviewDocumentRequest message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.documentai.v1beta3.ReviewDocumentRequest

ReviewDocumentRequest
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.documentai.v1beta3.ReviewDocumentRequest}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.documentai.v1beta3.ReviewDocumentRequest

ReviewDocumentRequest
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified ReviewDocumentRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.IReviewDocumentRequest

ReviewDocumentRequest message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.IReviewDocumentRequest

ReviewDocumentRequest message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.documentai.v1beta3.ReviewDocumentRequest}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.documentai.v1beta3.ReviewDocumentRequest

ReviewDocumentRequest

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta3.ReviewDocumentRequest

ReviewDocumentRequest
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a ReviewDocumentRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this ReviewDocumentRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object