Processor

google.cloud.documentai.v1beta3. Processor

Represents a Processor.

Constructor

new Processor(propertiesopt)

Constructs a new Processor.

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

Properties to set

Implements:
  • IProcessor

Members

createTime

Processor createTime.

defaultProcessorVersion

Processor defaultProcessorVersion.

displayName

Processor displayName.

kmsKeyName

Processor kmsKeyName.

name

Processor name.

processEndpoint

Processor processEndpoint.

processorVersionAliases

Processor processorVersionAliases.

satisfiesPzi

Processor satisfiesPzi.

satisfiesPzs

Processor satisfiesPzs.

state

Processor state.

type

Processor type.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ENABLED number

ENABLED value

DISABLED number

DISABLED value

ENABLING number

ENABLING value

DISABLING number

DISABLING value

CREATING number

CREATING value

FAILED number

FAILED value

DELETING number

DELETING value

Methods

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

Converts this Processor to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Processor instance using the specified properties.

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

Properties to set

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

Processor instance

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

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

Processor

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

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

Processor

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

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

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

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

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

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

Processor

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Processor

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 Processor message. Also converts values to other types if specified.

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

Processor

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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