io.pdfdata.model

Class Proc

java.lang.Object

io.pdfdata.model.Entity

io.pdfdata.model.ResponseEntity

io.pdfdata.model.Proc

public class Proc
extends ResponseEntity

Entity representing a proc, a process running within the PDFDATA.io API that applies Operations to source PDF Documents to extract content and data from them.

To learn more about procs, please visit their dedicated section in the PDFDATA.io API reference.

See Also:

to start new procs and retrieve the resulting {@code Proc} entities

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Proc.Status

Constructor Summary

Constructors

Constructor and Description
Proc()

Method Summary

Modifier and Type	Method and Description
java.time.Instant	getCreated()
Set	getDocIDs() Returns the set of IDs of Documents included in this proc, only if the proc's status is Proc.Status.PENDING or Proc.Status.REFUSED.
List<ProcessedDocument>	getDocuments() Returns the documents included in this proc (which carry the results of the Operations applied to them by the proc via ProcessedDocument.getResults()), only if the proc's status is Proc.Status.COMPLETE.
String	getID()
List<Operation>	getOperations()
Set	getSourceTags()
Proc.Status	getStatus()

Constructor Detail

Proc

public Proc()

Method Detail

getID

public String getID()

See Also:

ProcsRequest.byID(String)

getCreated

public java.time.Instant getCreated()

getSourceTags

public Set getSourceTags()

getOperations

public List<Operation> getOperations()

getStatus

public Proc.Status getStatus()

getDocIDs

public Set getDocIDs()

Returns the set of IDs of Documents included in this proc, only if the proc's status is Proc.Status.PENDING or Proc.Status.REFUSED. This method will return null or an empty set if this proc has been completed.

getDocuments

public List<ProcessedDocument> getDocuments()

Returns the documents included in this proc (which carry the results of the Operations applied to them by the proc via ProcessedDocument.getResults()), only if the proc's status is Proc.Status.COMPLETE. Otherwise, this method will return null.