A B C D E F G O P S T V W

A

addCharInfo(Boolean) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Boolean to get bounding boxes for characters present in text blocks(paragraphs, list, headings).

addElementsToExtract(List<PDFElementType>) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Add pdf element types for extracting structured information.

addElementsToExtractRenditions(List<PDFElementType>) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Add pdf element types for extracting renditions.

addElementToExtract(PDFElementType) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Adds a pdf element type for extracting structured information.

addElementToExtractRenditions(PDFElementType) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Adds a pdf element type for extracting rendition.

addTableStructureFormat(TableStructureType) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Specifies the format for extracting table data information.

B

build() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

build() - Method in class com.adobe.platform.operation.ClientConfig.Builder

Returns a new ClientConfig instance built from the current state of this builder.

Builder() - Constructor for class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Constructs a Builder instance.

builder() - Static method in class com.adobe.platform.operation.ClientConfig

Creates a new ClientConfig builder.

Builder() - Constructor for class com.adobe.platform.operation.ClientConfig.Builder

Constructs a Builder instance.

C

ClientConfig - Class in com.adobe.platform.operation

Encapsulates the API request configurations

ClientConfig() - Constructor for class com.adobe.platform.operation.ClientConfig

ClientConfig.Builder - Class in com.adobe.platform.operation

Builds a ClientConfig instance.

com.adobe.platform.operation - package com.adobe.platform.operation

Contains the classes and sub-packages for various operations.

com.adobe.platform.operation.auth - package com.adobe.platform.operation.auth

Contains the classes for all types of credentials supported by DC Services SDK.

com.adobe.platform.operation.exception - package com.adobe.platform.operation.exception

Contains the classes for various exceptions that can be thrown by an Operation.

com.adobe.platform.operation.io - package com.adobe.platform.operation.io

Contains the classes for providing input or receiving the output of an Operation.

com.adobe.platform.operation.pdfops - package com.adobe.platform.operation.pdfops

Contains the classes for operations that generate or transform PDF files.

com.adobe.platform.operation.pdfops.constants - package com.adobe.platform.operation.pdfops.constants

create(Credentials) - Static method in class com.adobe.platform.operation.ExecutionContext

Creates a context instance using the provided Credentials.

create(Credentials, ClientConfig) - Static method in class com.adobe.platform.operation.ExecutionContext

Creates a context instance using the provided Credentials and ClientConfig

createFromLocalFile(String, String) - Static method in class com.adobe.platform.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.platform.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.platform.operation.io.FileRef

Creates a FileRef instance from an input stream using the specified media type.

createNew() - Static method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Constructs a ExtractPDFOperation instance.

Credentials - Class in com.adobe.platform.operation.auth

Marker base class for different types of credentials.

Credentials() - Constructor for class com.adobe.platform.operation.auth.Credentials

D

DEFAULT_STATUS_CODE - Variable in exception com.adobe.platform.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.platform.operation.exception.ServiceUsageException

the default value of status code if there is no status code for this service failure.

E

execute(ExecutionContext) - Method in interface com.adobe.platform.operation.Operation

Executes this operation synchronously using the provided context instance.

execute(ExecutionContext) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Zip file.

ExecutionContext - Class in com.adobe.platform.operation

Represents the execution context of an Operation.

ExecutionContext() - Constructor for class com.adobe.platform.operation.ExecutionContext

ExtractPDFOperation - Class in com.adobe.platform.operation.pdfops

An Operation that extracts pdf elements such as text, images, tables in a structured format from a PDF.

F

FileRef - Class in com.adobe.platform.operation.io

This class represents a local file.

FileRef() - Constructor for class com.adobe.platform.operation.io.FileRef

fromFile(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Sets Service Account Credentials using the JSON credentials file path.

fromFile(String) - Method in class com.adobe.platform.operation.ClientConfig.Builder

Sets the connect timeout and socket timeout using the JSON client config file path.

G

getAccountId() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

getClaim() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

getClientId() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

Client Id (API Key)

getClientSecret() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

Client Secret

getImsBaseUri() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

getMessage() - Method in exception com.adobe.platform.operation.exception.ServiceApiException

Returns the detail message of this exception.

getMessage() - Method in exception com.adobe.platform.operation.exception.ServiceUsageException

Returns the detailed message for this exception.

getOrganizationId() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

getPrivateKey() - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials

Content of the Private Key (PEM format)

getRequestTrackingId() - Method in exception com.adobe.platform.operation.exception.ServiceApiException

Returns the Request ID (the value of the X-Request-ID header).

getRequestTrackingId() - Method in exception com.adobe.platform.operation.exception.ServiceUsageException

Returns the Request ID (the value of the X-Request-ID header).

getStatusCode() - Method in exception com.adobe.platform.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.platform.operation.exception.ServiceUsageException

Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn't adequately represent the error.

O

Operation - Interface in com.adobe.platform.operation

This interface represents the basic contract for all the Operations.

P

PDFElementType - Enum in com.adobe.platform.operation.pdfops.constants

Supported PDF Element Types for extraction .

S

saveAs(String) - Method in class com.adobe.platform.operation.io.FileRef

Saves this file to the location specified by targetLocation.

saveAs(OutputStream) - Method in class com.adobe.platform.operation.io.FileRef

Writes the contents of this file to outputStream.

SdkException - Exception in com.adobe.platform.operation.exception

SdkException is typically thrown for client-side or network errors.

SdkException(String, Throwable) - Constructor for exception com.adobe.platform.operation.exception.SdkException

Creates an SdkException with the specified detail message and cause.

SdkException(String) - Constructor for exception com.adobe.platform.operation.exception.SdkException

Constructs an SdkException with the specified detail message.

ServiceAccountCredentials - Class in com.adobe.platform.operation.auth

Service Account credentials allow your application to call DC Services on behalf of the application itself, or on behalf of an enterprise organization.

ServiceAccountCredentials.Builder - Class in com.adobe.platform.operation.auth

Builds a ServiceAccountCredentials instance.

serviceAccountCredentialsBuilder() - Static method in class com.adobe.platform.operation.auth.Credentials

Creates a new ServiceAccountCredentials builder.

ServiceApiException - Exception in com.adobe.platform.operation.exception

ServiceApiException is thrown when an underlying service API call results in an error.

ServiceApiException(String) - Constructor for exception com.adobe.platform.operation.exception.ServiceApiException

Constructs a ServiceApiException with the specified detail message.

ServiceApiException(String, String, int) - Constructor for exception com.adobe.platform.operation.exception.ServiceApiException

Constructs a ServiceApiException with the specified detail message, requestId and returned HTTP status code.

ServiceUsageException - Exception in com.adobe.platform.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.platform.operation.exception.ServiceUsageException

Constructs a ServiceUsageException with the specified detail message.

ServiceUsageException(String, String, int) - Constructor for exception com.adobe.platform.operation.exception.ServiceUsageException

Constructs a ServiceUsageException with the specified detail message, requestId and returned HTTP status code.

setInputFile(FileRef) - Method in class com.adobe.platform.operation.pdfops.ExtractPDFOperation

Sets an input file.

T

TableStructureType - Enum in com.adobe.platform.operation.pdfops.constants

Supported Formats for exporting Table Data

V

valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.constants.PDFElementType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.adobe.platform.operation.pdfops.constants.TableStructureType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.adobe.platform.operation.pdfops.constants.PDFElementType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.adobe.platform.operation.pdfops.constants.TableStructureType

Returns an array containing the constants of this enum type, in the order they are declared.

W

withAccountId(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Set Account Id (format: id@techacct.adobe.com)

withClientId(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Set Client ID (API Key)

withClientSecret(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Set Client Secret

withConnectTimeout(Integer) - Method in class com.adobe.platform.operation.ClientConfig.Builder

Sets the connect timeout.

withOrganizationId(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to DC Services

withPrivateKey(String) - Method in class com.adobe.platform.operation.auth.ServiceAccountCredentials.Builder

Set private key

withSocketTimeout(Integer) - Method in class com.adobe.platform.operation.ClientConfig.Builder

Sets the socket timeout.

A B C D E F G O P S T V W