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

public class OperationTiff
extends Object

Defines a target TIFF image format.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`OperationTiff.BlackAndWhiteQualityEnum`	For \"tif\" exports, this parameter is used to define the quality of black-and-white images if \"group3\" or \"group4\" is used as a compression method.
`static class`	`OperationTiff.CompressionEnum`	This parameter is used to specify the compression method when exporting pages as \"tif\" images.
`static class`	`OperationTiff.MetricsEnum`	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_BLACK_AND_WHITE_QUALITY`
`static String`	`JSON_PROPERTY_COMPRESSION`
`static String`	`JSON_PROPERTY_DPI`
`static String`	`JSON_PROPERTY_HEIGHT`
`static String`	`JSON_PROPERTY_JPEG_QUALITY`
`static String`	`JSON_PROPERTY_METRICS`
`static String`	`JSON_PROPERTY_MULTIPAGE`
`static String`	`JSON_PROPERTY_WIDTH`

Constructor Summary

Constructors
Constructor Description

OperationTiff()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationTiff`	`blackAndWhiteQuality(OperationTiff.BlackAndWhiteQualityEnum blackAndWhiteQuality)`
`OperationTiff`	`compression(OperationTiff.CompressionEnum compression)`
`OperationTiff`	`dpi(Integer dpi)`
`boolean`	`equals(Object o)`
`@Nullable OperationTiff.BlackAndWhiteQualityEnum`	`getBlackAndWhiteQuality()`	For \"tif\" exports, this parameter is used to define the quality of black-and-white images if \"group3\" or \"group4\" is used as a compression method.
`@Nullable OperationTiff.CompressionEnum`	`getCompression()`	This parameter is used to specify the compression method when exporting pages as \"tif\" images.
`@Nullable Integer`	`getDpi()`	This parameter is used to define the image's DPI resolution.
`@Nullable Integer`	`getHeight()`	Used to limit the maximum height of the exported image. 0 = No restriction minimum: 0
`@Nullable Integer`	`getJpegQuality()`	When exporting to \"jpg\" format, this parameter can be used to define the image's quality as a percentage.
`@Nullable OperationTiff.MetricsEnum`	`getMetrics()`	Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
`@Nullable Boolean`	`getMultipage()`	If \"true,\" a \"multi-page TIFF\" will be created when multiple pages are exported as \"tif\" images.
`@Nullable Integer`	`getWidth()`	Used to limit the maximum width of the exported image. 0 = No restriction minimum: 0
`int`	`hashCode()`
`OperationTiff`	`height(Integer height)`
`OperationTiff`	`jpegQuality(Integer jpegQuality)`
`OperationTiff`	`metrics(OperationTiff.MetricsEnum metrics)`
`OperationTiff`	`multipage(Boolean multipage)`
`void`	`setBlackAndWhiteQuality(OperationTiff.BlackAndWhiteQualityEnum blackAndWhiteQuality)`
`void`	`setCompression(OperationTiff.CompressionEnum compression)`
`void`	`setDpi(Integer dpi)`
`void`	`setHeight(Integer height)`
`void`	`setJpegQuality(Integer jpegQuality)`
`void`	`setMetrics(OperationTiff.MetricsEnum metrics)`
`void`	`setMultipage(Boolean multipage)`
`void`	`setWidth(Integer width)`
`String`	`toString()`
`OperationTiff`	`width(Integer width)`

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

- Field Detail
  - JSON_PROPERTY_BLACK_AND_WHITE_QUALITY
```
public static final String JSON_PROPERTY_BLACK_AND_WHITE_QUALITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COMPRESSION
```
public static final String JSON_PROPERTY_COMPRESSION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DPI
```
public static final String JSON_PROPERTY_DPI
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_HEIGHT
```
public static final String JSON_PROPERTY_HEIGHT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_JPEG_QUALITY
```
public static final String JSON_PROPERTY_JPEG_QUALITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_METRICS
```
public static final String JSON_PROPERTY_METRICS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MULTIPAGE
```
public static final String JSON_PROPERTY_MULTIPAGE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_WIDTH
```
public static final String JSON_PROPERTY_WIDTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationTiff
```
public OperationTiff()
```
- Method Detail
  - blackAndWhiteQuality
```
public OperationTiff blackAndWhiteQuality(OperationTiff.BlackAndWhiteQualityEnum blackAndWhiteQuality)
```
  - getBlackAndWhiteQuality
```
@Nullable
public @Nullable OperationTiff.BlackAndWhiteQualityEnum getBlackAndWhiteQuality()
```
    For \"tif\" exports, this parameter is used to define the quality of black-and-white images if \"group3\" or \"group4\" is used as a compression method. The higher the quality, the more time that will be required in order to render the image: * low = Direct conversion (best reserved for \"text only\" content) * middle = A diffusion filter will be applied to the image before conversion * high = Greyscale conversion and a diffusion filter will be applied to the image before conversion
    
    Returns:
    
    blackAndWhiteQuality
  - setBlackAndWhiteQuality
```
public void setBlackAndWhiteQuality(OperationTiff.BlackAndWhiteQualityEnum blackAndWhiteQuality)
```
  - compression
```
public OperationTiff compression(OperationTiff.CompressionEnum compression)
```
  - getCompression
```
@Nullable
public @Nullable OperationTiff.CompressionEnum getCompression()
```
    This parameter is used to specify the compression method when exporting pages as \"tif\" images. The following values are available: * none = No compression * rle = TIFF CCITT Modified Huffman RLE compression * deflate = TIFF Deflate lossless compression (Zip-in-TIFF). * group3 = TIFF CCITT Group 3 fax encoding * group4 = TIFF CCITT Group 4 fax encoding * jpeg = TIFF JPEG-in-TIFF compression * lzw = TIFF LZW compression * packbits = TIFF Byte-oriented run-length encoding \"PackBits\" compression * zlib = TIFF ZLib compression
    
    Returns:
    
    compression
  - setCompression
```
public void setCompression(OperationTiff.CompressionEnum compression)
```
  - dpi
```
public OperationTiff dpi(Integer dpi)
```
  - getDpi
```
@Nullable
public @Nullable Integer getDpi()
```
    This parameter is used to define the image's DPI resolution. The larger the value, the larger the image's x, y resolution. In addition, the larger the DPI resolution, the larger the size of the image file. minimum: 0 maximum: 9600
    
    Returns:
    
    dpi
  - setDpi
```
public void setDpi(Integer dpi)
```
  - height
```
public OperationTiff height(Integer height)
```
  - getHeight
```
@Nullable
public @Nullable Integer getHeight()
```
    Used to limit the maximum height of the exported image. 0 = No restriction minimum: 0
    
    Returns:
    
    height
  - setHeight
```
public void setHeight(Integer height)
```
  - jpegQuality
```
public OperationTiff jpegQuality(Integer jpegQuality)
```
  - getJpegQuality
```
@Nullable
public @Nullable Integer getJpegQuality()
```
    When exporting to \"jpg\" format, this parameter can be used to define the image's quality as a percentage. The value must fall between 0 and 100. The larger the value, the better the quality and the lower the compression level. minimum: 0 maximum: 100
    
    Returns:
    
    jpegQuality
  - setJpegQuality
```
public void setJpegQuality(Integer jpegQuality)
```
  - metrics
```
public OperationTiff metrics(OperationTiff.MetricsEnum metrics)
```
  - getMetrics
```
@Nullable
public @Nullable OperationTiff.MetricsEnum getMetrics()
```
    Unit for the X-axis/Y-axis position and signature field height and width arguments: * pt = Points(1/72 inch) * pc = Picas(12 points) * px = Pixels(1/96 inch) * mm = Millimeters * in = Inches
    
    Returns:
    
    metrics
  - setMetrics
```
public void setMetrics(OperationTiff.MetricsEnum metrics)
```
  - multipage
```
public OperationTiff multipage(Boolean multipage)
```
  - getMultipage
```
@Nullable
public @Nullable Boolean getMultipage()
```
    If \"true,\" a \"multi-page TIFF\" will be created when multiple pages are exported as \"tif\" images. All the pages will be exported to a single file, and a ZIP file with individual images will not be generated.
    
    Returns:
    
    multipage
  - setMultipage
```
public void setMultipage(Boolean multipage)
```
  - width
```
public OperationTiff width(Integer width)
```
  - getWidth
```
@Nullable
public @Nullable Integer getWidth()
```
    Used to limit the maximum width of the exported image. 0 = No restriction minimum: 0
    
    Returns:
    
    width
  - setWidth
```
public void setWidth(Integer width)
```
  - 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 OperationTiff

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_BLACK_AND_WHITE_QUALITY

JSON_PROPERTY_COMPRESSION

JSON_PROPERTY_DPI

JSON_PROPERTY_HEIGHT

JSON_PROPERTY_JPEG_QUALITY

JSON_PROPERTY_METRICS

JSON_PROPERTY_MULTIPAGE

JSON_PROPERTY_WIDTH

Constructor Detail

OperationTiff

Method Detail

blackAndWhiteQuality

getBlackAndWhiteQuality

setBlackAndWhiteQuality

compression

getCompression

setCompression

dpi

getDpi

setDpi

height

getHeight

setHeight

jpegQuality

getJpegQuality

setJpegQuality

metrics

getMetrics

setMetrics

multipage

getMultipage

setMultipage

width

getWidth

setWidth

equals

hashCode

toString