ProcessorVersion

google.cloud.documentai.v1beta3. ProcessorVersion

Represents a ProcessorVersion.

Constructor

new ProcessorVersion(propertiesopt)

Constructs a new ProcessorVersion.

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

Properties to set
Implements:
  • IProcessorVersion

Classes

DeprecationInfo
GenAiModelInfo

Members

createTime

ProcessorVersion createTime.

deprecationInfo

ProcessorVersion deprecationInfo.

displayName

ProcessorVersion displayName.

documentSchema

ProcessorVersion documentSchema.

genAiModelInfo

ProcessorVersion genAiModelInfo.

googleManaged

ProcessorVersion googleManaged.

kmsKeyName

ProcessorVersion kmsKeyName.

kmsKeyVersionName

ProcessorVersion kmsKeyVersionName.

latestEvaluation

ProcessorVersion latestEvaluation.

modelType

ProcessorVersion modelType.

name

ProcessorVersion name.

satisfiesPzi

ProcessorVersion satisfiesPzi.

satisfiesPzs

ProcessorVersion satisfiesPzs.

state

ProcessorVersion state.

ModelType

ModelType enum.

Properties:
Name Type Description
MODEL_TYPE_UNSPECIFIED number

MODEL_TYPE_UNSPECIFIED value
MODEL_TYPE_GENERATIVE number

MODEL_TYPE_GENERATIVE value
MODEL_TYPE_CUSTOM number

MODEL_TYPE_CUSTOM value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
DEPLOYED number

DEPLOYED value
DEPLOYING number

DEPLOYING value
UNDEPLOYED number

UNDEPLOYED value
UNDEPLOYING number

UNDEPLOYING value
CREATING number

CREATING value
DELETING number

DELETING value
FAILED number

FAILED value
IMPORTING number

IMPORTING value

Methods

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

Converts this ProcessorVersion to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new ProcessorVersion instance using the specified properties.

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

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

ProcessorVersion instance

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

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

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

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

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

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

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

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

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

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

ProcessorVersion

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ProcessorVersion

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

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

ProcessorVersion
options $protobuf.IConversionOptions <optional>

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

Plain object

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

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