adobe.pdfservices.operation.internal package

Subpackages

• adobe.pdfservices.operation.internal.api package
  • Subpackages
    • adobe.pdfservices.operation.internal.api.dto package
      • Subpackages
      • Module contents
  • Submodules
  • adobe.pdfservices.operation.internal.api.pdf_services_api module
    • PDFServicesAPI
      • PDFServicesAPI.POLLING_TIMEOUT_STATUS_CODE
      • PDFServicesAPI.assets
      • PDFServicesAPI.delete_asset()
      • PDFServicesAPI.get_response()
      • PDFServicesAPI.handle_error_response()
      • PDFServicesAPI.operation
      • PDFServicesAPI.status_poll()
      • PDFServicesAPI.submit_job()
  • adobe.pdfservices.operation.internal.api.storage_api module
    • StorageApi
      • StorageApi.assets
      • StorageApi.get_download_uri()
      • StorageApi.get_upload_uri()
      • StorageApi.handle_error_response()
      • StorageApi.upload_to_cloud()
  • Module contents
• adobe.pdfservices.operation.internal.auth package
  • Submodules
  • adobe.pdfservices.operation.internal.auth.auth_factory module
    • AuthenticatorFactory
      • AuthenticatorFactory.get_authenticator()
  • adobe.pdfservices.operation.internal.auth.authenticator module
    • Authenticator
      • Authenticator.get_api_key()
      • Authenticator.refresh_token()
      • Authenticator.session_token()
  • adobe.pdfservices.operation.internal.auth.service_principal_authenticator module
    • ServicePrincipalAuthenticator
      • ServicePrincipalAuthenticator.get_api_key()
      • ServicePrincipalAuthenticator.handle_ims_failure()
      • ServicePrincipalAuthenticator.refresh_token()
      • ServicePrincipalAuthenticator.service_principal_configuration
      • ServicePrincipalAuthenticator.session_token()
      • ServicePrincipalAuthenticator.time_to_expire()
      • ServicePrincipalAuthenticator.token
      • ServicePrincipalAuthenticator.token_endpoint
  • adobe.pdfservices.operation.internal.auth.service_token_authenticator module
    • ServiceTokenAuthenticator
      • ServiceTokenAuthenticator.get_api_key()
      • ServiceTokenAuthenticator.refresh_token()
      • ServiceTokenAuthenticator.session_token()
  • adobe.pdfservices.operation.internal.auth.service_token_credentials module
    • ServiceTokenCredentials
      • ServiceTokenCredentials.get_client_id()
      • ServiceTokenCredentials.get_token()
      • ServiceTokenCredentials.set_client_id()
      • ServiceTokenCredentials.set_token()
  • adobe.pdfservices.operation.internal.auth.session_token module
    • SessionToken
      • SessionToken.expired_at
  • Module contents
• adobe.pdfservices.operation.internal.constants package
  • Submodules
  • adobe.pdfservices.operation.internal.constants.custom_error_messages module
    • CustomErrorMessages
      • CustomErrorMessages.GENERIC_CAN_NOT_BE_NONE
      • CustomErrorMessages.GENERIC_CAN_NOT_BE_NONE_OR_EMPTY
      • CustomErrorMessages.INVALID_INPUT_ASSET
      • CustomErrorMessages.INVALID_OUTPUT_ASSET
      • CustomErrorMessages.SET_OUTPUT_VALIDATE
  • adobe.pdfservices.operation.internal.constants.operation_header_info_endpoint_map module
    • OperationHeaderInfoEndpointMap
      • OperationHeaderInfoEndpointMap.AUTO_TAG
      • OperationHeaderInfoEndpointMap.COMBINE_PDF
      • OperationHeaderInfoEndpointMap.COMPRESS_PDF
      • OperationHeaderInfoEndpointMap.CREATE_PDF
      • OperationHeaderInfoEndpointMap.DELETE_PAGES
      • OperationHeaderInfoEndpointMap.EXPORT_PDF
      • OperationHeaderInfoEndpointMap.EXPORT_PDF_TO_IMAGES
      • OperationHeaderInfoEndpointMap.EXTRACT_PDF
      • OperationHeaderInfoEndpointMap.E_SEAL
      • OperationHeaderInfoEndpointMap.HTML_TO_PDF
      • OperationHeaderInfoEndpointMap.INSERT_PAGES
      • OperationHeaderInfoEndpointMap.LINEARIZE_PDF
      • OperationHeaderInfoEndpointMap.MERGE_DOCUMENT
      • OperationHeaderInfoEndpointMap.OCR
      • OperationHeaderInfoEndpointMap.PDF_PROPERTIES
      • OperationHeaderInfoEndpointMap.PROTECT_PDF
      • OperationHeaderInfoEndpointMap.REMOVE_PROTECTION
      • OperationHeaderInfoEndpointMap.REORDER_PAGES
      • OperationHeaderInfoEndpointMap.REPLACE_PAGES
      • OperationHeaderInfoEndpointMap.ROTATE_PAGES
      • OperationHeaderInfoEndpointMap.SPLIT_PDF
      • OperationHeaderInfoEndpointMap.get_endpoint()
      • OperationHeaderInfoEndpointMap.get_header_info()
  • adobe.pdfservices.operation.internal.constants.pdf_services_uri module
    • PDFServicesURI
      • PDFServicesURI.EU_URI
      • PDFServicesURI.REGION_URI_MAP
      • PDFServicesURI.URI
      • PDFServicesURI.US_URI
      • PDFServicesURI.get_default_uri()
      • PDFServicesURI.get_uri_for_region()
  • adobe.pdfservices.operation.internal.constants.request_key module
    • RequestKey
      • RequestKey.AUTHN
      • RequestKey.DOWNLOAD
      • RequestKey.PLATFORM
      • RequestKey.STATUS
      • RequestKey.UPLOAD
  • adobe.pdfservices.operation.internal.constants.service_constants module
    • ServiceConstants
      • ServiceConstants.AUTOTAG_OPERATION_NAME
      • ServiceConstants.COMBINE_PDF_NAME
      • ServiceConstants.COMPRESS_PDF_OPERATION_NAME
      • ServiceConstants.CREATE_OPERATION_NAME
      • ServiceConstants.DELETE_PAGES_OPERATION_NAME
      • ServiceConstants.DOCUMENT_MERGE_OPERATION_NAME
      • ServiceConstants.ESEAL_PDF_NAME
      • ServiceConstants.EXPORT_PDF_OPERATION_NAME
      • ServiceConstants.EXTRACT_OPERATION_NAME
      • ServiceConstants.HTML_TO_PDF_OPERATION_NAME
      • ServiceConstants.HTTP_CONNECT_TIMEOUT
      • ServiceConstants.HTTP_READ_TIMEOUT
      • ServiceConstants.INSERT_PAGES_OPERATION_NAME
      • ServiceConstants.LINEARIZE_PDF_OPERATION_NAME
      • ServiceConstants.OCR_PDF_OPERATION_NAME
      • ServiceConstants.OPERATION_RESULT_TEMP_DIRECTORY
      • ServiceConstants.PDF_PROPERTIES_OPERATION_NAME
      • ServiceConstants.PDF_TO_IMAGES_OPERATION_NAME
      • ServiceConstants.PROTECT_PDF_NAME
      • ServiceConstants.REMOVE_PROTECTION_OPERATION_NAME
      • ServiceConstants.REORDER_PAGES_OPERATION_NAME
      • ServiceConstants.REPLACE_PAGES_OPERATION_NAME
      • ServiceConstants.ROTATE_PAGES_OPERATION_NAME
      • ServiceConstants.SPLIT_PDF_OPERATION_NAME
  • Module contents
• adobe.pdfservices.operation.internal.http package
  • Submodules
  • adobe.pdfservices.operation.internal.http.http_client module
    • process_request()
  • adobe.pdfservices.operation.internal.http.http_method module
    • HttpMethod
      • HttpMethod.DELETE
      • HttpMethod.GET
      • HttpMethod.POST
      • HttpMethod.PUT
  • adobe.pdfservices.operation.internal.http.http_request module
    • HttpRequest
  • adobe.pdfservices.operation.internal.http.request_header_const module
    • DefaultHeaders
      • DefaultHeaders.ACCEPT_HEADER_NAME
      • DefaultHeaders.AUTHORIZATION_HEADER_NAME
      • DefaultHeaders.CONTENT_TYPE_HEADER_NAME
      • DefaultHeaders.DC_APP_INFO_HEADER_KEY
      • DefaultHeaders.DC_REQUEST_ID_HEADER_KEY
      • DefaultHeaders.JSON_TXT_CONTENT_TYPE
      • DefaultHeaders.LOCATION_HEADER_NAME
      • DefaultHeaders.SESSION_TOKEN_REQUEST_ID_HEADER_KEY
      • DefaultHeaders.X_API_KEY_HEADER_NAME
      • DefaultHeaders.X_DCSDK_OPS_INFO_HEADER_NAME
  • adobe.pdfservices.operation.internal.http.response_util module
    • ResponseUtil
      • ResponseUtil.CUSTOM_ERROR_MESSAGES_STATUS_CODE_MAPPING
      • ResponseUtil.INTEGRATION_SERVICE_USAGE_LIMIT_REACHED_ERROR_MESSAGE
      • ResponseUtil.QUOTA_ERROR_MESSAGE
      • ResponseUtil.SERVICE_USAGE_EXCEPTION_STATUS_CODE_429001_STRING
      • ResponseUtil.SERVICE_USAGE_EXCEPTION_STATUS_CODE_429002_STRING
      • ResponseUtil.SERVICE_USAGE_LIMIT_REACHED_ERROR_MESSAGE
      • ResponseUtil.get_request_tracking_id_from_response()
      • ResponseUtil.handle_api_failures()
      • ResponseUtil.handle_service_api_error_response()
      • ResponseUtil.handle_service_usage_failure()
      • ResponseUtil.handle_upload_asset_failure()
  • Module contents
• adobe.pdfservices.operation.internal.params package
  • Submodules
  • adobe.pdfservices.operation.internal.params.combine_pdf_job_input module
    • CombinePDFJobInput
      • CombinePDFJobInput.get_asset()
      • CombinePDFJobInput.get_page_ranges()
      • CombinePDFJobInput.json_hint
      • CombinePDFJobInput.to_json()
  • adobe.pdfservices.operation.internal.params.page_range module
    • PageRange
      • PageRange.get_end()
      • PageRange.get_start()
      • PageRange.json_hint
      • PageRange.to_json()
      • PageRange.validate()
  • Module contents
• adobe.pdfservices.operation.internal.util package
  • Submodules
  • adobe.pdfservices.operation.internal.util.asset_upload_util module
    • AssetUploadUtil
  • adobe.pdfservices.operation.internal.util.enforce_types module
    • enforce_types()
  • adobe.pdfservices.operation.internal.util.file_utils module
    • read_conf_file_content()
  • adobe.pdfservices.operation.internal.util.json_hint_encoder module
    • JSONHintDecoder
      • JSONHintDecoder.as_class()
      • JSONHintDecoder.rev()
    • JSONHintEncoder
      • JSONHintEncoder.default()
  • adobe.pdfservices.operation.internal.util.object_util module
    • ObjectUtil
      • ObjectUtil.require_not_null()
  • adobe.pdfservices.operation.internal.util.path_util module
    • get_file_path()
  • adobe.pdfservices.operation.internal.util.string_util module
    • StringUtil
      • StringUtil.is_blank()
  • adobe.pdfservices.operation.internal.util.validation_util module
    • ValidationUtil
      • ValidationUtil.validate_asset_with_page_options()
      • ValidationUtil.validate_csc_credential()
      • ValidationUtil.validate_document_merge_params()
      • ValidationUtil.validate_execution_context()
      • ValidationUtil.validate_field_location()
      • ValidationUtil.validate_field_options()
      • ValidationUtil.validate_insert_asset_inputs()
      • ValidationUtil.validate_page_options()
      • ValidationUtil.validate_page_ranges()
      • ValidationUtil.validate_page_ranges_overlap()
      • ValidationUtil.validate_password()
      • ValidationUtil.validate_password_to_remove_protection()
      • ValidationUtil.validate_pdf_electronic_seal_params()
      • ValidationUtil.validate_protect_pdf_params()
      • ValidationUtil.validate_replace_files_inputs()
      • ValidationUtil.validate_rotate_page_actions()
      • ValidationUtil.validate_split_pdf_operation_params()
  • Module contents

Submodules

adobe.pdfservices.operation.internal.exceptions module

exception adobe.pdfservices.operation.internal.exceptions.OperationException(message, error_message, request_tracking_id, status_code, error_code=None, report_error_code=None)

Bases: Exception

property error_code

adobe.pdfservices.operation.internal.execution_context module

class adobe.pdfservices.operation.internal.execution_context.ExecutionContext(credentials: Credentials, client_config: ClientConfig = None)

Bases: object

property authenticator

property client_config

property credentials

validate()

adobe.pdfservices.operation.internal.internal_client_config module

adobe.pdfservices.operation.internal.pdf_services_helper module

class adobe.pdfservices.operation.internal.pdf_services_helper.PDFServicesHelper

Bases: object

classmethod delete_asset(context: ExecutionContext, asset: Asset)

classmethod get_content(context: ExecutionContext, asset: Asset) → StreamAsset

classmethod get_job_result(context: ExecutionContext, location: str, result_type) → PDFServicesResponse

classmethod get_job_status(context: ExecutionContext, location: str)

classmethod refresh_download_uri(context: ExecutionContext, asset: Asset) → CloudAsset

classmethod submit_job(context: ExecutionContext, platform_api_request: PDFServicesAPIRequest, operation_endpoint: str, x_request_id: str, operation_header_info: str)

classmethod upload(context: ExecutionContext, input_stream, media_type: str) → Asset

classmethod upload_assets(context: ExecutionContext, stream_asset_list: []) → []

Module contents