Package net.webpdf.wsclient.openapi

Class OperationMergeFileData

java.lang.Object

net.webpdf.wsclient.openapi.OperationMergeFileData

public class OperationMergeFileData
extends Object

Contains the BASE64 encoded file that should be inserted or appended. The \"format\" attribute is used to define whether the file is a single PDF document, a ZIP file containing multiple PDF documents or a list of documents references by ID. If a ZIP archive is passed as the source document of the web service request, this parameter can be omitted. The parameter \"sourceIsZip\" must be set to \"true\" in that case.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationMergeFileData.FormatEnum	Specifies the format how to pass the documents to be used for merging
static class	OperationMergeFileData.SourceEnum	Selects the data source for the hereby expressed resource.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_FORMAT
static String	JSON_PROPERTY_OUTLINE_NAME
static String	JSON_PROPERTY_SOURCE
static String	JSON_PROPERTY_URI
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
OperationMergeFileData()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OperationMergeFileData	format(OperationMergeFileData.FormatEnum format)
@Nullable OperationMergeFileData.FormatEnum	getFormat()	Specifies the format how to pass the documents to be used for merging
@Nullable String	getOutlineName()	Used to define the base path that should be used for outline nodes of the appended document.
@Nullable OperationMergeFileData.SourceEnum	getSource()	Selects the data source for the hereby expressed resource.
@Nullable String	getUri()	The uri the data shall be located at.
@org.jetbrains.annotations.Nullable byte[]	getValue()	Get value
int	hashCode()
OperationMergeFileData	outlineName(String outlineName)
void	setFormat(OperationMergeFileData.FormatEnum format)
void	setOutlineName(String outlineName)
void	setSource(OperationMergeFileData.SourceEnum source)
void	setUri(String uri)
void	setValue(byte[] value)
OperationMergeFileData	source(OperationMergeFileData.SourceEnum source)
String	toString()
OperationMergeFileData	uri(String uri)
OperationMergeFileData	value(byte[] value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_FORMAT

public static final String JSON_PROPERTY_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_OUTLINE_NAME

public static final String JSON_PROPERTY_OUTLINE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_SOURCE

public static final String JSON_PROPERTY_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_URI

public static final String JSON_PROPERTY_URI

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

OperationMergeFileData

public OperationMergeFileData()

Method Detail

format

public OperationMergeFileData format(OperationMergeFileData.FormatEnum format)

getFormat

@Nullable
public @Nullable OperationMergeFileData.FormatEnum getFormat()

Specifies the format how to pass the documents to be used for merging. * pdf = A single PDF file * zip = It is a ZIP file that contains one or more PDF documents. * id = It is a semicolon separated list of document ID's referencing documents already on the server (REST API only). **Important:** The \"id\" parameter can be used only with REST API. Each document that has been uploaded to the server via REST API has a unique ID. This ID can be used to reference the document. In the content of the \"data\" element, the list is passed as BASE64 content. Example for two documents: * List of documents: 3bde686a47284a2da3bfce62bd6bb8bd;f5c2b314d0c74fd0878d1f4ca310b0ad * BASE64 encoded: M2JkZTY4NmE0NzI4NGEyZGEzYmZjZTYyYmQ2YmI4YmQ7ZjVjMmIzMTRkMGM3NGZkMDg3OGQxZjRjYTMxMGIwYWQ=

Returns:

format

setFormat

public void setFormat(OperationMergeFileData.FormatEnum format)

outlineName

public OperationMergeFileData outlineName(String outlineName)

getOutlineName

@Nullable
public @Nullable String getOutlineName()

Used to define the base path that should be used for outline nodes of the appended document. This parameter can contain a slash separated path and should ideally end with the name of the document (\"A/B/filename\"). If this parameter is not set, all outlines will be appended to the root outline node.

Returns:

outlineName

setOutlineName

public void setOutlineName(String outlineName)

source

public OperationMergeFileData source(OperationMergeFileData.SourceEnum source)

getSource

@Nullable
public @Nullable OperationMergeFileData.SourceEnum getSource()

Selects the data source for the hereby expressed resource. Possible values are: * value = The element's value shall contain the BASE64 encoded data. * uri = The data shall be located at the given uri.

Returns:

source

setSource

public void setSource(OperationMergeFileData.SourceEnum source)

uri

public OperationMergeFileData uri(String uri)

getUri

@Nullable
public @Nullable String getUri()

The uri the data shall be located at. (This shall only have effect, if the \"source\" is \"uri\".)

Returns:

uri

setUri

public void setUri(String uri)

value

public OperationMergeFileData value(byte[] value)

getValue

@Nullable
public @org.jetbrains.annotations.Nullable byte[] getValue()

Get value

Returns:

value

setValue

public void setValue(byte[] value)

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