ProcessDocumentRequest

google.cloud.documentai.v1beta2. ProcessDocumentRequest

Represents a ProcessDocumentRequest.

Constructor

new ProcessDocumentRequest(propertiesopt)

Constructs a new ProcessDocumentRequest.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta2.IProcessDocumentRequest <optional>

Properties to set

Implements:
  • IProcessDocumentRequest

Members

automlParams :google.cloud.documentai.v1beta2.IAutoMlParams|null|undefined

ProcessDocumentRequest automlParams.

documentType :string

ProcessDocumentRequest documentType.

entityExtractionParams :google.cloud.documentai.v1beta2.IEntityExtractionParams|null|undefined

ProcessDocumentRequest entityExtractionParams.

formExtractionParams :google.cloud.documentai.v1beta2.IFormExtractionParams|null|undefined

ProcessDocumentRequest formExtractionParams.

inputConfig :google.cloud.documentai.v1beta2.IInputConfig|null|undefined

ProcessDocumentRequest inputConfig.

ocrParams :google.cloud.documentai.v1beta2.IOcrParams|null|undefined

ProcessDocumentRequest ocrParams.

outputConfig :google.cloud.documentai.v1beta2.IOutputConfig|null|undefined

ProcessDocumentRequest outputConfig.

parent :string

ProcessDocumentRequest parent.

tableExtractionParams :google.cloud.documentai.v1beta2.ITableExtractionParams|null|undefined

ProcessDocumentRequest tableExtractionParams.

Methods

(static) create(propertiesopt) → {google.cloud.documentai.v1beta2.ProcessDocumentRequest}

Creates a new ProcessDocumentRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1beta2.IProcessDocumentRequest <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1beta2.ProcessDocumentRequest}

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

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.v1beta2.ProcessDocumentRequest}

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

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

Reader or buffer to decode from

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 ProcessDocumentRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta2.IProcessDocumentRequest

ProcessDocumentRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta2.IProcessDocumentRequest

ProcessDocumentRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.documentai.v1beta2.ProcessDocumentRequest}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1beta2.ProcessDocumentRequest

ProcessDocumentRequest

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies a ProcessDocumentRequest message.

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

Plain object to verify

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

Converts this ProcessDocumentRequest to JSON.