Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeConversionJobRunReport

Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Source revision 9ba015295d53 with working tree changes
Implements
IEquatable<OfficeConversionJobRunReport>
Modifiers sealed

Observational history for one saved-job attempt. Its paths and outcomes never authorize output reuse.

Inheritance

  • Object
  • OfficeConversionJobRunReport

Usage

Explore 10 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.

Constructors

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

Methods

public OfficeConversionJobRunReport <Clone>$() #
Returns: OfficeConversionJobRunReport
Equals 2 overloads
public override Boolean Equals(Object? obj) #
Returns: Boolean

Parameters

obj Object? requiredposition: 0
public Boolean Equals(OfficeConversionJobRunReport? other) #
Returns: Boolean

Parameters

other OfficeConversionJobRunReport? requiredposition: 0
public override Int32 GetHashCode() #
Returns: Int32
public static Boolean op_Equality(OfficeConversionJobRunReport? left, OfficeConversionJobRunReport? right) #
Returns: Boolean

Parameters

left OfficeConversionJobRunReport? requiredposition: 0
right OfficeConversionJobRunReport? requiredposition: 1
public static Boolean op_Inequality(OfficeConversionJobRunReport? left, OfficeConversionJobRunReport? right) #
Returns: Boolean

Parameters

left OfficeConversionJobRunReport? requiredposition: 0
right OfficeConversionJobRunReport? requiredposition: 1
public override String ToString() #
Returns: String

Properties

public String Schema { get; init; } #
JsonRequired

Versioned contract identifier.

public String RunId { get; init; } #

Unique attempt identifier, formatted as a GUID without separators.

public DateTimeOffset StartedUtc { get; init; } #

UTC instant when the attempt was admitted.

public DateTimeOffset? FinishedUtc { get; init; } #

UTC instant when execution reached a terminal outcome, if recorded.

public String JobPath { get; init; } #

Absolute path to the admitted saved-job file.

public String JobSha256 { get; init; } #

SHA-256 of the exact admitted job-file bytes, including any byte-order mark.

public String OutputDirectory { get; init; } #

Absolute conversion output directory.

public String? CheckpointDirectory { get; init; } #

Optional absolute checkpoint directory. Checkpoints remain the sole reuse authority.

public Boolean RetryFailed { get; init; } #

Whether this attempt explicitly retries prior failed checkpoint items.

public Boolean AllowEmpty { get; init; } #

Whether an intentionally empty selection is accepted for this attempt.

public OfficeConversionJobRunState State { get; init; } #
JsonRequired

Attempt lifecycle; readers recover abandoned Running records as Interrupted.

public OfficeConversionBatchReport? Batch { get; init; } #

Bounded conversion observations and complete aggregate counts, available for ordinary returned outcomes.

public String? FailureSummary { get; init; } #

Unexpected execution error, when execution did not produce an ordinary terminal result.

public String? RecordingError { get; init; } #

Report publication failure. Returned conversion counts remain available even if final persistence failed.

Fields

public const String CurrentSchema #

The versioned saved-job run contract.

Value: officeimo.conversion.job.run.v1