# Cloud Document AI v1beta3 API - Class Processor (2.0.0-beta30)

2.0.0-beta30 (latest) 2.0.0-beta29 1.0.0-beta04

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

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

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

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Processor

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Processor](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Processor](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Processor](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DocumentAI.V1Beta3](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3)

## Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

## Constructors

### Processor()

    public Processor()

### Processor(Processor)

    public Processor(Processor other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor` |

## Properties

### CreateTime

    public Timestamp CreateTime { get; set; }

Output only. The time the processor was created.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### DefaultProcessorVersion

    public string DefaultProcessorVersion { get; set; }

The default processor version.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### DefaultProcessorVersionAsProcessorVersionName

    public ProcessorVersionName DefaultProcessorVersionAsProcessorVersionName { get; set; }

[ProcessorVersionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.ProcessorVersionName)-typed view over the [DefaultProcessorVersion](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor#Google_Cloud_DocumentAI_V1Beta3_Processor_DefaultProcessorVersion) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.ProcessorVersionName` |   |

### DisplayName

    public string DisplayName { get; set; }

The display name of the processor.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### KmsKeyName

    public string KmsKeyName { get; set; }

The [KMS key](https://cloud.google.com/security-key-management) used for
encryption and decryption in CMEK scenarios.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ProcessEndpoint

    public string ProcessEndpoint { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ProcessorName

    public ProcessorName ProcessorName { get; set; }

[ProcessorName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.ProcessorName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor#Google_Cloud_DocumentAI_V1Beta3_Processor_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.ProcessorName` |   |

### ProcessorVersionAliases

    public RepeatedField<ProcessorVersionAlias> ProcessorVersionAliases { get; }

Output only. The processor version aliases.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.ProcessorVersionAlias` |   |

### SatisfiesPzi

    public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### SatisfiesPzs

    public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### State

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

Output only. The state of the processor.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processorhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Processor.Types.State` |   |

### 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.v1beta3.DocumentProcessorService.FetchProcessorTypes\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |