# PdfRedactionBatchRequest

Serializable, deterministic file-set request for a PDF redaction batch.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[PdfRedactionBatchContracts.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L21)

**Modifiers**

sealed

Serializable, deterministic file-set request for a PDF redaction batch.

## Inheritance

- object
- PdfRedactionBatchRequest

## Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Accepted by parameters 2

- Method [IPdfRedactionWorkflowRunner.RunRedactionBatchAsync](/api/workflows/officeimo-workflows-ipdfredactionworkflowrunner/#method-runredactionbatchasync-officeimo-workflows-pdfredactionbatchrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `request`
- Method [OfficeWorkflowRunner.RunRedactionBatchAsync](/api/workflows/officeimo-workflows-officeworkflowrunner/#method-runredactionbatchasync-officeimo-workflows-pdfredactionbatchrequest-iprogress-officeimo-workflows-officeworkflowprogress-threading-cancellationtoken) parameter `request`

Filter members 

Show inherited

## Constructors

`public PdfRedactionBatchRequest()` [#](#constructor-ctor)

[PdfRedactionBatchContracts.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L21)

`Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string Schema { get; set; }` [#](#property-schema)

[PdfRedactionBatchContracts.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L21)

Schema identifier.

`public PdfRedactionWorkflowMode Mode { get; set; }` [#](#property-mode)

[PdfRedactionBatchContracts.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L23)

Workflow mode applied to every selected input.

`public string InputRoot { get; set; }` [#](#property-inputroot)

[PdfRedactionBatchContracts.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L25)

Root containing reviewed source PDFs.

`public IList<string> InputPaths { get; set; }` [#](#property-inputpaths)

[PdfRedactionBatchContracts.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L27)

Optional relative input paths. When empty, [PdfRedactionBatchRequest.SearchPattern](/api/workflows/officeimo-workflows-pdfredactionbatchrequest/) is enumerated beneath [PdfRedactionBatchRequest.InputRoot](/api/workflows/officeimo-workflows-pdfredactionbatchrequest/).

`public string SearchPattern { get; set; }` [#](#property-searchpattern)

[PdfRedactionBatchContracts.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L29)

File-system search pattern used when [PdfRedactionBatchRequest.InputPaths](/api/workflows/officeimo-workflows-pdfredactionbatchrequest/) is empty. Defaults to *.pdf.

`public bool RecurseSubdirectories { get; set; }` [#](#property-recursesubdirectories)

[PdfRedactionBatchContracts.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L31)

Whether pattern discovery recurses beneath the input root.

`public string? OutputRoot { get; set; }` [#](#property-outputroot)

[PdfRedactionBatchContracts.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L33)

Separate root for redacted outputs or existing outputs being verified.

`public string EvidenceRoot { get; set; }` [#](#property-evidenceroot)

[PdfRedactionBatchContracts.cs:35](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L35)

Separate root for privacy-safe per-item evidence.

`public string? DecisionsRoot { get; set; }` [#](#property-decisionsroot)

[PdfRedactionBatchContracts.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L37)

Separate root containing reviewed decision manifests for apply and verify modes.

`public string OutputSuffix { get; set; }` [#](#property-outputsuffix)

[PdfRedactionBatchContracts.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L39)

Suffix appended to each input stem for output PDFs.

`public string EvidenceSuffix { get; set; }` [#](#property-evidencesuffix)

[PdfRedactionBatchContracts.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L41)

Suffix appended to each input stem for per-item evidence.

`public string DecisionsSuffix { get; set; }` [#](#property-decisionssuffix)

[PdfRedactionBatchContracts.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L43)

Suffix appended to each input stem when resolving reviewed decisions.

`public string ManifestPath { get; set; }` [#](#property-manifestpath)

[PdfRedactionBatchContracts.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L45)

Consolidated privacy-safe batch manifest path.

`public PdfRedactionBatchPublicationPolicy PublicationPolicy { get; set; }` [#](#property-publicationpolicy)

[PdfRedactionBatchContracts.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L47)

Publication behavior for item failures.

`public OfficePublicationPolicy ConflictPolicy { get; set; }` [#](#property-conflictpolicy)

[PdfRedactionBatchContracts.cs:49](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L49)

Output conflict behavior shared by the batch.

`public PdfRedactionRecipe Recipe { get; set; }` [#](#property-recipe)

[PdfRedactionBatchContracts.cs:51](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L51)

Named redaction recipe shared by the batch.

`public PdfRedactionWorkflowLimits Limits { get; set; }` [#](#property-limits)

[PdfRedactionBatchContracts.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L53)

Shared resource limits.

`public IList<string> ProtectedInputPaths { get; set; }` [#](#property-protectedinputpaths)

[PdfRedactionBatchContracts.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L56)

`JsonIgnore`

Additional host inputs that publication may not replace.

`public IOcrEngine? OcrEngine { get; set; }` [#](#property-ocrengine)

[PdfRedactionBatchContracts.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L59)

`JsonIgnore`

Runtime OCR engine; never serialized.

`public PdfOcrMergeOptions? OcrOptions { get; set; }` [#](#property-ocroptions)

[PdfRedactionBatchContracts.cs:62](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L62)

`JsonIgnore`

Runtime OCR options; never serialized.

`public string? OwnerPassword { get; set; }` [#](#property-ownerpassword)

[PdfRedactionBatchContracts.cs:65](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L65)

`JsonIgnore`

Runtime owner password; never serialized.

`public PdfStandardEncryptionOptions? OutputEncryption { get; set; }` [#](#property-outputencryption)

[PdfRedactionBatchContracts.cs:68](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L68)

`JsonIgnore`

Runtime output encryption; passwords are never serialized.

`public IPdfExternalSigner? OutputSigner { get; set; }` [#](#property-outputsigner)

[PdfRedactionBatchContracts.cs:71](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L71)

`JsonIgnore`

Runtime signer for signed derivatives; never serialized.

`public PdfExternalSignatureOptions? OutputSignatureOptions { get; set; }` [#](#property-outputsignatureoptions)

[PdfRedactionBatchContracts.cs:74](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L74)

`JsonIgnore`

Runtime signature options; never serialized.

`public IPdfSignatureCryptographyProvider? OutputSignatureValidator { get; set; }` [#](#property-outputsignaturevalidator)

[PdfRedactionBatchContracts.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L77)

`JsonIgnore`

Runtime signature validator; never serialized.

`public IList<IPdfRedactionCancellationAwareExternalValidator> ExternalValidators { get; set; }` [#](#property-externalvalidators)

[PdfRedactionBatchContracts.cs:80](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L80)

`JsonIgnore`

Runtime validators; never serialized.

## Fields

`public const string CurrentSchema` [#](#field-currentschema)

[PdfRedactionBatchContracts.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionBatchContracts.cs#L19)

Stable request schema.

Value: `officeimo.pdf.redaction.batch-request.v1`

<!-- PowerForge markdown artifact sha256:D40C518918489E30767B82F26B33EFFE3A53C0D9A3C3804E637DD453A2FDAE3E -->
