Cloud Document AI v1 API - Class Processor (3.1.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.MemberwiseClone()

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/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.

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`

State

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

Output only. The state of the processor.

Property Value
Type	Description
`Processor.Types.State`

Type

public string Type { get; set; }

The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc. To get a list of processors types, see [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].

Property Value
Type	Description
`String`