BatchProcessMetadata

google.cloud.documentai.v1. BatchProcessMetadata

Represents a BatchProcessMetadata.

Constructor

new BatchProcessMetadata(propertiesopt)

Constructs a new BatchProcessMetadata.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1.IBatchProcessMetadata <optional>

Properties to set
Implements:
  • IBatchProcessMetadata

Classes

IndividualProcessStatus

Members

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
WAITING number

WAITING value
RUNNING number

RUNNING value
SUCCEEDED number

SUCCEEDED value
CANCELLING number

CANCELLING value
CANCELLED number

CANCELLED value
FAILED number

FAILED value

createTime

BatchProcessMetadata createTime.

individualProcessStatuses

BatchProcessMetadata individualProcessStatuses.

state

BatchProcessMetadata state.

stateMessage

BatchProcessMetadata stateMessage.

updateTime

BatchProcessMetadata updateTime.

Methods

(static) create(propertiesopt) → {google.cloud.documentai.v1.BatchProcessMetadata}

Creates a new BatchProcessMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.documentai.v1.IBatchProcessMetadata <optional>

Properties to set
Returns:
Type Description
google.cloud.documentai.v1.BatchProcessMetadata

BatchProcessMetadata instance

(static) decode(reader, lengthopt) → {google.cloud.documentai.v1.BatchProcessMetadata}

Decodes a BatchProcessMetadata 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.v1.BatchProcessMetadata

BatchProcessMetadata
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.v1.BatchProcessMetadata}

Decodes a BatchProcessMetadata 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.v1.BatchProcessMetadata

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1.IBatchProcessMetadata

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1.IBatchProcessMetadata

BatchProcessMetadata 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.v1.BatchProcessMetadata}

Creates a BatchProcessMetadata 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.v1.BatchProcessMetadata

BatchProcessMetadata

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

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

Parameters:
Name Type Attributes Description
message google.cloud.documentai.v1.BatchProcessMetadata

BatchProcessMetadata
options $protobuf.IConversionOptions <optional>

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

Plain object

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

Verifies a BatchProcessMetadata 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 BatchProcessMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object