BatchProcessRequest

google.cloud.documentai.v1beta3. BatchProcessRequest

Represents a BatchProcessRequest.

Constructor

new BatchProcessRequest(propertiesopt)

Constructs a new BatchProcessRequest.

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

Properties to set

Implements:
  • IBatchProcessRequest

Classes

BatchInputConfig
BatchOutputConfig

Members

documentOutputConfig

BatchProcessRequest documentOutputConfig.

inputConfigs

BatchProcessRequest inputConfigs.

inputDocuments

BatchProcessRequest inputDocuments.

labels

BatchProcessRequest labels.

name

BatchProcessRequest name.

outputConfig

BatchProcessRequest outputConfig.

processOptions

BatchProcessRequest processOptions.

skipHumanReview

BatchProcessRequest skipHumanReview.

Methods

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

Converts this BatchProcessRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new BatchProcessRequest instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.documentai.v1beta3.BatchProcessRequest

BatchProcessRequest instance

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

Decodes a BatchProcessRequest 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.BatchProcessRequest

BatchProcessRequest

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.BatchProcessRequest}

Decodes a BatchProcessRequest 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.BatchProcessRequest

BatchProcessRequest

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

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

BatchProcessRequest 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 BatchProcessRequest message, length delimited. Does not implicitly verify messages.

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

BatchProcessRequest 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.BatchProcessRequest}

Creates a BatchProcessRequest 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.BatchProcessRequest

BatchProcessRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for BatchProcessRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

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

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

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

BatchProcessRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a BatchProcessRequest 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