Skip navigation links
PDF Services SDK
A B C D E F G H I L O P R S T V W 

A

addAll() - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Adds a page range representing all pages.
addAllFrom(int) - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Adds a page range from start page index to the last page.
addCharInfo(Boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Boolean specifying whether to add character level bounding boxes to output json
addElementsToExtract(List<ExtractElementType>) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Adds elements to extract (Text and/or Tables) to the list of elements to be extracted.
addElementsToExtractRenditions(List<ExtractRenditionsElementType>) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Adds elements to extract (Figures and/or Tables) to the list of elements to be extracted.
addElementToExtract(ExtractElementType) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Adds an element to extract (Text or Tables)
addElementToExtractRenditions(ExtractRenditionsElementType) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Adds a rendition to extract (Figures or Tables)
addGetStylingInfo(Boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Boolean specifying whether to add styling information to output json
addInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.CombineFilesOperation
Specifies a PDF file (media type "application/pdf") to be combined with other files.
addInput(FileRef, PageRanges) - Method in class com.adobe.pdfservices.operation.pdfops.CombineFilesOperation
Specifies particular pages of a PDF file (media type "application/pdf") to be combined with other files.
addPagesForReplace(FileRef, int) - Method in class com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation
Adds all the pages of the input PDF file for replacing the page of the base PDF file.
addPagesForReplace(FileRef, PageRanges, int) - Method in class com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation
Adds the specified pages of the input PDF file for replacing the page of the base PDF file.
addPagesToInsertAt(FileRef, int) - Method in class com.adobe.pdfservices.operation.pdfops.InsertPagesOperation
Adds all the pages of the input PDF file to be inserted at the specified page of the base PDF file.
addPagesToInsertAt(FileRef, PageRanges, int) - Method in class com.adobe.pdfservices.operation.pdfops.InsertPagesOperation
Adds the specified pages of the input PDF file to be inserted at the specified page of the base PDF file
addPermission(Permission) - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.Permissions
Adds a document Permission in the permissions set.
addRange(int, int) - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Adds a page range.
addSinglePage(int) - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Adds a single page.
addTableStructureFormat(TableStructureType) - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
Adds the Table Structure format (Csv or Xlsx) for table renditions
Angle - Enum in com.adobe.pdfservices.operation.pdfops.options.rotatepages
Supported rotation angle values for RotatePagesOperation

B

build() - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Returns a new ServiceAccountCredentials instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.ClientConfig.Builder
Returns a new ClientConfig instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressPDFOptions.Builder
Returns a new CompressPDFOptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Returns a new CreatePDFFromHTMLOptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.CreatePDFFromExcelOptions.Builder
Returns a new CreatePDFFromExcelOptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.CreatePDFFromPPTOptions.Builder
Returns a new CreatePDFFromPPTOptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.word.CreatePDFFromWordOptions.Builder
Returns a new CreatePDFFromWordOptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions.Builder
 
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions.Builder
Returns a new OCROptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.pdfproperties.PDFPropertiesOptions.Builder
Returns a new PDFPropertiesOptions instance built from the current state of this builder.
build() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Returns a new PasswordProtectOptions instance built from the current state of this builder.
Builder() - Constructor for class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Constructs a Builder instance.
builder() - Static method in class com.adobe.pdfservices.operation.ClientConfig
Creates a new ClientConfig builder.
Builder() - Constructor for class com.adobe.pdfservices.operation.ClientConfig.Builder
Constructs a Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressPDFOptions.Builder
Constructs a CompressPDFOptions.Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Constructs a Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.CreatePDFFromExcelOptions.Builder
Constructs a CreatePDFFromExcelOptions.Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.CreatePDFFromPPTOptions.Builder
Constructs a CreatePDFFromPPTOptions.Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.createpdf.word.CreatePDFFromWordOptions.Builder
Constructs a CreatePDFFromWordOptions.Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions.Builder
Constructs a OCROptions.Builder instance.
Builder() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Constructs a Builder instance.

C

ClientConfig - Class in com.adobe.pdfservices.operation
Encapsulates the API request configurations
ClientConfig() - Constructor for class com.adobe.pdfservices.operation.ClientConfig
 
ClientConfig.Builder - Class in com.adobe.pdfservices.operation
Builds a ClientConfig instance.
com.adobe.pdfservices.operation - package com.adobe.pdfservices.operation
Contains the classes and sub-packages for various operations.
com.adobe.pdfservices.operation.auth - package com.adobe.pdfservices.operation.auth
Contains the classes for all types of credentials supported by PDF Services API.
com.adobe.pdfservices.operation.exception - package com.adobe.pdfservices.operation.exception
Contains the classes for various exceptions that can be thrown by an Operation.
com.adobe.pdfservices.operation.io - package com.adobe.pdfservices.operation.io
Contains the classes for providing input or receiving the output of an Operation.
com.adobe.pdfservices.operation.pdfops - package com.adobe.pdfservices.operation.pdfops
Contains the classes for operations that generate or transform PDF files.
com.adobe.pdfservices.operation.pdfops.options - package com.adobe.pdfservices.operation.pdfops.options
Contains the option classes and sub-packages for Operation implementations in the com.adobe.pdfservices.operation.pdfops package.
com.adobe.pdfservices.operation.pdfops.options.compresspdf - package com.adobe.pdfservices.operation.pdfops.options.compresspdf
Contains the option classes for CompressPDFOperation.
com.adobe.pdfservices.operation.pdfops.options.createpdf - package com.adobe.pdfservices.operation.pdfops.options.createpdf
Contains the option classes for CreatePDFOperation.
com.adobe.pdfservices.operation.pdfops.options.createpdf.excel - package com.adobe.pdfservices.operation.pdfops.options.createpdf.excel
 
com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt - package com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt
 
com.adobe.pdfservices.operation.pdfops.options.createpdf.word - package com.adobe.pdfservices.operation.pdfops.options.createpdf.word
 
com.adobe.pdfservices.operation.pdfops.options.documentmerge - package com.adobe.pdfservices.operation.pdfops.options.documentmerge
Contains the option classes for DocumentMergeOperation.
com.adobe.pdfservices.operation.pdfops.options.exportpdf - package com.adobe.pdfservices.operation.pdfops.options.exportpdf
Contains the option classes for ExportPDFOperation.
com.adobe.pdfservices.operation.pdfops.options.exportpdftoimages - package com.adobe.pdfservices.operation.pdfops.options.exportpdftoimages
Contains the option classes for ExportPDFToImagesOperation.
com.adobe.pdfservices.operation.pdfops.options.extractpdf - package com.adobe.pdfservices.operation.pdfops.options.extractpdf
Contains the option classes for ExtractPDFOperation.
com.adobe.pdfservices.operation.pdfops.options.ocr - package com.adobe.pdfservices.operation.pdfops.options.ocr
Contains the option classes for OCROperation.
com.adobe.pdfservices.operation.pdfops.options.pdfproperties - package com.adobe.pdfservices.operation.pdfops.options.pdfproperties
Contains the option classes for PDFPropertiesOperation.
com.adobe.pdfservices.operation.pdfops.options.protectpdf - package com.adobe.pdfservices.operation.pdfops.options.protectpdf
Contains the option classes for ProtectPDFOperation.
com.adobe.pdfservices.operation.pdfops.options.rotatepages - package com.adobe.pdfservices.operation.pdfops.options.rotatepages
Contains the option classes for RotatePagesOperation.
CombineFilesOperation - Class in com.adobe.pdfservices.operation.pdfops
Combines multiple PDF files into a single PDF file.
CombineFilesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for CombineFilesOperation.
CompressionLevel - Enum in com.adobe.pdfservices.operation.pdfops.options.compresspdf
Supported compression levels for CompressPDFOperation
CompressPDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that reduces the size of a PDF file.
CompressPDFOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for CompressPDFOperation.
CompressPDFOptions - Class in com.adobe.pdfservices.operation.pdfops.options.compresspdf
Parameters for reducing file size of a pdf using CompressPDFOperation.
CompressPDFOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.compresspdf
Builds a CompressPDFOptions instance.
compressPDFOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressPDFOptions
Creates a new CompressPDFOptions builder.
ContentEncryption - Enum in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Supported types of content to encrypt for ProtectPDFOperation
create(Credentials) - Static method in class com.adobe.pdfservices.operation.ExecutionContext
Creates a context instance using the provided Credentials.
create(Credentials, ClientConfig) - Static method in class com.adobe.pdfservices.operation.ExecutionContext
Creates a context instance using the provided Credentials and ClientConfig
createFromLocalFile(String, String) - Static method in class com.adobe.pdfservices.operation.io.FileRef
Creates a FileRef instance from a local file path with an explicitly specified media type.
createFromLocalFile(String) - Static method in class com.adobe.pdfservices.operation.io.FileRef
Creates a FileRef instance from a local file path where the media type can be inferred from the file extension.
createFromStream(InputStream, String) - Static method in class com.adobe.pdfservices.operation.io.FileRef
Creates a FileRef instance from an input stream using the specified media type.
createFromURL(URL) - Static method in class com.adobe.pdfservices.operation.io.FileRef
Creates a FileRef instance from the input URL.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.CombineFilesOperation
Constructs a CombineFilesOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.CompressPDFOperation
Constructs a CompressPDFOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.CreatePDFOperation
Constructs a CreatePDFOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.DeletePagesOperation
Constructs a DeletePagesOperation instance.
createNew(DocumentMergeOptions) - Static method in class com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation
Constructs a DocumentMergeOperation instance.
createNew(ExportPDFTargetFormat) - Static method in class com.adobe.pdfservices.operation.pdfops.ExportPDFOperation
Constructs a ExportPDFOperation instance.
createNew(ExportPDFToImagesTargetFormat) - Static method in class com.adobe.pdfservices.operation.pdfops.ExportPDFToImagesOperation
Constructs a ExportPDFToImagesOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.ExtractPDFOperation
Constructs a ExtractPDFOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.InsertPagesOperation
Constructs a InsertPagesOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.LinearizePDFOperation
Constructs a LinearizePDFOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.OCROperation
Constructs a OCROperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.Permissions
Creates a new Permissions instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.PDFPropertiesOperation
Constructs a PDFPropertiesOperation instance.
createNew(ProtectPDFOptions) - Static method in class com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation
Constructs a ProtectPDFOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation
Constructs a RemoveProtectionOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation
Constructs a ReorderPagesOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation
Constructs a ReplacePagesOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.RotatePagesOperation
Constructs a RotatePagesOperation instance.
createNew() - Static method in class com.adobe.pdfservices.operation.pdfops.SplitPDFOperation
Constructs a SplitPDFOperation instance.
CreatePDFFromExcelOptions - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf.excel
 
CreatePDFFromExcelOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf.excel
 
CreatePDFFromHTMLOptions - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf
Parameters for converting HTML to PDF using CreatePDFOperation.
CreatePDFFromHTMLOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf
Builds a CreatePDFFromHTMLOptions instance.
CreatePDFFromPPTOptions - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt
 
CreatePDFFromPPTOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt
 
CreatePDFFromWordOptions - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf.word
 
CreatePDFFromWordOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf.word
 
CreatePDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that converts a non-PDF file to a PDF file.
CreatePDFOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for CreatePDFOperation.
CreatePDFOptions - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf
Marker base class for CreatePDFOperation options.
Credentials - Class in com.adobe.pdfservices.operation.auth
Marker base class for different types of credentials.

D

DEFAULT_ERROR_CODE - Variable in exception com.adobe.pdfservices.operation.exception.ServiceApiException
the default value of error code if there is no error code for this service failure.
DEFAULT_ERROR_CODE - Variable in exception com.adobe.pdfservices.operation.exception.ServiceUsageException
the default value of error code if there is no error code for this service failure.
DEFAULT_STATUS_CODE - Variable in exception com.adobe.pdfservices.operation.exception.ServiceApiException
the default value of status code if there is no status code for this service failure.
DEFAULT_STATUS_CODE - Variable in exception com.adobe.pdfservices.operation.exception.ServiceUsageException
the default value of status code if there is no status code for this service failure.
DeletePagesOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation to delete pages in a PDF file.
DeletePagesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for DeletePagesOperation.
DocumentMergeOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that enables the clients to produce high fidelity PDF and Word documents with dynamic data inputs.
DocumentMergeOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for DocumentMergeOperation.
DocumentMergeOptions - Class in com.adobe.pdfservices.operation.pdfops.options.documentmerge
Parameters for specifying the input JSON data and the desired output format for DocumentMergeOperation.
DocumentMergeOptions(JSONObject, OutputFormat) - Constructor for class com.adobe.pdfservices.operation.pdfops.options.documentmerge.DocumentMergeOptions
Creates a new DocumentMergeOptions instance

E

EncryptionAlgorithm - Enum in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Supported encryption algorithms for ProtectPDFOperation
excelOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFOptions
Creates a new CreatePDFFromExcelOptions builder.
execute(ExecutionContext) - Method in interface com.adobe.pdfservices.operation.Operation
Executes this operation synchronously using the provided context instance.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.CombineFilesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.CompressPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.CreatePDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.DeletePagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Merged file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.ExportPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.ExportPDFToImagesOperation
Executes this operation synchronously using the supplied context and returns a new list of FileRef instances for the resultant image files.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.ExtractPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Zip file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.InsertPagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.LinearizePDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.OCROperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.PDFPropertiesOperation
Executes this operation synchronously using the supplied context and returns a new JSONObject instance for the resulting JSON object.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.RotatePagesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting PDF file.
execute(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.SplitPDFOperation
Executes this operation synchronously using the supplied context and returns a new list of FileRef instances for the resultant PDF files.
executeAndReturnFileRef(ExecutionContext) - Method in class com.adobe.pdfservices.operation.pdfops.PDFPropertiesOperation
Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting JSON file.
ExecutionContext - Class in com.adobe.pdfservices.operation
Represents the execution context of an Operation.
ExportPDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation which exports a source PDF file to a supported format specified by ExportPDFTargetFormat.
ExportPDFOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for ExportPDFOperation.
ExportPDFTargetFormat - Enum in com.adobe.pdfservices.operation.pdfops.options.exportpdf
Supported target formats for ExportPDFOperation
ExportPDFToImagesOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation which exports a source PDF file to a supported format specified by ExportPDFToImagesTargetFormat.
ExportPDFToImagesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for ExportPDFToImagesOperation.
ExportPDFToImagesTargetFormat - Enum in com.adobe.pdfservices.operation.pdfops.options.exportpdftoimages
Supported target formats for ExportPDFToImagesOperation
ExtractElementType - Enum in com.adobe.pdfservices.operation.pdfops.options.extractpdf
Supported inputs for Elements to Extract ExtractPDFOperation
ExtractPDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An Operation that extracts pdf elements such as text, images, tables in a structured format from a PDF.
ExtractPDFOptions - Class in com.adobe.pdfservices.operation.pdfops.options.extractpdf
Parameters for extract PDF operation using ExtractPDFOperation.
ExtractPDFOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.extractpdf
Static Builder class for Extract PDF Options
extractPdfOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions
Creates a new ExtractPDFOptions builder.
ExtractRenditionsElementType - Enum in com.adobe.pdfservices.operation.pdfops.options.extractpdf
Supported inputs for Renditions To Extract ExtractPDFOperation

F

FileRef - Class in com.adobe.pdfservices.operation.io
This class represents a local file.
fromFile(String) - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Sets Service Account Credentials using the JSON credentials file path.
fromFile(String) - Method in class com.adobe.pdfservices.operation.ClientConfig.Builder
Sets the connect timeout and socket timeout using the JSON client config file path.

G

getAccountId() - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials
Account ID(format: id@techacct.adobe.com)
getAddCharInfo() - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions
Returns whether character level information was invoked for operation.
getClientId() - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials
Client Id (API Key)
getClientSecret() - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials
Client Secret
getCompressionLevel() - Method in enum com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressionLevel
Returns the string representation of this CompressionLevel
getCompressionLevel() - Method in class com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressPDFOptions
Determines the compression level (CompressionLevel) to be used for Compress PDF
getContentEncryption() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended type of content to encrypt for the resulting encrypted PDF file.
getCreateTaggedPDF() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.CreatePDFFromExcelOptions
 
getCreateTaggedPDF() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.CreatePDFFromPPTOptions
 
getCreateTaggedPDF() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.word.CreatePDFFromWordOptions
 
getDataToMerge() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions
Returns JSON data that will be used to manipulate HTML DOM before it is converted into PDF file.
getDocumentLanguage() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.CreatePDFFromExcelOptions
 
getDocumentLanguage() - Method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.SupportedDocumentLanguage
Returns the language code of this SupportedDocumentLanguage
getDocumentLanguage() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.CreatePDFFromPPTOptions
 
getDocumentLanguage() - Method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.SupportedDocumentLanguage
Returns the language code of this SupportedDocumentLanguage
getDocumentLanguage() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.word.CreatePDFFromWordOptions
 
getDocumentLanguage() - Method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.word.SupportedDocumentLanguage
Returns the language code of this SupportedDocumentLanguage
getElementsToExtract() - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions
Returns the list of elements (Text and/or Tables) invoked for operation
getElementsToExtractRenditions() - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions
Returns the list of renditions (Tables and/or Figures) invoked for operation
getEncryptionAlgorithm() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended encryption algorithm of the resulting encrypted PDF file.
getErrorCode() - Method in exception com.adobe.pdfservices.operation.exception.ServiceApiException
Returns the Error code or DEFAULT_ERROR_CODE if the error code doesn't adequately represent the error.
getErrorCode() - Method in exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Returns the Error code or DEFAULT_ERROR_CODE if the error code doesn't adequately represent the error.
getFileExt() - Method in enum com.adobe.pdfservices.operation.pdfops.options.exportpdf.ExportPDFTargetFormat
Returns the file extension of this format
getFileExt() - Method in enum com.adobe.pdfservices.operation.pdfops.options.exportpdftoimages.ExportPDFToImagesTargetFormat
Returns the file extension of this format
getFormat() - Method in enum com.adobe.pdfservices.operation.pdfops.options.documentmerge.OutputFormat
Returns the string representation of this outputformat
getJsonDataForMerge() - Method in class com.adobe.pdfservices.operation.pdfops.options.documentmerge.DocumentMergeOptions
Represents the input datasource for the document merge process as a JSON Object
getLocale() - Method in enum com.adobe.pdfservices.operation.pdfops.options.ocr.OCRSupportedLocale
Returns the language code of this OCRSupportedLocale
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.CombineFilesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.CompressPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.CreatePDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.DeletePagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.ExportPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.ExportPDFToImagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.InsertPagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.LinearizePDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.OCROperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.RotatePagesOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMediaType() - Method in enum com.adobe.pdfservices.operation.pdfops.SplitPDFOperation.SupportedSourceFormat
Returns the corresponding media type for this format, intended to be used for mediaType parameter in FileRef methods.
getMessage() - Method in exception com.adobe.pdfservices.operation.exception.ServiceApiException
Returns the detail message of this exception.
getMessage() - Method in exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Returns the detailed message for this exception.
getOCRLocale() - Method in class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions
Determines the input language (OCRSupportedLocale) to be used for OCR
getOCRType() - Method in class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions
Determines OCR Type.
getOrganizationId() - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials
Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Services API.
getOutputFormat() - Method in class com.adobe.pdfservices.operation.pdfops.options.documentmerge.DocumentMergeOptions
Returns the intended target format of the generated output document.
getOwnerPassword() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended owner password of the resulting encrypted PDF file.
getPageHeight() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.PageLayout
Returns the page height in inches.
getPageLayout() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions
Returns the intended page layout of the resulting PDF file.
getPageWidth() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.PageLayout
Returns the page width in inches.
getPermissions() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended document permissions for the resulting encrypted PDF file.
getPrivateKey() - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials
Content of the Private Key (PEM format)
getRanges() - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.
getRequestTrackingId() - Method in exception com.adobe.pdfservices.operation.exception.ServiceApiException
Returns the Request ID (the value of the X-Request-ID header).
getRequestTrackingId() - Method in exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Returns the Request ID (the value of the X-Request-ID header).
getStatusCode() - Method in exception com.adobe.pdfservices.operation.exception.ServiceApiException
Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.
getStatusCode() - Method in exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.
getStylingInfo() - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions
Returns whether styling information was invoked for operation.
getTableStructureType() - Method in class com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractPDFOptions
Returns the table structure type of the resulting rendition
getType() - Method in enum com.adobe.pdfservices.operation.pdfops.options.ocr.OCRSupportedType
Returns the string representation of this OCRSupportedType
getUserPassword() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions
Returns the intended user password of the resulting encrypted PDF file.
getValue() - Method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.ContentEncryption
Returns the value of the type of content to encrypt
getValue() - Method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.EncryptionAlgorithm
Returns the value of this encryption algorithm
getValue() - Method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.Permission
Returns the value of this permission
getValue() - Method in enum com.adobe.pdfservices.operation.pdfops.options.rotatepages.Angle
Returns the value of this angle
getValues() - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.Permissions
Returns the intended set of document permissions values.

H

htmlOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFOptions
Creates a new CreatePDFFromHTMLOptions builder.

I

includeHeaderFooter(boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Sets the includeHeaderFooter parameter.
includePageLevelProperties(boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.pdfproperties.PDFPropertiesOptions.Builder
Sets the includePageLevelProperties parameter.
includePageLevelProperties() - Method in class com.adobe.pdfservices.operation.pdfops.options.pdfproperties.PDFPropertiesOptions
Returns true if page level properties are set to be included in the resulting PDF properties.
includesHeaderFooter() - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions
Returns true if default header and footer will be included in the resulting PDF file.
InsertPagesOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that can be used to insert pages of multiple PDF files into a base PDF file.
InsertPagesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for InsertPagesOperation.
isEmpty() - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.

L

LinearizePDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that converts a PDF file into a linearized (also known as "web optimized") PDF file.
LinearizePDFOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for LinearizePDFOperation.

O

OCROperation - Class in com.adobe.pdfservices.operation.pdfops
Convert a PDF file into a searchable PDF file.
OCROperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for OCROperation.
OCROptions - Class in com.adobe.pdfservices.operation.pdfops.options.ocr
Parameters for converting PDF to a searchable PDF using OCROperation.
OCROptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.ocr
Builds a OCROptions instance.
ocrOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions
Creates a new OCROptions builder.
OCRSupportedLocale - Enum in com.adobe.pdfservices.operation.pdfops.options.ocr
Supported locales for OCROperation
OCRSupportedType - Enum in com.adobe.pdfservices.operation.pdfops.options.ocr
Supported OCR types for OCROperation
Operation - Interface in com.adobe.pdfservices.operation
This interface represents the basic contract for all the Operations.
OutputFormat - Enum in com.adobe.pdfservices.operation.pdfops.options.documentmerge
Supported output formats for DocumentMergeOperation

P

PageLayout - Class in com.adobe.pdfservices.operation.pdfops.options.createpdf
Class for specifying the layout of a page.
PageLayout() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.createpdf.PageLayout
Constructor to initialize a default page layout.
PageRanges - Class in com.adobe.pdfservices.operation.pdfops.options
Page ranges of a file, inclusive of start and end page index, where page index starts from 1.
PageRanges() - Constructor for class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Constructs a new PageRanges instance with no pages added.
PasswordProtectOptions - Class in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Parameters for securing PDF file with passwords and document permissions using ProtectPDFOperation.
PasswordProtectOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Builds a PasswordProtectOptions instance.
passwordProtectOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.ProtectPDFOptions
Creates a new PasswordProtectOptions builder.
PDFPropertiesOperation - Class in com.adobe.pdfservices.operation.pdfops
An Operation that is used to fetch properties from an input PDF file.
PDFPropertiesOptions - Class in com.adobe.pdfservices.operation.pdfops.options.pdfproperties
Parameters for getting properties of a PDF using PDFPropertiesOperation.
PDFPropertiesOptions.Builder - Class in com.adobe.pdfservices.operation.pdfops.options.pdfproperties
Builds a PDFPropertiesOptions instance.
PDFPropertiesOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.pdfproperties.PDFPropertiesOptions
Creates a new PDFPropertiesOptions builder.
Permission - Enum in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Supported document permission types for ProtectPDFOperation
Permissions - Class in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Document Permissions for ProtectPDFOperation
pptOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFOptions
Creates a new CreatePDFFromPPTOptions builder.
ProtectPDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that is used for securing PDF document with password(s).
ProtectPDFOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for ProtectPDFOperation.
ProtectPDFOptions - Class in com.adobe.pdfservices.operation.pdfops.options.protectpdf
Marker base class for ProtectPDFOperation options.

R

RemoveProtectionOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that allows to remove password security from a PDF document.
RemoveProtectionOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for RemoveProtectionOperation.
ReorderPagesOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that allows to rearrange pages in a PDF file according to the specified order.
ReorderPagesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for ReorderPagesOperation.
ReplacePagesOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that allows specific pages in a PDF file to be replaced with pages from multiple PDF files.
ReplacePagesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for ReplacePagesOperation.
RotatePagesOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that allows rotation of specific pages in a PDF file.
RotatePagesOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for RotatePagesOperation.

S

saveAs(String) - Method in class com.adobe.pdfservices.operation.io.FileRef
Saves this file to the location specified by targetLocation.
saveAs(OutputStream) - Method in class com.adobe.pdfservices.operation.io.FileRef
Writes the contents of this file to outputStream.
SdkException - Exception in com.adobe.pdfservices.operation.exception
SdkException is typically thrown for client-side or network errors.
SdkException(String, Throwable) - Constructor for exception com.adobe.pdfservices.operation.exception.SdkException
Creates an SdkException with the specified detail message and cause.
SdkException(String) - Constructor for exception com.adobe.pdfservices.operation.exception.SdkException
Constructs an SdkException with the specified detail message.
ServiceAccountCredentials - Class in com.adobe.pdfservices.operation.auth
Service Account credentials allow your application to call PDF Services API on behalf of the application itself, or on behalf of an enterprise organization.
ServiceAccountCredentials.Builder - Class in com.adobe.pdfservices.operation.auth
Builds a ServiceAccountCredentials instance.
serviceAccountCredentialsBuilder() - Static method in class com.adobe.pdfservices.operation.auth.Credentials
Creates a new ServiceAccountCredentials builder.
ServiceApiException - Exception in com.adobe.pdfservices.operation.exception
ServiceApiException is thrown when an underlying service API call results in an error.
ServiceApiException(String) - Constructor for exception com.adobe.pdfservices.operation.exception.ServiceApiException
Constructs a ServiceApiException with the specified detail message.
ServiceApiException(String, String, int) - Constructor for exception com.adobe.pdfservices.operation.exception.ServiceApiException
Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.
ServiceApiException(String, String, int, String) - Constructor for exception com.adobe.pdfservices.operation.exception.ServiceApiException
Constructs a ServiceApiException with the specified detail message, requestId, returned HTTP status code and error code.
ServiceUsageException - Exception in com.adobe.pdfservices.operation.exception
ServiceUsageException is thrown when either Service usage limit has been reached or credentials quota has been exhausted.
ServiceUsageException(String) - Constructor for exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Constructs a ServiceUsageException with the specified detail message.
ServiceUsageException(String, String, int) - Constructor for exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Constructs a ServiceUsageException with the specified detail message, requestId and returned HTTP status code.
ServiceUsageException(String, String, int, String) - Constructor for exception com.adobe.pdfservices.operation.exception.ServiceUsageException
Constructs a ServiceUsageException with the specified detail message, requestId, returned HTTP status code and error code.
setAngleToRotatePagesBy(Angle) - Method in class com.adobe.pdfservices.operation.pdfops.RotatePagesOperation
Sets angle (in clockwise direction) for rotating all the pages of the input PDF file.
setAngleToRotatePagesBy(Angle, PageRanges) - Method in class com.adobe.pdfservices.operation.pdfops.RotatePagesOperation
Sets angle (in clockwise direction) for rotating the specified pages of the input PDF file; can be invoked multiple times to set rotation for different set of page ranges.
setBaseInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.InsertPagesOperation
Sets the base input file.
setBaseInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation
Sets the base input file.
setContentEncryption(ContentEncryption) - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended type of content to encrypt in the PDF file.
setEncryptionAlgorithm(EncryptionAlgorithm) - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended encryption algorithm required for encrypting the PDF file.
setFileCount(int) - Method in class com.adobe.pdfservices.operation.pdfops.SplitPDFOperation
Sets the number of documents to split the input PDF.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.CompressPDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.CreatePDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.DeletePagesOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation
Sets the input MS Word based document template
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.ExportPDFOperation
Sets an input PDF file (media type "application/pdf").
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.ExportPDFToImagesOperation
Sets an input PDF file (media type "application/pdf").
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.LinearizePDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.OCROperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.RotatePagesOperation
Sets an input file.
setInput(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.SplitPDFOperation
Sets an input file.
setInputFile(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.ExtractPDFOperation
Sets an input file.
setInputFile(FileRef) - Method in class com.adobe.pdfservices.operation.pdfops.PDFPropertiesOperation
Sets an input file.
setOptions(CompressPDFOptions) - Method in class com.adobe.pdfservices.operation.pdfops.CompressPDFOperation
Sets the options for this operation.
setOptions(CreatePDFOptions) - Method in class com.adobe.pdfservices.operation.pdfops.CreatePDFOperation
Sets the conversion parameters for this operation.
setOptions(ExtractPDFOptions) - Method in class com.adobe.pdfservices.operation.pdfops.ExtractPDFOperation
Sets the options for this operation.
setOptions(OCROptions) - Method in class com.adobe.pdfservices.operation.pdfops.OCROperation
Sets the options for this operation.
setOptions(PDFPropertiesOptions) - Method in class com.adobe.pdfservices.operation.pdfops.PDFPropertiesOperation
Sets the options for this operation.
setOwnerPassword(String) - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended owner password required to control access permissions in the encrypted PDF file.
setPageCount(int) - Method in class com.adobe.pdfservices.operation.pdfops.SplitPDFOperation
Sets the maximum number of pages each of the output files can have.
setPageRanges(PageRanges) - Method in class com.adobe.pdfservices.operation.pdfops.DeletePagesOperation
Specifies the pages to delete from the input PDF file
setPageRanges(PageRanges) - Method in class com.adobe.pdfservices.operation.pdfops.SplitPDFOperation
Sets the page ranges on the basis of which to split the input PDF file.
setPageSize(double, double) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.PageLayout
Sets a custom page size.
setPagesOrder(PageRanges) - Method in class com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation
Sets the order of the pages.
setPassword(String) - Method in class com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation
Specifies the intended password depending on the type of password security attached to the input PDF document.
setPermissions(Permissions) - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended permissions for the encrypted PDF file.
setUserPassword(String) - Method in class com.adobe.pdfservices.operation.pdfops.options.protectpdf.PasswordProtectOptions.Builder
Sets the intended user password required for opening the encrypted PDF file.
SplitPDFOperation - Class in com.adobe.pdfservices.operation.pdfops
An operation that splits PDF document into multiple smaller documents by simply specifying either the number of files, pages per file, or page ranges.
SplitPDFOperation.SupportedSourceFormat - Enum in com.adobe.pdfservices.operation.pdfops
Supported source file formats for SplitPDFOperation.
SupportedDocumentLanguage - Enum in com.adobe.pdfservices.operation.pdfops.options.createpdf.excel
Supported locales for CreatePDFOperation
SupportedDocumentLanguage - Enum in com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt
Supported locales for CreatePDFOperation
SupportedDocumentLanguage - Enum in com.adobe.pdfservices.operation.pdfops.options.createpdf.word
Supported locales for CreatePDFOperation

T

TableStructureType - Enum in com.adobe.pdfservices.operation.pdfops.options.extractpdf
Supported Formats for exporting Table Data ExtractPDFOperation
toString() - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.

V

validate() - Method in class com.adobe.pdfservices.operation.pdfops.options.PageRanges
Used internally by this SDK, not intended to be called by clients.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.CombineFilesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.CompressPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.CreatePDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.DeletePagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.ExportPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.ExportPDFToImagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.InsertPagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.LinearizePDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.OCROperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressionLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.SupportedDocumentLanguage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.SupportedDocumentLanguage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.word.SupportedDocumentLanguage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.documentmerge.OutputFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.exportpdf.ExportPDFTargetFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.exportpdftoimages.ExportPDFToImagesTargetFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractElementType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractRenditionsElementType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.extractpdf.TableStructureType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.ocr.OCRSupportedLocale
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.ocr.OCRSupportedType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.ContentEncryption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.EncryptionAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.Permission
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.options.rotatepages.Angle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.RotatePagesOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.adobe.pdfservices.operation.pdfops.SplitPDFOperation.SupportedSourceFormat
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.CombineFilesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.CompressPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.CreatePDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.DeletePagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.ExportPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.ExportPDFToImagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.InsertPagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.LinearizePDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.OCROperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressionLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.SupportedDocumentLanguage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.SupportedDocumentLanguage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.createpdf.word.SupportedDocumentLanguage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.documentmerge.OutputFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.exportpdf.ExportPDFTargetFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.exportpdftoimages.ExportPDFToImagesTargetFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractElementType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.extractpdf.ExtractRenditionsElementType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.extractpdf.TableStructureType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.ocr.OCRSupportedLocale
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.ocr.OCRSupportedType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.ContentEncryption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.EncryptionAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.protectpdf.Permission
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.options.rotatepages.Angle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.ProtectPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.RemoveProtectionOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.ReorderPagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.ReplacePagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.RotatePagesOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.adobe.pdfservices.operation.pdfops.SplitPDFOperation.SupportedSourceFormat
Returns an array containing the constants of this enum type, in the order they are declared.

W

withAccountId(String) - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Set Account Id (format: id@techacct.adobe.com)
withClientId(String) - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Set Client ID (API Key)
withClientSecret(String) - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Set Client Secret
withCompressionLevel(CompressionLevel) - Method in class com.adobe.pdfservices.operation.pdfops.options.compresspdf.CompressPDFOptions.Builder
Sets compression level to be used for Compress PDF, specified by CompressionLevel.
withConnectTimeout(Integer) - Method in class com.adobe.pdfservices.operation.ClientConfig.Builder
Sets the connect timeout.
withCreateTaggedPdf(Boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.CreatePDFFromExcelOptions.Builder
 
withCreateTaggedPdf(Boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.CreatePDFFromPPTOptions.Builder
 
withCreateTaggedPdf(Boolean) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.word.CreatePDFFromWordOptions.Builder
 
withDataToMerge(JSONObject) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Sets the data to be used by the javascript in the source html file to manipulate the HTML DOM before it gets converted to PDF.
withDocumentLanguage(SupportedDocumentLanguage) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.excel.CreatePDFFromExcelOptions.Builder
Sets office preferred editing language to be used for conversion, specified by SupportedDocumentLanguage.
withDocumentLanguage(SupportedDocumentLanguage) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.ppt.CreatePDFFromPPTOptions.Builder
Sets office preferred editing language to be used for conversion, specified by SupportedDocumentLanguage.
withDocumentLanguage(SupportedDocumentLanguage) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.word.CreatePDFFromWordOptions.Builder
Sets office preferred editing language to be used for conversion, specified by SupportedDocumentLanguage.
withOCRLocale(OCRSupportedLocale) - Method in class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions.Builder
Sets input language to be used for OCR, specified by OCRSupportedLocale.
withOCRType(OCRSupportedType) - Method in class com.adobe.pdfservices.operation.pdfops.options.ocr.OCROptions.Builder
Sets OCR type, specified by OCRSupportedType
withOrganizationId(String) - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Services API
withPageLayout(PageLayout) - Method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFFromHTMLOptions.Builder
Sets the pageLayout parameter.
withPrivateKey(String) - Method in class com.adobe.pdfservices.operation.auth.ServiceAccountCredentials.Builder
Set private key
withSocketTimeout(Integer) - Method in class com.adobe.pdfservices.operation.ClientConfig.Builder
Sets the socket timeout.
wordOptionsBuilder() - Static method in class com.adobe.pdfservices.operation.pdfops.options.createpdf.CreatePDFOptions
Creates a new CreatePDFFromWordOptions builder.
A B C D E F G H I L O P R S T V W 
Skip navigation links
PDF Services SDK

Copyright © 2021 Adobe. All rights reserved.