REST Resource: projects.locations.processors.processorVersions

Stay organized with collections Save and categorize content based on your preferences.

Resource: ProcessorVersion

A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version

JSON representation
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "createTime": string,
  "kmsKeyName": string,
  "kmsKeyVersionName": string,
  "googleManaged": boolean,
  "deprecationInfo": {
    object (DeprecationInfo)
  }
}
Fields
name

string

The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

displayName

string

The display name of the processor version.

state

enum (State)

The state of the processor version.

createTime

string (Timestamp format)

The time the processor version was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

kmsKeyName

string

The KMS key name used for encryption.

kmsKeyVersionName

string

The KMS key version with which data is encrypted.

googleManaged

boolean

Denotes that this ProcessorVersion is managed by google.

deprecationInfo

object (DeprecationInfo)

If set, information about the eventual deprecation of this version.

State

The possible states of the processor version.

Enums
STATE_UNSPECIFIED The processor version is in an unspecified state.
DEPLOYED The processor version is deployed and can be used for processing.
DEPLOYING The processor version is being deployed.
UNDEPLOYED The processor version is not deployed and cannot be used for processing.
UNDEPLOYING The processor version is being undeployed.
CREATING The processor version is being created.
DELETING The processor version is being deleted.
FAILED The processor version failed and is in an indeterminate state.

DeprecationInfo

Information about the upcoming deprecation of this processor version.

JSON representation
{
  "deprecationTime": string,
  "replacementProcessorVersion": string
}
Fields
deprecationTime

string (Timestamp format)

The time at which this processor version will be deprecated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

replacementProcessorVersion

string

If set, the processor version that will be used as a replacement.

Methods

batchProcess

LRO endpoint to batch process many documents.

delete

Deletes the processor version, all artifacts under the processor version will be deleted.

deploy

Deploys the processor version.

get

Gets a processor version detail.

list

Lists all versions of a processor.

process

Processes a single document.

undeploy

Undeploys the processor version.