Cloud Document AI v1 API - Class Processor (3.19.0)

public sealed class Processor : IMessage<Processor>, IEquatable<Processor>, IDeepCloneable<Processor>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Document AI v1 API class Processor.

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

Inheritance

object > Processor

Implements

IMessage Processor, IEquatable Processor, IDeepCloneable Processor, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

Processor()

public Processor()

Processor(Processor)

public Processor(Processor other)

Parameter
Name	Description
`other`	`Processor`

Properties

CreateTime

public Timestamp CreateTime { get; set; }

The time the processor was created.

Property Value
Type	Description
`Timestamp`

DefaultProcessorVersion

public string DefaultProcessorVersion { get; set; }

The default processor version.

Property Value
Type	Description
`string`

DefaultProcessorVersionAsProcessorVersionName

public ProcessorVersionName DefaultProcessorVersionAsProcessorVersionName { get; set; }

ProcessorVersionName-typed view over the DefaultProcessorVersion resource name property.

Property Value
Type	Description
`ProcessorVersionName`

DisplayName

public string DisplayName { get; set; }

The display name of the processor.

Property Value
Type	Description
`string`

KmsKeyName

public string KmsKeyName { get; set; }

The KMS key used for encryption and decryption in CMEK scenarios.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}

Property Value
Type	Description
`string`

ProcessEndpoint

public string ProcessEndpoint { get; set; }

Output only. Immutable. The http endpoint that can be called to invoke processing.

Property Value
Type	Description
`string`

ProcessorName

public ProcessorName ProcessorName { get; set; }

ProcessorName-typed view over the Name resource name property.

Property Value
Type	Description
`ProcessorName`

ProcessorVersionAliases

public RepeatedField<ProcessorVersionAlias> ProcessorVersionAliases { get; }

Output only. The processor version aliases.

Property Value
Type	Description
`RepeatedFieldProcessorVersionAlias`

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use.

Property Value
Type	Description
`bool`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type	Description
`bool`

State

public Processor.Types.State State { get; set; }

Output only. The state of the processor.

Property Value
Type	Description
`ProcessorTypesState`

Type

public string Type { get; set; }

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].

Property Value
Type	Description
`string`