java.lang.Object
- net.webpdf.wsclient.openapi.OperationToolboxTranscribeTranscribe

```
public class OperationToolboxTranscribeTranscribe
extends Object
```
The transcribe operation element can be used to convert a PDF document into other document formats. Errors and inaccuracies can always occur during such conversions, so the endpoint allows a report to be generated to detect and evaluate possible transfer errors both in the event of an error and in the event of a success.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationToolboxTranscribeTranscribe.ErrorReportEnum`	This parameter determines if and in which form the XML report for a failed conversion is returned
`static class`	`OperationToolboxTranscribeTranscribe.FailureLevelEnum`	This parameter determines at which error level the conversion should fail, you can use this parameter to automatically reject also results with lower precision as failure * warning = Documents for which warnings occur will also cause the conversion to fail. * missingContent = Documents for which not all content could be converted correctly will also be considered as failures. * error = Only if a conversion of the document did not lead to any meaningful result document, this is evaluated as failure, even if contents should be missing.
`static class`	`OperationToolboxTranscribeTranscribe.SuccessReportEnum`	This parameter determines if and in which form the XML report for a successful conversion is returned

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ERROR_REPORT`
`static String`	`JSON_PROPERTY_FAILURE_LEVEL`
`static String`	`JSON_PROPERTY_HTML`
`static String`	`JSON_PROPERTY_SUCCESS_REPORT`

Constructor Summary

Constructors
Constructor Description

OperationToolboxTranscribeTranscribe()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`OperationToolboxTranscribeTranscribe`	`errorReport(OperationToolboxTranscribeTranscribe.ErrorReportEnum errorReport)`
`OperationToolboxTranscribeTranscribe`	`failureLevel(OperationToolboxTranscribeTranscribe.FailureLevelEnum failureLevel)`
`@Nullable OperationToolboxTranscribeTranscribe.ErrorReportEnum`	`getErrorReport()`	This parameter determines if and in which form the XML report for a failed conversion is returned
`@Nullable OperationToolboxTranscribeTranscribe.FailureLevelEnum`	`getFailureLevel()`	This parameter determines at which error level the conversion should fail, you can use this parameter to automatically reject also results with lower precision as failure * warning = Documents for which warnings occur will also cause the conversion to fail. * missingContent = Documents for which not all content could be converted correctly will also be considered as failures. * error = Only if a conversion of the document did not lead to any meaningful result document, this is evaluated as failure, even if contents should be missing.
`@Nullable OperationHtmlTranscribe`	`getHtml()`	Get html
`@Nullable OperationToolboxTranscribeTranscribe.SuccessReportEnum`	`getSuccessReport()`	This parameter determines if and in which form the XML report for a successful conversion is returned
`int`	`hashCode()`
`OperationToolboxTranscribeTranscribe`	`html(OperationHtmlTranscribe html)`
`void`	`setErrorReport(OperationToolboxTranscribeTranscribe.ErrorReportEnum errorReport)`
`void`	`setFailureLevel(OperationToolboxTranscribeTranscribe.FailureLevelEnum failureLevel)`
`void`	`setHtml(OperationHtmlTranscribe html)`
`void`	`setSuccessReport(OperationToolboxTranscribeTranscribe.SuccessReportEnum successReport)`
`OperationToolboxTranscribeTranscribe`	`successReport(OperationToolboxTranscribeTranscribe.SuccessReportEnum successReport)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - JSON_PROPERTY_ERROR_REPORT
```
public static final String JSON_PROPERTY_ERROR_REPORT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FAILURE_LEVEL
```
public static final String JSON_PROPERTY_FAILURE_LEVEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HTML
```
public static final String JSON_PROPERTY_HTML
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUCCESS_REPORT
```
public static final String JSON_PROPERTY_SUCCESS_REPORT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationToolboxTranscribeTranscribe
```
public OperationToolboxTranscribeTranscribe()
```
- Method Detail
  - errorReport
```
public OperationToolboxTranscribeTranscribe errorReport(OperationToolboxTranscribeTranscribe.ErrorReportEnum errorReport)
```
  - getErrorReport
```
@Nullable
public @Nullable OperationToolboxTranscribeTranscribe.ErrorReportEnum getErrorReport()
```
    This parameter determines if and in which form the XML report for a failed conversion is returned. * none = XML report is not returned * message = XML report will be delivered as part of the error message * file = XML report is saved to file
    
    Returns:
    
    errorReport
  - setErrorReport
```
public void setErrorReport(OperationToolboxTranscribeTranscribe.ErrorReportEnum errorReport)
```
  - failureLevel
```
public OperationToolboxTranscribeTranscribe failureLevel(OperationToolboxTranscribeTranscribe.FailureLevelEnum failureLevel)
```
  - getFailureLevel
```
@Nullable
public @Nullable OperationToolboxTranscribeTranscribe.FailureLevelEnum getFailureLevel()
```
    This parameter determines at which error level the conversion should fail, you can use this parameter to automatically reject also results with lower precision as failure * warning = Documents for which warnings occur will also cause the conversion to fail. * missingContent = Documents for which not all content could be converted correctly will also be considered as failures. * error = Only if a conversion of the document did not lead to any meaningful result document, this is evaluated as failure, even if contents should be missing.
    
    Returns:
    
    failureLevel
  - setFailureLevel
```
public void setFailureLevel(OperationToolboxTranscribeTranscribe.FailureLevelEnum failureLevel)
```
  - html
```
public OperationToolboxTranscribeTranscribe html(OperationHtmlTranscribe html)
```
  - getHtml
```
@Nullable
public @Nullable OperationHtmlTranscribe getHtml()
```
    Get html
    
    Returns:
    
    html
  - setHtml
```
public void setHtml(OperationHtmlTranscribe html)
```
  - successReport
```
public OperationToolboxTranscribeTranscribe successReport(OperationToolboxTranscribeTranscribe.SuccessReportEnum successReport)
```
  - getSuccessReport
```
@Nullable
public @Nullable OperationToolboxTranscribeTranscribe.SuccessReportEnum getSuccessReport()
```
    This parameter determines if and in which form the XML report for a successful conversion is returned. * none = XML report is not returned * linked = XML report is appended to the end of the target document. * zip = target document and XML report are packed together in a ZIP archive. **Important:** The format of the document created at \"errorReport\" and \"successReport\" is described via the http://schema.webpdf.de/1.0/report/transcribe.xsd schema.
    
    Returns:
    
    successReport
  - setSuccessReport
```
public void setSuccessReport(OperationToolboxTranscribeTranscribe.SuccessReportEnum successReport)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class OperationToolboxTranscribeTranscribe

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ERROR_REPORT

JSON_PROPERTY_FAILURE_LEVEL

JSON_PROPERTY_HTML

JSON_PROPERTY_SUCCESS_REPORT

Constructor Detail

OperationToolboxTranscribeTranscribe

Method Detail

errorReport

getErrorReport

setErrorReport

failureLevel

getFailureLevel

setFailureLevel

html

getHtml

setHtml

successReport

getSuccessReport

setSuccessReport

equals

hashCode

toString