diff --git a/docs/build/doctrees/adobe.pdfservices.operation.auth.doctree b/docs/build/doctrees/adobe.pdfservices.operation.auth.doctree index ec865e9..679bc00 100644 Binary files a/docs/build/doctrees/adobe.pdfservices.operation.auth.doctree and b/docs/build/doctrees/adobe.pdfservices.operation.auth.doctree differ diff --git a/docs/build/doctrees/adobe.pdfservices.operation.doctree b/docs/build/doctrees/adobe.pdfservices.operation.doctree index 91e1180..2f0b596 100644 Binary files a/docs/build/doctrees/adobe.pdfservices.operation.doctree and b/docs/build/doctrees/adobe.pdfservices.operation.doctree differ diff --git a/docs/build/doctrees/adobe.pdfservices.operation.pdfops.doctree b/docs/build/doctrees/adobe.pdfservices.operation.pdfops.doctree index 3aca2d6..3ccb6dd 100644 Binary files a/docs/build/doctrees/adobe.pdfservices.operation.pdfops.doctree and b/docs/build/doctrees/adobe.pdfservices.operation.pdfops.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 1335303..fada71f 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/reference/index.doctree b/docs/build/doctrees/reference/index.doctree index 4d75f12..31378eb 100644 Binary files a/docs/build/doctrees/reference/index.doctree and b/docs/build/doctrees/reference/index.doctree differ diff --git a/docs/build/html/_sources/adobe.pdfservices.operation.auth.rst.txt b/docs/build/html/_sources/adobe.pdfservices.operation.auth.rst.txt index a866f39..2aa9de6 100644 --- a/docs/build/html/_sources/adobe.pdfservices.operation.auth.rst.txt +++ b/docs/build/html/_sources/adobe.pdfservices.operation.auth.rst.txt @@ -20,6 +20,14 @@ adobe.pdfservices.operation.auth.service\_account\_credentials module :undoc-members: :show-inheritance: +adobe.pdfservices.operation.auth.service\_principal\_credentials module +--------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.auth.service_principal_credentials + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/build/html/_sources/reference/index.rst.txt b/docs/build/html/_sources/reference/index.rst.txt index bfa1df5..e5e0295 100644 --- a/docs/build/html/_sources/reference/index.rst.txt +++ b/docs/build/html/_sources/reference/index.rst.txt @@ -93,5 +93,20 @@ ServiceAccountCredentialsBuilder :show-inheritance: :noindex: +ServicePrincipalCredentials +-------------------------- +.. autoclass:: adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials + :members: + :undoc-members: + :show-inheritance: + +ServicePrincipalCredentialsBuilder +-------------------------------- +.. autoclass:: adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder + :members: + :undoc-members: + :show-inheritance: + :noindex: + diff --git a/docs/build/html/adobe.pdfservices.html b/docs/build/html/adobe.pdfservices.html index d71ead4..d834362 100644 --- a/docs/build/html/adobe.pdfservices.html +++ b/docs/build/html/adobe.pdfservices.html @@ -61,6 +61,7 @@
  • Credentials @@ -190,6 +191,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • @@ -229,6 +245,7 @@

    SubpackagesSubmodules
  • adobe.pdfservices.operation.auth.credentials module
  • adobe.pdfservices.operation.auth.service_account_credentials module
  • +
  • adobe.pdfservices.operation.auth.service_principal_credentials module
  • Module contents
  • diff --git a/docs/build/html/adobe.pdfservices.operation.auth.html b/docs/build/html/adobe.pdfservices.operation.auth.html index 9b12ac2..0ffa76a 100644 --- a/docs/build/html/adobe.pdfservices.operation.auth.html +++ b/docs/build/html/adobe.pdfservices.operation.auth.html @@ -61,6 +61,7 @@
  • Credentials @@ -190,6 +191,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • @@ -228,7 +244,7 @@

    Submodules class adobe.pdfservices.operation.auth.credentials.Credentials

    Bases: ABC

    -

    Marker base class for different types of credentials. Currently it supports only ServiceAccountCredentials. +

    Marker base class for different types of credentials. Currently it supports ServiceAccountCredentials and ServicePrincipalCredentials. The factory methods within this class can be used to create instances of credentials classes.

    @@ -242,6 +258,23 @@

    Submodules

    ServiceAccountCredentials.Builder

    +
    +

    Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

    +
    + + +
    +
    +static service_principal_credentials_builder()
    +

    Creates a new ServicePrincipalCredentials builder.

    +
    +
    Returns:
    +

    An instance of ServicePrincipalCredentials Builder.

    +
    +
    Return type:
    +

    ServicePrincipalCredentials.Builder

    +
    +
    @@ -253,9 +286,11 @@

    Submodules class adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials(client_id, client_secret, private_key, organization_id, account_id)

    Bases: Credentials, ABC

    -

    Service Account credentials allow your application to call PDF Tools Extract API on behalf of the application itself, -or on behalf of an enterprise organization. For getting the credentials, -Click Here.

    +

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

    +
    +

    Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

    +
    class Builder
    @@ -273,6 +308,9 @@

    Submodules

    ServiceAccountCredentials

    +
    +

    Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

    +
    @@ -361,7 +399,7 @@

    Submodules
    with_organization_id(organization_id: str)
    -

    Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

    +

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

    Parameters:

    organization_id (str) – Organization ID (format: org_ident@AdobeOrg)

    @@ -415,7 +453,7 @@

    Submodules
    property organization_id
    -

    Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.

    +

    Identifies the organization (format: org_ident@AdobeOrg) that has been configured for access to PDF Services API.

    @@ -426,6 +464,85 @@

    Submodules +

    adobe.pdfservices.operation.auth.service_principal_credentials module

    +
    +
    +class adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials(client_id, client_secret)
    +

    Bases: Credentials, ABC

    +

    OAuth Server-to-Server based Service Principal credentials allow your application to call PDF Services API on behalf of the application itself, +or on behalf of an enterprise organization. For getting the credentials, +Click Here.

    +
    +
    +class Builder
    +

    Bases: object

    +

    Builds a ServicePrincipalCredentials instance.

    +
    +
    +build()
    +

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

    +
    +
    Returns:
    +

    A ServicePrincipalCredentials instance.

    +
    +
    Return type:
    +

    ServicePrincipalCredentials

    +
    +
    +
    + +
    +
    +with_client_id(client_id: str)
    +

    Set Client ID (API Key)

    +
    +
    Parameters:
    +

    client_id (str) – Client Id (API Key)

    +
    +
    Returns:
    +

    This Builder instance to add any additional parameters.

    +
    +
    Return type:
    +

    ServicePrincipalCredentials.Builder

    +
    +
    +
    + +
    +
    +with_client_secret(client_secret: str)
    +

    Set Client Secret

    +
    +
    Parameters:
    +

    client_secret (str) – Client Secret

    +
    +
    Returns:
    +

    This Builder instance to add any additional parameters.

    +
    +
    Return type:
    +

    ServicePrincipalCredentials.Builder

    +
    +
    +
    + +
    + +
    +
    +property client_id
    +

    Client Id (API Key)

    +
    + +
    +
    +property client_secret
    +

    Client Secret

    +
    + +
    +

    Module contents

    diff --git a/docs/build/html/adobe.pdfservices.operation.html b/docs/build/html/adobe.pdfservices.operation.html index 1389ff8..3c8755b 100644 --- a/docs/build/html/adobe.pdfservices.operation.html +++ b/docs/build/html/adobe.pdfservices.operation.html @@ -61,6 +61,7 @@
  • Credentials @@ -190,6 +191,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • @@ -228,6 +244,7 @@

    Subpackagesadobe.pdfservices.operation.auth.credentials module @@ -244,6 +261,15 @@

    Subpackagesadobe.pdfservices.operation.auth.service_principal_credentials module +
  • Module contents
  • @@ -485,9 +511,7 @@

    Submodules
    try:
         base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
     
    -    credentials = Credentials.service_account_credentials_builder() \
    -        .from_file(base_path + "/pdfservices-api-credentials.json") \
    -        .build()
    +    credentials = Credentials.service_principal_credentials_builder().                 with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')).                 with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')).                 build()
     
         execution_context = ExecutionContext.create(credentials)
         extract_pdf_operation = ExtractPDFOperation.create_new()
    diff --git a/docs/build/html/adobe.pdfservices.operation.pdfops.html b/docs/build/html/adobe.pdfservices.operation.pdfops.html
    index 62ec53b..9518d35 100644
    --- a/docs/build/html/adobe.pdfservices.operation.pdfops.html
    +++ b/docs/build/html/adobe.pdfservices.operation.pdfops.html
    @@ -61,6 +61,7 @@
     
  • Credentials @@ -190,6 +191,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • @@ -263,9 +279,10 @@

    Submodules
    try:
         base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
     
    -    credentials = Credentials.service_account_credentials_builder() \
    -        .from_file(base_path + "/pdfservices-api-credentials.json") \
    -        .build()
    +    credentials = Credentials.service_principal_credentials_builder(). \
    +        with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \
    +        with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \
    +        build()
     
         execution_context = ExecutionContext.create(credentials)
         extract_pdf_operation = ExtractPDFOperation.create_new()
    @@ -394,9 +411,10 @@ 

    Submodules
    try:
         base_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
     
    -    credentials = Credentials.service_account_credentials_builder() \
    -        .from_file(base_path + "/pdfservices-api-credentials.json") \
    -        .build()
    +    credentials = Credentials.service_principal_credentials_builder(). \
    +        with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \
    +        with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \
    +        build()
     
         execution_context = ExecutionContext.create(credentials)
         autotag_pdf_operation = AutotagPDFOperation.create_new()
    diff --git a/docs/build/html/adobe.pdfservices.operation.pdfops.options.autotagpdf.html b/docs/build/html/adobe.pdfservices.operation.pdfops.options.autotagpdf.html
    index cba88e4..33efa34 100644
    --- a/docs/build/html/adobe.pdfservices.operation.pdfops.options.autotagpdf.html
    +++ b/docs/build/html/adobe.pdfservices.operation.pdfops.options.autotagpdf.html
    @@ -61,6 +61,7 @@
     
  • Credentials @@ -190,6 +191,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • diff --git a/docs/build/html/adobe.pdfservices.operation.pdfops.options.html b/docs/build/html/adobe.pdfservices.operation.pdfops.options.html index cbd158c..076f631 100644 --- a/docs/build/html/adobe.pdfservices.operation.pdfops.options.html +++ b/docs/build/html/adobe.pdfservices.operation.pdfops.options.html @@ -61,6 +61,7 @@
  • Credentials @@ -190,6 +191,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index ae0a838..03b7349 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -60,6 +60,7 @@
  • Credentials @@ -189,6 +190,21 @@
  • ServiceAccountCredentialsBuilder
  • +
  • ServicePrincipalCredentials +
  • +
  • ServicePrincipalCredentialsBuilder
  • @@ -282,6 +298,13 @@

    A

    +
  • + adobe.pdfservices.operation.auth.service_principal_credentials + +
  • @@ -326,6 +349,8 @@

    A

  • module
  • + +
    • adobe.pdfservices.operation.operation @@ -333,8 +358,6 @@

      A

    • module
    - -
    • adobe.pdfservices.operation.pdfops @@ -427,6 +450,8 @@

      B

    • build() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1]
        +
      • (adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder method), [1] +
      • (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1]
      • (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder method), [1] @@ -451,17 +476,25 @@

        C

        + - + + +
        -
      • ServiceAccountCredentialsBuilder
      • +
      • ServicePrincipalCredentials +
      • +
      • ServicePrincipalCredentialsBuilder
      • diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index d6ae198..a77fc75 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index 990e27e..a4bd39b 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -63,6 +63,7 @@
      • Credentials @@ -192,6 +193,21 @@
      • ServiceAccountCredentialsBuilder
      • +
      • ServicePrincipalCredentials +
      • +
      • ServicePrincipalCredentialsBuilder
      • @@ -261,6 +277,11 @@

        Python Module Index

            adobe.pdfservices.operation.auth.service_account_credentials
            + adobe.pdfservices.operation.auth.service_principal_credentials +
            diff --git a/docs/build/html/reference/index.html b/docs/build/html/reference/index.html index e6a5dab..5187f45 100644 --- a/docs/build/html/reference/index.html +++ b/docs/build/html/reference/index.html @@ -62,6 +62,7 @@
      • Credentials @@ -191,6 +192,21 @@
      • ServiceAccountCredentialsBuilder
      • +
      • ServicePrincipalCredentials +
      • +
      • ServicePrincipalCredentialsBuilder
      • @@ -483,7 +499,7 @@

        Credentials class adobe.pdfservices.operation.auth.credentials.Credentials

        Bases: ABC

        -

        Marker base class for different types of credentials. Currently it supports only ServiceAccountCredentials. +

        Marker base class for different types of credentials. Currently it supports ServiceAccountCredentials and ServicePrincipalCredentials. The factory methods within this class can be used to create instances of credentials classes.

        @@ -497,6 +513,23 @@

        Credentials

        ServiceAccountCredentials.Builder

        +
        +

        Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

        +
        + + +
        +
        +static service_principal_credentials_builder()
        +

        Creates a new ServicePrincipalCredentials builder.

        +
        +
        Returns:
        +

        An instance of ServicePrincipalCredentials Builder.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials.Builder

        +
        +
        @@ -515,9 +548,7 @@

        ExecutionContext
        try:
             base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
         
        -    credentials = Credentials.service_account_credentials_builder() \
        -        .from_file(base_path + "/pdfservices-api-credentials.json") \
        -        .build()
        +    credentials = Credentials.service_principal_credentials_builder().                 with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')).                 with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')).                 build()
         
             execution_context = ExecutionContext.create(credentials)
             extract_pdf_operation = ExtractPDFOperation.create_new()
        @@ -574,9 +605,10 @@ 

        ExtractPDFOperation
        try:
             base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
         
        -    credentials = Credentials.service_account_credentials_builder() \
        -        .from_file(base_path + "/pdfservices-api-credentials.json") \
        -        .build()
        +    credentials = Credentials.service_principal_credentials_builder(). \
        +        with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \
        +        with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \
        +        build()
         
             execution_context = ExecutionContext.create(credentials)
             extract_pdf_operation = ExtractPDFOperation.create_new()
        @@ -914,9 +946,10 @@ 

        AutotagPDFOperation
        try:
             base_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
         
        -    credentials = Credentials.service_account_credentials_builder() \
        -        .from_file(base_path + "/pdfservices-api-credentials.json") \
        -        .build()
        +    credentials = Credentials.service_principal_credentials_builder(). \
        +        with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \
        +        with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \
        +        build()
         
             execution_context = ExecutionContext.create(credentials)
             autotag_pdf_operation = AutotagPDFOperation.create_new()
        @@ -1291,9 +1324,11 @@ 

        ServiceAccountCredentials class adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials(client_id, client_secret, private_key, organization_id, account_id)

        Bases: Credentials, ABC

        -

        Service Account credentials allow your application to call PDF Tools Extract API on behalf of the application itself, -or on behalf of an enterprise organization. For getting the credentials, -Click Here.

        +

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

        +
        +

        Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

        +
        class Builder
        @@ -1311,6 +1346,9 @@

        ServiceAccountCredentials

        ServiceAccountCredentials

        +
        +

        Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

        +
        @@ -1399,7 +1437,7 @@

        ServiceAccountCredentials
        with_organization_id(organization_id: str)
        -

        Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

        +

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

        Parameters:

        organization_id (str) – Organization ID (format: org_ident@AdobeOrg)

        @@ -1453,7 +1491,7 @@

        ServiceAccountCredentials
        property organization_id
        -

        Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.

        +

        Identifies the organization (format: org_ident@AdobeOrg) that has been configured for access to PDF Services API.

        @@ -1484,6 +1522,9 @@

        ServiceAccountCredentialsBuilder

        ServiceAccountCredentials

        +
        +

        Deprecated since version 2.3.0: Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based ServicePrincipalCredentials.

        +
        @@ -1572,7 +1613,7 @@

        ServiceAccountCredentialsBuilder
        with_organization_id(organization_id: str)
        -

        Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

        +

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

        Parameters:

        organization_id (str) – Organization ID (format: org_ident@AdobeOrg)

        @@ -1605,6 +1646,143 @@

        ServiceAccountCredentialsBuilder +

        ServicePrincipalCredentials

        +
        +
        +class adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials(client_id, client_secret)
        +

        Bases: Credentials, ABC

        +

        OAuth Server-to-Server based Service Principal credentials allow your application to call PDF Services API on behalf of the application itself, +or on behalf of an enterprise organization. For getting the credentials, +Click Here.

        +
        +
        +class Builder
        +

        Bases: object

        +

        Builds a ServicePrincipalCredentials instance.

        +
        +
        +build()
        +

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

        +
        +
        Returns:
        +

        A ServicePrincipalCredentials instance.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials

        +
        +
        +
        + +
        +
        +with_client_id(client_id: str)
        +

        Set Client ID (API Key)

        +
        +
        Parameters:
        +

        client_id (str) – Client Id (API Key)

        +
        +
        Returns:
        +

        This Builder instance to add any additional parameters.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials.Builder

        +
        +
        +
        + +
        +
        +with_client_secret(client_secret: str)
        +

        Set Client Secret

        +
        +
        Parameters:
        +

        client_secret (str) – Client Secret

        +
        +
        Returns:
        +

        This Builder instance to add any additional parameters.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials.Builder

        +
        +
        +
        + +
        + +
        +
        +property client_id
        +

        Client Id (API Key)

        +
        + +
        +
        +property client_secret
        +

        Client Secret

        +
        + +
        + + +
        +

        ServicePrincipalCredentialsBuilder

        +
        +
        +class adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder
        +

        Bases: object

        +

        Builds a ServicePrincipalCredentials instance.

        +
        +
        +build()
        +

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

        +
        +
        Returns:
        +

        A ServicePrincipalCredentials instance.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials

        +
        +
        +
        + +
        +
        +with_client_id(client_id: str)
        +

        Set Client ID (API Key)

        +
        +
        Parameters:
        +

        client_id (str) – Client Id (API Key)

        +
        +
        Returns:
        +

        This Builder instance to add any additional parameters.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials.Builder

        +
        +
        +
        + +
        +
        +with_client_secret(client_secret: str)
        +

        Set Client Secret

        +
        +
        Parameters:
        +

        client_secret (str) – Client Secret

        +
        +
        Returns:
        +

        This Builder instance to add any additional parameters.

        +
        +
        Return type:
        +

        ServicePrincipalCredentials.Builder

        +
        +
        +
        + +
        +
        diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 7e47c9b..3fbfc05 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -63,6 +63,7 @@
      • Credentials @@ -192,6 +193,21 @@
      • ServiceAccountCredentialsBuilder
      • +
      • ServicePrincipalCredentials +
      • +
      • ServicePrincipalCredentialsBuilder
      • diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 1ec749a..2b358af 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["adobe", "adobe.pdfservices", "adobe.pdfservices.operation", "adobe.pdfservices.operation.auth", "adobe.pdfservices.operation.exception", "adobe.pdfservices.operation.io", "adobe.pdfservices.operation.pdfops", "adobe.pdfservices.operation.pdfops.options", "adobe.pdfservices.operation.pdfops.options.autotagpdf", "adobe.pdfservices.operation.pdfops.options.extractpdf", "index", "modules", "reference/index"], "filenames": ["adobe.rst", "adobe.pdfservices.rst", "adobe.pdfservices.operation.rst", "adobe.pdfservices.operation.auth.rst", "adobe.pdfservices.operation.exception.rst", "adobe.pdfservices.operation.io.rst", "adobe.pdfservices.operation.pdfops.rst", "adobe.pdfservices.operation.pdfops.options.rst", "adobe.pdfservices.operation.pdfops.options.autotagpdf.rst", "adobe.pdfservices.operation.pdfops.options.extractpdf.rst", "index.rst", "modules.rst", "reference/index.rst"], "titles": ["adobe package", "adobe.pdfservices package", "adobe.pdfservices.operation package", "adobe.pdfservices.operation.auth package", "adobe.pdfservices.operation.exception package", "adobe.pdfservices.operation.io package", "adobe.pdfservices.operation.pdfops package", "adobe.pdfservices.operation.pdfops.options package", "adobe.pdfservices.operation.pdfops.options.autotagpdf package", "adobe.pdfservices.operation.pdfops.options.extractpdf package", "pdfservices-sdk", "src", "API Reference"], "terms": {"pdfservic": [0, 11, 12], "oper": [0, 1, 10, 12], "submodul": [0, 1, 7], "client_config": [0, 1, 12], "execution_context": [0, 1, 6, 12], "auth": [1, 2, 12], "credenti": [1, 2, 4, 6], "service_account_credenti": [1, 2, 12], "except": [1, 2, 6], "io": [1, 2, 6, 12], "file_ref": [1, 2, 6, 12], "pdfop": [1, 2, 12], "extract_pdf_oper": [1, 2, 12], "autotag_pdf_oper": [1, 2, 12], "clientconfig": [1, 2], "builder": [1, 2, 3, 6, 7, 8, 9, 12], "executioncontext": [1, 2, 6], "creat": [1, 2, 3, 5, 6, 12], "execut": [1, 2, 5, 6, 12], "service_account_credentials_build": [2, 3, 6, 12], "serviceaccountcredenti": [2, 3], "account_id": [2, 3, 12], "client_id": [2, 3, 12], "client_secret": [2, 3, 12], "organization_id": [2, 3, 12], "private_kei": [2, 3, 12], "sdkexcept": [2, 4, 6, 12], "request_tracking_id": [2, 4, 12], "serviceapiexcept": [2, 4, 6, 12], "default_error_cod": [2, 4, 12], "default_status_cod": [2, 4, 12], "error_cod": [2, 4, 12], "status_cod": [2, 4, 12], "serviceusageexcept": [2, 4, 6, 12], "fileref": [2, 5, 6], "create_from_local_fil": [2, 5, 6, 12], "create_from_stream": [2, 5, 12], "get_media_typ": [2, 5, 12], "save_a": [2, 5, 6, 12], "write_to_stream": [2, 5, 12], "option": [2, 3, 5, 6, 12], "extractpdfoper": [2, 6, 9], "supported_source_media_typ": [2, 6, 12], "create_new": [2, 6, 12], "get_opt": [2, 6, 12], "set_input": [2, 6, 12], "set_opt": [2, 6, 12], "autotagpdfoper": [2, 6, 8], "class": [2, 3, 5, 6, 8, 9, 10, 12], "base": [2, 3, 4, 5, 6, 8, 9, 12], "object": [2, 3, 8, 9, 12], "encapsul": [2, 12], "api": [2, 3, 4, 6, 10], "request": [2, 4, 12], "configur": [2, 3, 12], "build": [2, 3, 6, 8, 9, 12], "instanc": [2, 3, 5, 6, 8, 9, 12], "return": [2, 3, 4, 5, 6, 8, 9, 12], "new": [2, 3, 6, 12], "built": [2, 3, 12], "from": [2, 3, 5, 6, 9, 12], "current": [2, 3, 9, 12], "state": [2, 3, 12], "thi": [2, 3, 4, 5, 6, 8, 9, 10, 12], "A": [2, 3, 5, 6, 12], "type": [2, 3, 5, 6, 8, 9, 12], "from_fil": [2, 3, 6, 12], "client_config_file_path": [2, 12], "str": [2, 3, 5, 9, 12], "set": [2, 3, 6, 8, 9, 12], "connect": [2, 12], "timeout": [2, 12], "read": [2, 5, 12], "us": [2, 3, 5, 6, 12], "json": [2, 3, 6, 9, 12], "client": [2, 3, 4, 6, 12], "config": [2, 12], "file": [2, 3, 5, 6, 8, 9, 12], "path": [2, 3, 5, 6, 12], "all": [2, 3, 10, 12], "kei": [2, 3, 12], "structur": [2, 3, 6, 9, 12], "ar": [2, 3, 6, 12], "paramet": [2, 3, 5, 6, 8, 9, 12], "add": [2, 3, 6, 8, 9, 12], "ani": [2, 3, 5, 6, 8, 9, 10, 12], "addit": [2, 3, 6, 8, 9, 12], "connecttimeout": [2, 12], "4000": [2, 12], "readtimeout": [2, 12], "20000": [2, 12], "region": [2, 12], "eu": [2, 12], "with_connect_timeout": [2, 12], "connect_timeout": [2, 12], "int": [2, 12], "It": [2, 3, 5, 6, 12], "should": [2, 12], "greater": [2, 12], "than": [2, 12], "zero": [2, 12], "determin": [2, 12], "millisecond": [2, 12], "until": [2, 12], "i": [2, 3, 4, 5, 6, 9, 10, 12], "establish": [2, 12], "call": [2, 3, 4, 5, 6, 12], "default": [2, 4, 5, 12], "valu": [2, 4, 9, 12], "with_read_timeout": [2, 12], "read_timeout": [2, 12], "defin": [2, 8, 9, 12], "The": [2, 3, 4, 5, 6, 8, 9, 12], "number": [2, 12], "wait": [2, 12], "server": [2, 12], "send": [2, 12], "respons": [2, 6, 12], "after": [2, 12], "10000": [2, 12], "with_region": [2, 12], "updat": [2, 12], "relev": [2, 12], "servic": [2, 3, 4, 12], "u": [2, 12], "static": [2, 3, 5, 8, 9, 12], "repres": [2, 4, 5, 12], "context": [2, 6, 12], "an": [2, 3, 4, 5, 6, 8, 9, 12], "typic": [2, 4, 5, 12], "consist": [2, 12], "desir": [2, 12], "authent": [2, 12], "For": [2, 3, 5, 12], "each": [2, 12], "can": [2, 3, 9, 12], "reus": [2, 12], "across": [2, 12], "sampl": [2, 6, 12], "usag": [2, 4, 6, 12], "try": [2, 6, 12], "base_path": [2, 6, 12], "o": [2, 6, 12], "dirnam": [2, 6, 12], "abspath": [2, 6, 12], "__file__": [2, 6, 12], "sourc": [2, 6, 12], "resourc": [2, 6, 12], "extractpdfinput": [2, 6, 12], "pdf": [2, 3, 6, 8, 9, 12], "extract_pdf_opt": [2, 6, 7, 12], "extractpdfopt": [2, 6, 7, 9], "with_elements_to_extract": [2, 6, 9, 12], "extractelementtyp": [2, 6, 7, 9, 12], "text": [2, 6, 7, 9, 12], "tabl": [2, 6, 7, 9, 12], "with_elements_to_extract_rendit": [2, 6, 9, 12], "extractrenditionselementtyp": [2, 6, 7, 9, 12], "figur": [2, 6, 7, 9, 12], "with_get_char_info": [2, 6, 9, 12], "true": [2, 6, 9, 12], "result": [2, 4, 6, 12], "output": [2, 6, 8, 9, 12], "extracttexttablewithfiguretablerendit": [2, 6, 12], "zip": [2, 6, 12], "log": [2, 6, 12], "encount": [2, 6, 12], "while": [2, 5, 6, 12], "none": [2, 4, 5, 9, 12], "provid": [2, 5, 6, 12], "custom": [2, 12], "http": [2, 4, 12], "abc": [2, 3, 5, 12], "abstract": [2, 5, 12], "marker": [3, 12], "differ": [3, 12], "support": [3, 6, 9, 12], "onli": [3, 9, 12], "factori": [3, 12], "method": [3, 5, 12], "within": [3, 6, 12], "account": [3, 12], "allow": [3, 12], "your": [3, 12], "applic": [3, 12], "tool": [3, 12], "extract": [3, 6, 9, 12], "behalf": [3, 12], "itself": [3, 12], "enterpris": [3, 12], "organ": [3, 12], "get": [3, 6, 10, 12], "click": [3, 10, 12], "here": [3, 12], "credentials_file_path": [3, 12], "client_credenti": [3, 12], "org_id": [3, 12], "adobeorg": [3, 12], "id": [3, 4, 12], "techacct": [3, 12], "com": [3, 12], "private_key_fil": [3, 12], "privat": [3, 12], "look": [3, 12], "up": [3, 6, 12], "classpath": [3, 12], "directori": [3, 5, 6, 12], "with_account_id": [3, 12], "format": [3, 5, 6, 9, 12], "with_client_id": [3, 12], "with_client_secret": [3, 12], "secret": [3, 12], "with_organization_id": [3, 12], "ha": [3, 4, 12], "been": [3, 4, 12], "access": [3, 6, 12], "with_private_kei": [3, 12], "pem": [3, 12], "properti": [3, 4, 8, 9, 12], "identifi": [3, 5, 12], "messag": [4, 12], "thrown": [4, 12], "side": [4, 12], "network": [4, 12], "error": [4, 6, 12], "track": [4, 12], "0": [4, 12], "unknown": [4, 12], "when": [4, 5, 12], "underli": [4, 12], "statu": [4, 12], "code": [4, 12], "doesn": [4, 12], "t": [4, 12], "adequ": [4, 12], "detail": [4, 6, 12], "429": [4, 12], "serviceusageerror": [4, 12], "either": [4, 5, 12], "limit": [4, 12], "reach": [4, 12], "quota": [4, 12], "exhaust": [4, 12], "failur": [4, 12], "local": [5, 12], "sdk": [5, 12], "which": [5, 6, 9, 12], "accept": [5, 12], "refer": [5, 10], "temporari": [5, 6, 12], "locat": [5, 12], "save": [5, 12], "exampl": [5, 12], "etc": [5, 12], "delet": [5, 12], "local_sourc": [5, 12], "media_typ": [5, 12], "If": [5, 12], "media": [5, 12], "infer": [5, 12], "extens": [5, 12], "absolut": [5, 12], "rel": [5, 12], "work": [5, 12], "input_stream": [5, 12], "bufferedread": [5, 12], "readabl": [5, 12], "stream": [5, 12], "specifi": [5, 8, 9, 12], "consum": [5, 12], "e": [5, 6, 12], "local_file_path": [5, 12], "writer_stream": [5, 12], "extractpdf": [6, 7, 12], "extract_element_typ": [6, 7], "extract_renditions_element_typ": [6, 7], "table_structure_typ": [6, 7], "autotagpdf": [6, 7, 12], "autotag_pdf_opt": [6, 7, 12], "create_kei": [6, 12], "element": [6, 9, 12], "along": [6, 12], "rendit": [6, 9, 12], "with_include_styling_info": [6, 9, 12], "intern": [6, 12], "extension_media_type_map": [6, 12], "extensionmediatypemap": [6, 12], "mime_typ": [6, 12], "classmethod": [6, 12], "synchron": [6, 12], "suppli": [6, 12], "mai": [6, 12], "store": [6, 12], "system": [6, 12], "see": [6, 12], "how": [6, 12], "clean": [6, 12], "rais": [6, 9, 12], "source_file_ref": [6, 12], "input": [6, 9, 12], "enabl": [6, 12], "improv": [6, 12], "document": [6, 10, 12], "gener": [6, 8, 12], "tag": [6, 8, 12], "xlsx": [6, 8, 12], "report": [6, 8, 12], "inform": [6, 8, 9, 12], "about": [6, 8, 12], "ad": [6, 12], "replac": [6, 12], "exist": [6, 12], "so": [6, 12], "most": [6, 12], "benefit": [6, 12], "have": [6, 9, 12], "low": [6, 12], "qualiti": [6, 12], "input_file_path": [6, 12], "autotagpdfinput": [6, 12], "autotagpdfopt": [6, 7, 8], "with_shift_head": [6, 8, 12], "with_generate_report": [6, 8, 12], "autotag_pdf_output": [6, 12], "autotagpdfoutput": [6, 12], "input_file_nam": [6, 12], "stem": [6, 12], "base_output_path": [6, 12], "autotagpdfwithopt": [6, 12], "mkdir": [6, 12], "parent": [6, 12], "exist_ok": [6, 12], "tagged_pdf_path": [6, 12], "f": [6, 12], "report_path": [6, 12], "get_tagged_pdf": [6, 12], "get_report": [6, 12], "elements_to_extract": [7, 9, 12], "elements_to_extract_rendit": [7, 9, 12], "get_char_info": [7, 9, 12], "include_styling_info": [7, 9, 12], "table_output_format": [7, 9, 12], "tablestructuretyp": [7, 9, 12], "csv": [7, 9, 12], "generate_report": [7, 8, 12], "shift_head": [7, 8, 12], "boolean": [8, 9, 12], "whether": [8, 9, 12], "contain": [8, 12], "shift": [8, 12], "head": [8, 12], "with_table_structure_format": [9, 12], "with_element_to_extract": [9, 12], "element_to_extract": [9, 12], "valueerror": [9, 12], "with_element_to_extract_rendit": [9, 12], "element_to_extract_rendit": [9, 12], "whose": [9, 12], "list": [9, 12], "empti": [9, 12], "bool": [9, 12], "charact": [9, 12], "level": [9, 12], "bound": [9, 12], "box": [9, 12], "style": [9, 12], "info": [9, 12], "table_structur": [9, 12], "need": [9, 12], "export": [9, 12], "enum": 9, "elementtyp": 9, "expos": 10, "modul": [10, 11], "pleas": 10, "section": 10, "left": 10, "nav": 10, "start": 10, "adob": [11, 12], "packag": 11, "subpackag": 11, "content": [11, 12], "with_pdf_services_uri": [2, 12], "pdf_services_uri": [2, 12], "uri": [2, 12]}, "objects": {"": [[0, 0, 0, "-", "adobe"]], "adobe": [[1, 0, 0, "-", "pdfservices"]], "adobe.pdfservices": [[2, 0, 0, "-", "operation"]], "adobe.pdfservices.operation": [[3, 0, 0, "-", "auth"], [2, 0, 0, "-", "client_config"], [4, 0, 0, "-", "exception"], [2, 0, 0, "-", "execution_context"], [5, 0, 0, "-", "io"], [2, 0, 0, "-", "operation"], [6, 0, 0, "-", "pdfops"]], "adobe.pdfservices.operation.auth": [[3, 0, 0, "-", "credentials"], [3, 0, 0, "-", "service_account_credentials"]], "adobe.pdfservices.operation.auth.credentials": [[12, 1, 1, "", "Credentials"]], "adobe.pdfservices.operation.auth.credentials.Credentials": [[12, 2, 1, "", "service_account_credentials_builder"]], "adobe.pdfservices.operation.auth.service_account_credentials": [[12, 1, 1, "", "ServiceAccountCredentials"]], "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials": [[12, 1, 1, "", "Builder"], [12, 3, 1, "", "account_id"], [12, 3, 1, "", "client_id"], [12, 3, 1, "", "client_secret"], [12, 3, 1, "", "organization_id"], [12, 3, 1, "", "private_key"]], "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "from_file"], [12, 2, 1, "", "with_account_id"], [12, 2, 1, "", "with_client_id"], [12, 2, 1, "", "with_client_secret"], [12, 2, 1, "", "with_organization_id"], [12, 2, 1, "", "with_private_key"]], "adobe.pdfservices.operation.client_config": [[12, 1, 1, "", "ClientConfig"]], "adobe.pdfservices.operation.client_config.ClientConfig": [[12, 1, 1, "", "Builder"], [12, 2, 1, "", "builder"]], "adobe.pdfservices.operation.client_config.ClientConfig.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "from_file"], [12, 2, 1, "", "with_connect_timeout"], [12, 2, 1, "", "with_pdf_services_uri"], [12, 2, 1, "", "with_read_timeout"], [12, 2, 1, "", "with_region"]], "adobe.pdfservices.operation.exception": [[12, 0, 0, "-", "exceptions"]], "adobe.pdfservices.operation.exception.exceptions": [[12, 4, 1, "", "SdkException"], [12, 4, 1, "", "ServiceApiException"], [12, 4, 1, "", "ServiceUsageException"]], "adobe.pdfservices.operation.exception.exceptions.SdkException": [[12, 3, 1, "", "request_tracking_id"]], "adobe.pdfservices.operation.exception.exceptions.ServiceApiException": [[12, 5, 1, "", "DEFAULT_ERROR_CODE"], [12, 5, 1, "", "DEFAULT_STATUS_CODE"], [12, 3, 1, "", "error_code"], [12, 3, 1, "", "request_tracking_id"], [12, 3, 1, "", "status_code"]], "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException": [[12, 5, 1, "", "DEFAULT_ERROR_CODE"], [12, 5, 1, "", "DEFAULT_STATUS_CODE"], [12, 3, 1, "", "error_code"], [12, 3, 1, "", "request_tracking_id"], [12, 3, 1, "", "status_code"]], "adobe.pdfservices.operation.execution_context": [[12, 1, 1, "", "ExecutionContext"]], "adobe.pdfservices.operation.execution_context.ExecutionContext": [[12, 2, 1, "", "create"]], "adobe.pdfservices.operation.io": [[5, 0, 0, "-", "file_ref"]], "adobe.pdfservices.operation.io.file_ref": [[12, 1, 1, "", "FileRef"]], "adobe.pdfservices.operation.io.file_ref.FileRef": [[12, 2, 1, "", "create_from_local_file"], [12, 2, 1, "", "create_from_stream"], [12, 2, 1, "", "get_media_type"], [12, 2, 1, "", "save_as"], [12, 2, 1, "", "write_to_stream"]], "adobe.pdfservices.operation.operation": [[2, 1, 1, "", "Operation"]], "adobe.pdfservices.operation.operation.Operation": [[2, 2, 1, "", "execute"]], "adobe.pdfservices.operation.pdfops": [[6, 0, 0, "-", "autotag_pdf_operation"], [6, 0, 0, "-", "extract_pdf_operation"], [7, 0, 0, "-", "options"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation": [[12, 1, 1, "", "AutotagPDFOperation"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation": [[12, 5, 1, "", "SUPPORTED_SOURCE_MEDIA_TYPES"], [12, 2, 1, "", "create_new"], [12, 2, 1, "", "execute"], [12, 2, 1, "", "get_options"], [12, 2, 1, "", "set_input"], [12, 2, 1, "", "set_options"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation": [[12, 1, 1, "", "ExtractPDFOperation"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation": [[12, 5, 1, "", "SUPPORTED_SOURCE_MEDIA_TYPES"], [12, 2, 1, "", "create_new"], [12, 2, 1, "", "execute"], [12, 2, 1, "", "get_options"], [12, 2, 1, "", "set_input"], [12, 2, 1, "", "set_options"]], "adobe.pdfservices.operation.pdfops.options": [[8, 0, 0, "-", "autotagpdf"], [9, 0, 0, "-", "extractpdf"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf": [[8, 0, 0, "-", "autotag_pdf_options"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options": [[12, 1, 1, "", "AutotagPDFOptions"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions": [[12, 1, 1, "", "Builder"], [12, 2, 1, "", "builder"], [12, 3, 1, "", "generate_report"], [12, 3, 1, "", "shift_headings"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "with_generate_report"], [12, 2, 1, "", "with_shift_headings"]], "adobe.pdfservices.operation.pdfops.options.extractpdf": [[9, 0, 0, "-", "extract_element_type"], [9, 0, 0, "-", "extract_pdf_options"], [9, 0, 0, "-", "extract_renditions_element_type"], [9, 0, 0, "-", "table_structure_type"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type": [[9, 1, 1, "", "ExtractElementType"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType": [[9, 5, 1, "", "TABLES"], [9, 5, 1, "", "TEXT"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options": [[12, 1, 1, "", "ExtractPDFOptions"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions": [[12, 1, 1, "", "Builder"], [12, 2, 1, "", "builder"], [12, 3, 1, "", "elements_to_extract"], [12, 3, 1, "", "elements_to_extract_renditions"], [12, 3, 1, "", "get_char_info"], [12, 3, 1, "", "include_styling_info"], [12, 3, 1, "", "table_output_format"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "with_element_to_extract"], [12, 2, 1, "", "with_element_to_extract_renditions"], [12, 2, 1, "", "with_elements_to_extract"], [12, 2, 1, "", "with_elements_to_extract_renditions"], [12, 2, 1, "", "with_get_char_info"], [12, 2, 1, "", "with_include_styling_info"], [12, 2, 1, "", "with_table_structure_format"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type": [[9, 1, 1, "", "ExtractRenditionsElementType"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType": [[9, 5, 1, "", "FIGURES"], [9, 5, 1, "", "TABLES"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type": [[9, 1, 1, "", "TableStructureType"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType": [[9, 5, 1, "", "CSV"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:exception", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "exception", "Python exception"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"adob": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "packag": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "subpackag": [0, 1, 2, 6, 7], "modul": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "content": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "pdfservic": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "oper": [2, 3, 4, 5, 6, 7, 8, 9], "submodul": [2, 3, 4, 5, 6, 8, 9], "client_config": 2, "execution_context": 2, "auth": 3, "credenti": [3, 12], "service_account_credenti": 3, "except": [4, 12], "io": 5, "file_ref": 5, "pdfop": [6, 7, 8, 9], "extract_pdf_oper": 6, "autotag_pdf_oper": 6, "option": [7, 8, 9], "autotagpdf": 8, "autotag_pdf_opt": 8, "extractpdf": 9, "extract_pdf_opt": 9, "extract_element_typ": 9, "extract_renditions_element_typ": 9, "table_structure_typ": 9, "sdk": 10, "src": 11, "api": 12, "refer": 12, "clientconfig": 12, "clientconfigbuild": 12, "executioncontext": 12, "extractpdfoper": 12, "extractpdfopt": 12, "autotagpdfoper": 12, "autotagpdfopt": 12, "fileref": 12, "serviceaccountcredenti": 12, "serviceaccountcredentialsbuild": 12, "autotag": []}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"adobe package": [[0, "adobe-package"]], "Subpackages": [[0, "subpackages"], [1, "subpackages"], [2, "subpackages"], [6, "subpackages"], [7, "subpackages"]], "Module contents": [[0, "module-adobe"], [1, "module-adobe.pdfservices"], [4, "module-adobe.pdfservices.operation.exception"], [5, "module-adobe.pdfservices.operation.io"], [9, "module-adobe.pdfservices.operation.pdfops.options.extractpdf"], [2, "module-adobe.pdfservices.operation"], [3, "module-adobe.pdfservices.operation.auth"], [6, "module-adobe.pdfservices.operation.pdfops"], [7, "module-adobe.pdfservices.operation.pdfops.options"], [8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf"]], "adobe.pdfservices package": [[1, "adobe-pdfservices-package"]], "Submodules": [[4, "submodules"], [5, "submodules"], [9, "submodules"], [2, "submodules"], [3, "submodules"], [6, "submodules"], [8, "submodules"]], "adobe.pdfservices.operation.exception package": [[4, "adobe-pdfservices-operation-exception-package"]], "adobe.pdfservices.operation.exception.exceptions module": [[4, "module-adobe.pdfservices.operation.exception.exceptions"]], "adobe.pdfservices.operation.io package": [[5, "adobe-pdfservices-operation-io-package"]], "adobe.pdfservices.operation.io.file_ref module": [[5, "module-adobe.pdfservices.operation.io.file_ref"]], "adobe.pdfservices.operation.pdfops.options.extractpdf package": [[9, "adobe-pdfservices-operation-pdfops-options-extractpdf-package"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options module": [[9, "module-adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type module": [[9, "adobe-pdfservices-operation-pdfops-options-extractpdf-extract-element-type-module"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type module": [[9, "adobe-pdfservices-operation-pdfops-options-extractpdf-extract-renditions-element-type-module"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type module": [[9, "module-adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type"]], "pdfservices-sdk": [[10, "pdfservices-sdk"]], "src": [[11, "src"]], "adobe.pdfservices.operation package": [[2, "adobe-pdfservices-operation-package"]], "adobe.pdfservices.operation.client_config module": [[2, "module-adobe.pdfservices.operation.client_config"]], "adobe.pdfservices.operation.execution_context module": [[2, "module-adobe.pdfservices.operation.execution_context"]], "adobe.pdfservices.operation.operation module": [[2, "module-adobe.pdfservices.operation.operation"]], "adobe.pdfservices.operation.auth package": [[3, "adobe-pdfservices-operation-auth-package"]], "adobe.pdfservices.operation.auth.credentials module": [[3, "module-adobe.pdfservices.operation.auth.credentials"]], "adobe.pdfservices.operation.auth.service_account_credentials module": [[3, "module-adobe.pdfservices.operation.auth.service_account_credentials"]], "adobe.pdfservices.operation.pdfops package": [[6, "adobe-pdfservices-operation-pdfops-package"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation module": [[6, "module-adobe.pdfservices.operation.pdfops.extract_pdf_operation"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation module": [[6, "module-adobe.pdfservices.operation.pdfops.autotag_pdf_operation"]], "adobe.pdfservices.operation.pdfops.options package": [[7, "adobe-pdfservices-operation-pdfops-options-package"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf package": [[8, "adobe-pdfservices-operation-pdfops-options-autotagpdf-package"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options module": [[8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options"]], "API Reference": [[12, "api-reference"]], "ClientConfig": [[12, "clientconfig"]], "ClientConfigBuilder": [[12, "clientconfigbuilder"]], "Credentials": [[12, "credentials"]], "ExecutionContext": [[12, "executioncontext"]], "ExtractPDFOperation": [[12, "extractpdfoperation"]], "ExtractPDFOptions": [[12, "extractpdfoptions"]], "AutotagPDFOperation": [[12, "autotagpdfoperation"]], "AutotagPDFOptions": [[12, "autotagpdfoptions"]], "FileRef": [[12, "fileref"]], "Exceptions": [[12, "module-adobe.pdfservices.operation.exception.exceptions"]], "ServiceAccountCredentials": [[12, "serviceaccountcredentials"]], "ServiceAccountCredentialsBuilder": [[12, "serviceaccountcredentialsbuilder"]]}, "indexentries": {"adobe.pdfservices": [[1, "module-adobe.pdfservices"]], "module": [[1, "module-adobe.pdfservices"], [2, "module-adobe.pdfservices.operation"], [2, "module-adobe.pdfservices.operation.client_config"], [2, "module-adobe.pdfservices.operation.execution_context"], [2, "module-adobe.pdfservices.operation.operation"], [3, "module-adobe.pdfservices.operation.auth"], [3, "module-adobe.pdfservices.operation.auth.credentials"], [3, "module-adobe.pdfservices.operation.auth.service_account_credentials"], [6, "module-adobe.pdfservices.operation.pdfops"], [6, "module-adobe.pdfservices.operation.pdfops.autotag_pdf_operation"], [6, "module-adobe.pdfservices.operation.pdfops.extract_pdf_operation"], [7, "module-adobe.pdfservices.operation.pdfops.options"], [8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf"], [8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options"], [12, "module-adobe.pdfservices.operation.exception.exceptions"]], "clientconfig (class in adobe.pdfservices.operation.client_config)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig"], [12, "adobe.pdfservices.operation.client_config.ClientConfig"]], "clientconfig.builder (class in adobe.pdfservices.operation.client_config)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder"]], "executioncontext (class in adobe.pdfservices.operation.execution_context)": [[2, "adobe.pdfservices.operation.execution_context.ExecutionContext"], [12, "adobe.pdfservices.operation.execution_context.ExecutionContext"]], "operation (class in adobe.pdfservices.operation.operation)": [[2, "adobe.pdfservices.operation.operation.Operation"]], "adobe.pdfservices.operation": [[2, "module-adobe.pdfservices.operation"]], "adobe.pdfservices.operation.client_config": [[2, "module-adobe.pdfservices.operation.client_config"]], "adobe.pdfservices.operation.execution_context": [[2, "module-adobe.pdfservices.operation.execution_context"]], "adobe.pdfservices.operation.operation": [[2, "module-adobe.pdfservices.operation.operation"]], "build() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.build"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.build"]], "builder() (adobe.pdfservices.operation.client_config.clientconfig static method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.builder"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.builder"]], "create() (adobe.pdfservices.operation.execution_context.executioncontext static method)": [[2, "adobe.pdfservices.operation.execution_context.ExecutionContext.create"], [12, "adobe.pdfservices.operation.execution_context.ExecutionContext.create"]], "execute() (adobe.pdfservices.operation.operation.operation method)": [[2, "adobe.pdfservices.operation.operation.Operation.execute"]], "from_file() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.from_file"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.from_file"]], "with_connect_timeout() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_connect_timeout"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_connect_timeout"]], "with_pdf_services_uri() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_pdf_services_uri"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_pdf_services_uri"]], "with_read_timeout() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_read_timeout"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_read_timeout"]], "with_region() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_region"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_region"]], "credentials (class in adobe.pdfservices.operation.auth.credentials)": [[3, "adobe.pdfservices.operation.auth.credentials.Credentials"], [12, "adobe.pdfservices.operation.auth.credentials.Credentials"]], "serviceaccountcredentials (class in adobe.pdfservices.operation.auth.service_account_credentials)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials"]], "serviceaccountcredentials.builder (class in adobe.pdfservices.operation.auth.service_account_credentials)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder"]], "account_id (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.account_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.account_id"]], "adobe.pdfservices.operation.auth": [[3, "module-adobe.pdfservices.operation.auth"]], "adobe.pdfservices.operation.auth.credentials": [[3, "module-adobe.pdfservices.operation.auth.credentials"]], "adobe.pdfservices.operation.auth.service_account_credentials": [[3, "module-adobe.pdfservices.operation.auth.service_account_credentials"]], "build() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.build"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.build"]], "client_id (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_id"]], "client_secret (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_secret"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_secret"]], "from_file() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.from_file"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.from_file"]], "organization_id (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.organization_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.organization_id"]], "private_key (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.private_key"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.private_key"]], "service_account_credentials_builder() (adobe.pdfservices.operation.auth.credentials.credentials static method)": [[3, "adobe.pdfservices.operation.auth.credentials.Credentials.service_account_credentials_builder"], [12, "adobe.pdfservices.operation.auth.credentials.Credentials.service_account_credentials_builder"]], "with_account_id() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_account_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_account_id"]], "with_client_id() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_id"]], "with_client_secret() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_secret"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_secret"]], "with_organization_id() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_organization_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_organization_id"]], "with_private_key() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_private_key"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_private_key"]], "autotagpdfoperation (class in adobe.pdfservices.operation.pdfops.autotag_pdf_operation)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation"]], "extractpdfoperation (class in adobe.pdfservices.operation.pdfops.extract_pdf_operation)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation"]], "supported_source_media_types (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation attribute)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"]], "supported_source_media_types (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation attribute)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"]], "adobe.pdfservices.operation.pdfops": [[6, "module-adobe.pdfservices.operation.pdfops"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation": [[6, "module-adobe.pdfservices.operation.pdfops.autotag_pdf_operation"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation": [[6, "module-adobe.pdfservices.operation.pdfops.extract_pdf_operation"]], "create_new() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation class method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.create_new"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.create_new"]], "create_new() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation class method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.create_new"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.create_new"]], "execute() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.execute"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.execute"]], "execute() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.execute"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.execute"]], "get_options() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.get_options"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.get_options"]], "get_options() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.get_options"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.get_options"]], "set_input() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_input"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_input"]], "set_input() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_input"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_input"]], "set_options() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_options"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_options"]], "set_options() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_options"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_options"]], "adobe.pdfservices.operation.pdfops.options": [[7, "module-adobe.pdfservices.operation.pdfops.options"]], "autotagpdfoptions (class in adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions"]], "autotagpdfoptions.builder (class in adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf": [[8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options": [[8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options"]], "build() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions.builder method)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.build"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.build"]], "builder() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions static method)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.builder"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.builder"]], "generate_report (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions property)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.generate_report"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.generate_report"]], "shift_headings (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions property)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.shift_headings"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.shift_headings"]], "with_generate_report() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions.builder method)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.with_generate_report"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.with_generate_report"]], "with_shift_headings() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions.builder method)": [[8, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.with_shift_headings"], [12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.with_shift_headings"]], "default_error_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.DEFAULT_ERROR_CODE"]], "default_error_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.DEFAULT_ERROR_CODE"]], "default_status_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.DEFAULT_STATUS_CODE"]], "default_status_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.DEFAULT_STATUS_CODE"]], "extractpdfoptions (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions"]], "extractpdfoptions.builder (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder"]], "fileref (class in adobe.pdfservices.operation.io.file_ref)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef"]], "sdkexception": [[12, "adobe.pdfservices.operation.exception.exceptions.SdkException"]], "serviceapiexception": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException"]], "serviceusageexception": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException"]], "adobe.pdfservices.operation.exception.exceptions": [[12, "module-adobe.pdfservices.operation.exception.exceptions"]], "build() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.build"]], "builder() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions static method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.builder"]], "create_from_local_file() (adobe.pdfservices.operation.io.file_ref.fileref static method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.create_from_local_file"]], "create_from_stream() (adobe.pdfservices.operation.io.file_ref.fileref static method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.create_from_stream"]], "elements_to_extract (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.elements_to_extract"]], "elements_to_extract_renditions (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.elements_to_extract_renditions"]], "error_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.error_code"]], "error_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.error_code"]], "get_char_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.get_char_info"]], "get_media_type() (adobe.pdfservices.operation.io.file_ref.fileref method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.get_media_type"]], "include_styling_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.include_styling_info"]], "request_tracking_id (adobe.pdfservices.operation.exception.exceptions.sdkexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.SdkException.request_tracking_id"]], "request_tracking_id (adobe.pdfservices.operation.exception.exceptions.serviceapiexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.request_tracking_id"]], "request_tracking_id (adobe.pdfservices.operation.exception.exceptions.serviceusageexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.request_tracking_id"]], "save_as() (adobe.pdfservices.operation.io.file_ref.fileref method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.save_as"]], "status_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.status_code"]], "status_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.status_code"]], "table_output_format (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.table_output_format"]], "with_element_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_element_to_extract"]], "with_element_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_element_to_extract_renditions"]], "with_elements_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_elements_to_extract"]], "with_elements_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_elements_to_extract_renditions"]], "with_get_char_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_get_char_info"]], "with_include_styling_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_include_styling_info"]], "with_table_structure_format() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_table_structure_format"]], "write_to_stream() (adobe.pdfservices.operation.io.file_ref.fileref method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.write_to_stream"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["adobe", "adobe.pdfservices", "adobe.pdfservices.operation", "adobe.pdfservices.operation.auth", "adobe.pdfservices.operation.exception", "adobe.pdfservices.operation.io", "adobe.pdfservices.operation.pdfops", "adobe.pdfservices.operation.pdfops.options", "adobe.pdfservices.operation.pdfops.options.autotagpdf", "adobe.pdfservices.operation.pdfops.options.extractpdf", "index", "modules", "reference/index"], "filenames": ["adobe.rst", "adobe.pdfservices.rst", "adobe.pdfservices.operation.rst", "adobe.pdfservices.operation.auth.rst", "adobe.pdfservices.operation.exception.rst", "adobe.pdfservices.operation.io.rst", "adobe.pdfservices.operation.pdfops.rst", "adobe.pdfservices.operation.pdfops.options.rst", "adobe.pdfservices.operation.pdfops.options.autotagpdf.rst", "adobe.pdfservices.operation.pdfops.options.extractpdf.rst", "index.rst", "modules.rst", "reference/index.rst"], "titles": ["adobe package", "adobe.pdfservices package", "adobe.pdfservices.operation package", "adobe.pdfservices.operation.auth package", "adobe.pdfservices.operation.exception package", "adobe.pdfservices.operation.io package", "adobe.pdfservices.operation.pdfops package", "adobe.pdfservices.operation.pdfops.options package", "adobe.pdfservices.operation.pdfops.options.autotagpdf package", "adobe.pdfservices.operation.pdfops.options.extractpdf package", "pdfservices-sdk", "src", "API Reference"], "terms": {"pdfservic": [0, 11, 12], "oper": [0, 1, 10, 12], "submodul": [0, 1, 7], "client_config": [0, 1, 12], "execution_context": [0, 1, 6, 12], "auth": [1, 2, 12], "credenti": [1, 2, 4, 6], "service_account_credenti": [1, 2, 12], "except": [1, 2, 6], "io": [1, 2, 6, 12], "file_ref": [1, 2, 6, 12], "pdfop": [1, 2, 12], "extract_pdf_oper": [1, 2, 12], "autotag_pdf_oper": [1, 2, 12], "clientconfig": [1, 2], "builder": [1, 2, 3, 6, 7, 8, 9, 12], "executioncontext": [1, 2, 6], "creat": [1, 2, 3, 5, 6, 12], "execut": [1, 2, 5, 6, 12], "service_account_credentials_build": [2, 3, 12], "serviceaccountcredenti": [2, 3], "account_id": [2, 3, 12], "client_id": [2, 3, 12], "client_secret": [2, 3, 12], "organization_id": [2, 3, 12], "private_kei": [2, 3, 12], "sdkexcept": [2, 4, 6, 12], "request_tracking_id": [2, 4, 12], "serviceapiexcept": [2, 4, 6, 12], "default_error_cod": [2, 4, 12], "default_status_cod": [2, 4, 12], "error_cod": [2, 4, 12], "status_cod": [2, 4, 12], "serviceusageexcept": [2, 4, 6, 12], "fileref": [2, 5, 6], "create_from_local_fil": [2, 5, 6, 12], "create_from_stream": [2, 5, 12], "get_media_typ": [2, 5, 12], "save_a": [2, 5, 6, 12], "write_to_stream": [2, 5, 12], "option": [2, 3, 5, 6, 12], "extractpdfoper": [2, 6, 9], "supported_source_media_typ": [2, 6, 12], "create_new": [2, 6, 12], "get_opt": [2, 6, 12], "set_input": [2, 6, 12], "set_opt": [2, 6, 12], "autotagpdfoper": [2, 6, 8], "class": [2, 3, 5, 6, 8, 9, 10, 12], "base": [2, 3, 4, 5, 6, 8, 9, 12], "object": [2, 3, 8, 9, 12], "encapsul": [2, 12], "api": [2, 3, 4, 6, 10], "request": [2, 4, 12], "configur": [2, 3, 12], "build": [2, 3, 6, 8, 9, 12], "instanc": [2, 3, 5, 6, 8, 9, 12], "return": [2, 3, 4, 5, 6, 8, 9, 12], "new": [2, 3, 6, 12], "built": [2, 3, 12], "from": [2, 3, 5, 6, 9, 12], "current": [2, 3, 9, 12], "state": [2, 3, 12], "thi": [2, 3, 4, 5, 6, 8, 9, 10, 12], "A": [2, 3, 5, 6, 12], "type": [2, 3, 5, 6, 8, 9, 12], "from_fil": [2, 3, 12], "client_config_file_path": [2, 12], "str": [2, 3, 5, 9, 12], "set": [2, 3, 6, 8, 9, 12], "connect": [2, 12], "timeout": [2, 12], "read": [2, 5, 12], "us": [2, 3, 5, 6, 12], "json": [2, 3, 9, 12], "client": [2, 3, 4, 6, 12], "config": [2, 12], "file": [2, 3, 5, 6, 8, 9, 12], "path": [2, 3, 5, 6, 12], "all": [2, 3, 10, 12], "kei": [2, 3, 12], "structur": [2, 3, 6, 9, 12], "ar": [2, 3, 6, 12], "paramet": [2, 3, 5, 6, 8, 9, 12], "add": [2, 3, 6, 8, 9, 12], "ani": [2, 3, 5, 6, 8, 9, 10, 12], "addit": [2, 3, 6, 8, 9, 12], "connecttimeout": [2, 12], "4000": [2, 12], "readtimeout": [2, 12], "20000": [2, 12], "region": [2, 12], "eu": [2, 12], "with_connect_timeout": [2, 12], "connect_timeout": [2, 12], "int": [2, 12], "It": [2, 3, 5, 6, 12], "should": [2, 12], "greater": [2, 12], "than": [2, 12], "zero": [2, 12], "determin": [2, 12], "millisecond": [2, 12], "until": [2, 12], "i": [2, 3, 4, 5, 6, 9, 10, 12], "establish": [2, 12], "call": [2, 3, 4, 5, 6, 12], "default": [2, 4, 5, 12], "valu": [2, 4, 9, 12], "with_read_timeout": [2, 12], "read_timeout": [2, 12], "defin": [2, 8, 9, 12], "The": [2, 3, 4, 5, 6, 8, 9, 12], "number": [2, 12], "wait": [2, 12], "server": [2, 3, 12], "send": [2, 12], "respons": [2, 6, 12], "after": [2, 12], "10000": [2, 12], "with_region": [2, 12], "updat": [2, 12], "relev": [2, 12], "servic": [2, 3, 4, 12], "u": [2, 12], "static": [2, 3, 5, 8, 9, 12], "repres": [2, 4, 5, 12], "context": [2, 6, 12], "an": [2, 3, 4, 5, 6, 8, 9, 12], "typic": [2, 4, 5, 12], "consist": [2, 12], "desir": [2, 12], "authent": [2, 12], "For": [2, 3, 5, 12], "each": [2, 12], "can": [2, 3, 9, 12], "reus": [2, 12], "across": [2, 12], "sampl": [2, 6, 12], "usag": [2, 4, 6, 12], "try": [2, 6, 12], "base_path": [2, 6, 12], "o": [2, 6, 12], "dirnam": [2, 6, 12], "abspath": [2, 6, 12], "__file__": [2, 6, 12], "sourc": [2, 6, 12], "resourc": [2, 6, 12], "extractpdfinput": [2, 6, 12], "pdf": [2, 3, 6, 8, 9, 12], "extract_pdf_opt": [2, 6, 7, 12], "extractpdfopt": [2, 6, 7, 9], "with_elements_to_extract": [2, 6, 9, 12], "extractelementtyp": [2, 6, 7, 9, 12], "text": [2, 6, 7, 9, 12], "tabl": [2, 6, 7, 9, 12], "with_elements_to_extract_rendit": [2, 6, 9, 12], "extractrenditionselementtyp": [2, 6, 7, 9, 12], "figur": [2, 6, 7, 9, 12], "with_get_char_info": [2, 6, 9, 12], "true": [2, 6, 9, 12], "result": [2, 4, 6, 12], "output": [2, 6, 8, 9, 12], "extracttexttablewithfiguretablerendit": [2, 6, 12], "zip": [2, 6, 12], "log": [2, 6, 12], "encount": [2, 6, 12], "while": [2, 5, 6, 12], "none": [2, 4, 5, 9, 12], "provid": [2, 5, 6, 12], "custom": [2, 12], "http": [2, 4, 12], "abc": [2, 3, 5, 12], "abstract": [2, 5, 12], "marker": [3, 12], "differ": [3, 12], "support": [3, 6, 9, 12], "onli": [9, 12], "factori": [3, 12], "method": [3, 5, 12], "within": [3, 6, 12], "account": [3, 12], "allow": [3, 12], "your": [3, 12], "applic": [3, 12], "tool": [], "extract": [6, 9, 12], "behalf": [3, 12], "itself": [3, 12], "enterpris": [3, 12], "organ": [3, 12], "get": [3, 6, 10, 12], "click": [3, 10, 12], "here": [3, 12], "credentials_file_path": [3, 12], "client_credenti": [3, 12], "org_id": [3, 12], "adobeorg": [3, 12], "id": [3, 4, 12], "techacct": [3, 12], "com": [3, 12], "private_key_fil": [3, 12], "privat": [3, 12], "look": [3, 12], "up": [3, 6, 12], "classpath": [3, 12], "directori": [3, 5, 6, 12], "with_account_id": [3, 12], "format": [3, 5, 6, 9, 12], "with_client_id": [2, 3, 6, 12], "with_client_secret": [2, 3, 6, 12], "secret": [3, 12], "with_organization_id": [3, 12], "ha": [3, 4, 12], "been": [3, 4, 12], "access": [3, 6, 12], "with_private_kei": [3, 12], "pem": [3, 12], "properti": [3, 4, 8, 9, 12], "identifi": [3, 5, 12], "messag": [4, 12], "thrown": [4, 12], "side": [4, 12], "network": [4, 12], "error": [4, 6, 12], "track": [4, 12], "0": [3, 4, 12], "unknown": [4, 12], "when": [4, 5, 12], "underli": [4, 12], "statu": [4, 12], "code": [4, 12], "doesn": [4, 12], "t": [4, 12], "adequ": [4, 12], "detail": [4, 6, 12], "429": [4, 12], "serviceusageerror": [4, 12], "either": [4, 5, 12], "limit": [4, 12], "reach": [4, 12], "quota": [4, 12], "exhaust": [4, 12], "failur": [4, 12], "local": [5, 12], "sdk": [5, 12], "which": [5, 6, 9, 12], "accept": [5, 12], "refer": [5, 10], "temporari": [5, 6, 12], "locat": [5, 12], "save": [5, 12], "exampl": [5, 12], "etc": [5, 12], "delet": [5, 12], "local_sourc": [5, 12], "media_typ": [5, 12], "If": [5, 12], "media": [5, 12], "infer": [5, 12], "extens": [5, 12], "absolut": [5, 12], "rel": [5, 12], "work": [5, 12], "input_stream": [5, 12], "bufferedread": [5, 12], "readabl": [5, 12], "stream": [5, 12], "specifi": [5, 8, 9, 12], "consum": [5, 12], "e": [5, 6, 12], "local_file_path": [5, 12], "writer_stream": [5, 12], "extractpdf": [6, 7, 12], "extract_element_typ": [6, 7], "extract_renditions_element_typ": [6, 7], "table_structure_typ": [6, 7], "autotagpdf": [6, 7, 12], "autotag_pdf_opt": [6, 7, 12], "create_kei": [6, 12], "element": [6, 9, 12], "along": [6, 12], "rendit": [6, 9, 12], "with_include_styling_info": [6, 9, 12], "intern": [6, 12], "extension_media_type_map": [6, 12], "extensionmediatypemap": [6, 12], "mime_typ": [6, 12], "classmethod": [6, 12], "synchron": [6, 12], "suppli": [6, 12], "mai": [6, 12], "store": [6, 12], "system": [6, 12], "see": [6, 12], "how": [6, 12], "clean": [6, 12], "rais": [6, 9, 12], "source_file_ref": [6, 12], "input": [6, 9, 12], "enabl": [6, 12], "improv": [6, 12], "document": [6, 10, 12], "gener": [6, 8, 12], "tag": [6, 8, 12], "xlsx": [6, 8, 12], "report": [6, 8, 12], "inform": [6, 8, 9, 12], "about": [6, 8, 12], "ad": [6, 12], "replac": [6, 12], "exist": [6, 12], "so": [6, 12], "most": [6, 12], "benefit": [6, 12], "have": [6, 9, 12], "low": [6, 12], "qualiti": [6, 12], "input_file_path": [6, 12], "autotagpdfinput": [6, 12], "autotagpdfopt": [6, 7, 8], "with_shift_head": [6, 8, 12], "with_generate_report": [6, 8, 12], "autotag_pdf_output": [6, 12], "autotagpdfoutput": [6, 12], "input_file_nam": [6, 12], "stem": [6, 12], "base_output_path": [6, 12], "autotagpdfwithopt": [6, 12], "mkdir": [6, 12], "parent": [6, 12], "exist_ok": [6, 12], "tagged_pdf_path": [6, 12], "f": [6, 12], "report_path": [6, 12], "get_tagged_pdf": [6, 12], "get_report": [6, 12], "elements_to_extract": [7, 9, 12], "elements_to_extract_rendit": [7, 9, 12], "get_char_info": [7, 9, 12], "include_styling_info": [7, 9, 12], "table_output_format": [7, 9, 12], "tablestructuretyp": [7, 9, 12], "csv": [7, 9, 12], "generate_report": [7, 8, 12], "shift_head": [7, 8, 12], "boolean": [8, 9, 12], "whether": [8, 9, 12], "contain": [8, 12], "shift": [8, 12], "head": [8, 12], "with_table_structure_format": [9, 12], "with_element_to_extract": [9, 12], "element_to_extract": [9, 12], "valueerror": [9, 12], "with_element_to_extract_rendit": [9, 12], "element_to_extract_rendit": [9, 12], "whose": [9, 12], "list": [9, 12], "empti": [9, 12], "bool": [9, 12], "charact": [9, 12], "level": [9, 12], "bound": [9, 12], "box": [9, 12], "style": [9, 12], "info": [9, 12], "table_structur": [9, 12], "need": [9, 12], "export": [9, 12], "enum": 9, "elementtyp": 9, "expos": 10, "modul": [10, 11], "pleas": [3, 10, 12], "section": 10, "left": 10, "nav": 10, "start": 10, "adob": [11, 12], "packag": 11, "subpackag": 11, "content": [11, 12], "with_pdf_services_uri": [2, 12], "pdf_services_uri": [2, 12], "uri": [2, 12], "service_principal_credenti": [1, 2, 12], "service_principal_credentials_build": [2, 3, 6, 12], "serviceprincipalcredenti": [2, 3], "deprec": [3, 12], "sinc": [3, 12], "version": [3, 12], "2": [3, 12], "3": [3, 12], "notic": [3, 12], "jwt": [3, 12], "oauth": [3, 12], "princip": [3, 12], "getenv": [2, 6, 12], "pdf_services_client_id": [2, 6, 12], "pdf_services_client_secret": [2, 6, 12]}, "objects": {"": [[0, 0, 0, "-", "adobe"]], "adobe": [[1, 0, 0, "-", "pdfservices"]], "adobe.pdfservices": [[2, 0, 0, "-", "operation"]], "adobe.pdfservices.operation": [[3, 0, 0, "-", "auth"], [2, 0, 0, "-", "client_config"], [4, 0, 0, "-", "exception"], [2, 0, 0, "-", "execution_context"], [5, 0, 0, "-", "io"], [2, 0, 0, "-", "operation"], [6, 0, 0, "-", "pdfops"]], "adobe.pdfservices.operation.auth": [[3, 0, 0, "-", "credentials"], [3, 0, 0, "-", "service_account_credentials"], [3, 0, 0, "-", "service_principal_credentials"]], "adobe.pdfservices.operation.auth.credentials": [[12, 1, 1, "", "Credentials"]], "adobe.pdfservices.operation.auth.credentials.Credentials": [[12, 2, 1, "", "service_account_credentials_builder"], [12, 2, 1, "", "service_principal_credentials_builder"]], "adobe.pdfservices.operation.auth.service_account_credentials": [[12, 1, 1, "", "ServiceAccountCredentials"]], "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials": [[12, 1, 1, "", "Builder"], [12, 3, 1, "", "account_id"], [12, 3, 1, "", "client_id"], [12, 3, 1, "", "client_secret"], [12, 3, 1, "", "organization_id"], [12, 3, 1, "", "private_key"]], "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "from_file"], [12, 2, 1, "", "with_account_id"], [12, 2, 1, "", "with_client_id"], [12, 2, 1, "", "with_client_secret"], [12, 2, 1, "", "with_organization_id"], [12, 2, 1, "", "with_private_key"]], "adobe.pdfservices.operation.auth.service_principal_credentials": [[12, 1, 1, "", "ServicePrincipalCredentials"]], "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials": [[12, 1, 1, "", "Builder"], [12, 3, 1, "", "client_id"], [12, 3, 1, "", "client_secret"]], "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "with_client_id"], [12, 2, 1, "", "with_client_secret"]], "adobe.pdfservices.operation.client_config": [[12, 1, 1, "", "ClientConfig"]], "adobe.pdfservices.operation.client_config.ClientConfig": [[12, 1, 1, "", "Builder"], [12, 2, 1, "", "builder"]], "adobe.pdfservices.operation.client_config.ClientConfig.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "from_file"], [12, 2, 1, "", "with_connect_timeout"], [12, 2, 1, "", "with_pdf_services_uri"], [12, 2, 1, "", "with_read_timeout"], [12, 2, 1, "", "with_region"]], "adobe.pdfservices.operation.exception": [[12, 0, 0, "-", "exceptions"]], "adobe.pdfservices.operation.exception.exceptions": [[12, 4, 1, "", "SdkException"], [12, 4, 1, "", "ServiceApiException"], [12, 4, 1, "", "ServiceUsageException"]], "adobe.pdfservices.operation.exception.exceptions.SdkException": [[12, 3, 1, "", "request_tracking_id"]], "adobe.pdfservices.operation.exception.exceptions.ServiceApiException": [[12, 5, 1, "", "DEFAULT_ERROR_CODE"], [12, 5, 1, "", "DEFAULT_STATUS_CODE"], [12, 3, 1, "", "error_code"], [12, 3, 1, "", "request_tracking_id"], [12, 3, 1, "", "status_code"]], "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException": [[12, 5, 1, "", "DEFAULT_ERROR_CODE"], [12, 5, 1, "", "DEFAULT_STATUS_CODE"], [12, 3, 1, "", "error_code"], [12, 3, 1, "", "request_tracking_id"], [12, 3, 1, "", "status_code"]], "adobe.pdfservices.operation.execution_context": [[12, 1, 1, "", "ExecutionContext"]], "adobe.pdfservices.operation.execution_context.ExecutionContext": [[12, 2, 1, "", "create"]], "adobe.pdfservices.operation.io": [[5, 0, 0, "-", "file_ref"]], "adobe.pdfservices.operation.io.file_ref": [[12, 1, 1, "", "FileRef"]], "adobe.pdfservices.operation.io.file_ref.FileRef": [[12, 2, 1, "", "create_from_local_file"], [12, 2, 1, "", "create_from_stream"], [12, 2, 1, "", "get_media_type"], [12, 2, 1, "", "save_as"], [12, 2, 1, "", "write_to_stream"]], "adobe.pdfservices.operation.operation": [[2, 1, 1, "", "Operation"]], "adobe.pdfservices.operation.operation.Operation": [[2, 2, 1, "", "execute"]], "adobe.pdfservices.operation.pdfops": [[6, 0, 0, "-", "autotag_pdf_operation"], [6, 0, 0, "-", "extract_pdf_operation"], [7, 0, 0, "-", "options"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation": [[12, 1, 1, "", "AutotagPDFOperation"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation": [[12, 5, 1, "", "SUPPORTED_SOURCE_MEDIA_TYPES"], [12, 2, 1, "", "create_new"], [12, 2, 1, "", "execute"], [12, 2, 1, "", "get_options"], [12, 2, 1, "", "set_input"], [12, 2, 1, "", "set_options"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation": [[12, 1, 1, "", "ExtractPDFOperation"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation": [[12, 5, 1, "", "SUPPORTED_SOURCE_MEDIA_TYPES"], [12, 2, 1, "", "create_new"], [12, 2, 1, "", "execute"], [12, 2, 1, "", "get_options"], [12, 2, 1, "", "set_input"], [12, 2, 1, "", "set_options"]], "adobe.pdfservices.operation.pdfops.options": [[8, 0, 0, "-", "autotagpdf"], [9, 0, 0, "-", "extractpdf"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf": [[8, 0, 0, "-", "autotag_pdf_options"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options": [[12, 1, 1, "", "AutotagPDFOptions"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions": [[12, 1, 1, "", "Builder"], [12, 2, 1, "", "builder"], [12, 3, 1, "", "generate_report"], [12, 3, 1, "", "shift_headings"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "with_generate_report"], [12, 2, 1, "", "with_shift_headings"]], "adobe.pdfservices.operation.pdfops.options.extractpdf": [[9, 0, 0, "-", "extract_element_type"], [9, 0, 0, "-", "extract_pdf_options"], [9, 0, 0, "-", "extract_renditions_element_type"], [9, 0, 0, "-", "table_structure_type"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type": [[9, 1, 1, "", "ExtractElementType"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType": [[9, 5, 1, "", "TABLES"], [9, 5, 1, "", "TEXT"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options": [[12, 1, 1, "", "ExtractPDFOptions"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions": [[12, 1, 1, "", "Builder"], [12, 2, 1, "", "builder"], [12, 3, 1, "", "elements_to_extract"], [12, 3, 1, "", "elements_to_extract_renditions"], [12, 3, 1, "", "get_char_info"], [12, 3, 1, "", "include_styling_info"], [12, 3, 1, "", "table_output_format"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder": [[12, 2, 1, "", "build"], [12, 2, 1, "", "with_element_to_extract"], [12, 2, 1, "", "with_element_to_extract_renditions"], [12, 2, 1, "", "with_elements_to_extract"], [12, 2, 1, "", "with_elements_to_extract_renditions"], [12, 2, 1, "", "with_get_char_info"], [12, 2, 1, "", "with_include_styling_info"], [12, 2, 1, "", "with_table_structure_format"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type": [[9, 1, 1, "", "ExtractRenditionsElementType"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType": [[9, 5, 1, "", "FIGURES"], [9, 5, 1, "", "TABLES"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type": [[9, 1, 1, "", "TableStructureType"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType": [[9, 5, 1, "", "CSV"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:exception", "5": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "exception", "Python exception"], "5": ["py", "attribute", "Python attribute"]}, "titleterms": {"adob": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "packag": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "subpackag": [0, 1, 2, 6, 7], "modul": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "content": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "pdfservic": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "oper": [2, 3, 4, 5, 6, 7, 8, 9], "submodul": [2, 3, 4, 5, 6, 8, 9], "client_config": 2, "execution_context": 2, "auth": 3, "credenti": [3, 12], "service_account_credenti": 3, "except": [4, 12], "io": 5, "file_ref": 5, "pdfop": [6, 7, 8, 9], "extract_pdf_oper": 6, "autotag_pdf_oper": 6, "option": [7, 8, 9], "autotagpdf": 8, "autotag_pdf_opt": 8, "extractpdf": 9, "extract_pdf_opt": 9, "extract_element_typ": 9, "extract_renditions_element_typ": 9, "table_structure_typ": 9, "sdk": 10, "src": 11, "api": 12, "refer": 12, "clientconfig": 12, "clientconfigbuild": 12, "executioncontext": 12, "extractpdfoper": 12, "extractpdfopt": 12, "autotagpdfoper": 12, "autotagpdfopt": 12, "fileref": 12, "serviceaccountcredenti": 12, "serviceaccountcredentialsbuild": 12, "autotag": [], "service_principal_credenti": 3, "serviceprincipalcredenti": 12, "serviceprincipalcredentialsbuild": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"adobe package": [[0, "adobe-package"]], "Subpackages": [[0, "subpackages"], [1, "subpackages"], [7, "subpackages"], [2, "subpackages"], [6, "subpackages"]], "Module contents": [[0, "module-adobe"], [1, "module-adobe.pdfservices"], [4, "module-adobe.pdfservices.operation.exception"], [5, "module-adobe.pdfservices.operation.io"], [9, "module-adobe.pdfservices.operation.pdfops.options.extractpdf"], [7, "module-adobe.pdfservices.operation.pdfops.options"], [8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf"], [2, "module-adobe.pdfservices.operation"], [3, "module-adobe.pdfservices.operation.auth"], [6, "module-adobe.pdfservices.operation.pdfops"]], "adobe.pdfservices package": [[1, "adobe-pdfservices-package"]], "Submodules": [[4, "submodules"], [5, "submodules"], [9, "submodules"], [8, "submodules"], [2, "submodules"], [3, "submodules"], [6, "submodules"]], "adobe.pdfservices.operation.exception package": [[4, "adobe-pdfservices-operation-exception-package"]], "adobe.pdfservices.operation.exception.exceptions module": [[4, "module-adobe.pdfservices.operation.exception.exceptions"]], "adobe.pdfservices.operation.io package": [[5, "adobe-pdfservices-operation-io-package"]], "adobe.pdfservices.operation.io.file_ref module": [[5, "module-adobe.pdfservices.operation.io.file_ref"]], "adobe.pdfservices.operation.pdfops.options.extractpdf package": [[9, "adobe-pdfservices-operation-pdfops-options-extractpdf-package"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options module": [[9, "module-adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type module": [[9, "adobe-pdfservices-operation-pdfops-options-extractpdf-extract-element-type-module"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type module": [[9, "adobe-pdfservices-operation-pdfops-options-extractpdf-extract-renditions-element-type-module"]], "adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type module": [[9, "module-adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type"]], "pdfservices-sdk": [[10, "pdfservices-sdk"]], "src": [[11, "src"]], "adobe.pdfservices.operation.pdfops.options package": [[7, "adobe-pdfservices-operation-pdfops-options-package"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf package": [[8, "adobe-pdfservices-operation-pdfops-options-autotagpdf-package"]], "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options module": [[8, "module-adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options"]], "adobe.pdfservices.operation package": [[2, "adobe-pdfservices-operation-package"]], "adobe.pdfservices.operation.client_config module": [[2, "module-adobe.pdfservices.operation.client_config"]], "adobe.pdfservices.operation.execution_context module": [[2, "module-adobe.pdfservices.operation.execution_context"]], "adobe.pdfservices.operation.operation module": [[2, "module-adobe.pdfservices.operation.operation"]], "adobe.pdfservices.operation.auth package": [[3, "adobe-pdfservices-operation-auth-package"]], "adobe.pdfservices.operation.auth.credentials module": [[3, "module-adobe.pdfservices.operation.auth.credentials"]], "adobe.pdfservices.operation.auth.service_account_credentials module": [[3, "module-adobe.pdfservices.operation.auth.service_account_credentials"]], "adobe.pdfservices.operation.auth.service_principal_credentials module": [[3, "adobe-pdfservices-operation-auth-service-principal-credentials-module"]], "adobe.pdfservices.operation.pdfops package": [[6, "adobe-pdfservices-operation-pdfops-package"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation module": [[6, "module-adobe.pdfservices.operation.pdfops.extract_pdf_operation"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation module": [[6, "module-adobe.pdfservices.operation.pdfops.autotag_pdf_operation"]], "API Reference": [[12, "api-reference"]], "ClientConfig": [[12, "clientconfig"]], "ClientConfigBuilder": [[12, "clientconfigbuilder"]], "Credentials": [[12, "credentials"]], "ExecutionContext": [[12, "executioncontext"]], "ExtractPDFOperation": [[12, "extractpdfoperation"]], "ExtractPDFOptions": [[12, "extractpdfoptions"]], "AutotagPDFOperation": [[12, "autotagpdfoperation"]], "AutotagPDFOptions": [[12, "autotagpdfoptions"]], "FileRef": [[12, "fileref"]], "Exceptions": [[12, "module-adobe.pdfservices.operation.exception.exceptions"]], "ServiceAccountCredentials": [[12, "serviceaccountcredentials"]], "ServiceAccountCredentialsBuilder": [[12, "serviceaccountcredentialsbuilder"]], "ServicePrincipalCredentials": [[12, "serviceprincipalcredentials"]], "ServicePrincipalCredentialsBuilder": [[12, "serviceprincipalcredentialsbuilder"]]}, "indexentries": {"adobe.pdfservices": [[1, "module-adobe.pdfservices"]], "module": [[1, "module-adobe.pdfservices"], [2, "module-adobe.pdfservices.operation"], [2, "module-adobe.pdfservices.operation.client_config"], [2, "module-adobe.pdfservices.operation.execution_context"], [2, "module-adobe.pdfservices.operation.operation"], [3, "module-adobe.pdfservices.operation.auth"], [3, "module-adobe.pdfservices.operation.auth.credentials"], [3, "module-adobe.pdfservices.operation.auth.service_account_credentials"], [3, "module-adobe.pdfservices.operation.auth.service_principal_credentials"], [6, "module-adobe.pdfservices.operation.pdfops"], [6, "module-adobe.pdfservices.operation.pdfops.autotag_pdf_operation"], [6, "module-adobe.pdfservices.operation.pdfops.extract_pdf_operation"], [12, "module-adobe.pdfservices.operation.exception.exceptions"]], "clientconfig (class in adobe.pdfservices.operation.client_config)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig"], [12, "adobe.pdfservices.operation.client_config.ClientConfig"]], "clientconfig.builder (class in adobe.pdfservices.operation.client_config)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder"]], "executioncontext (class in adobe.pdfservices.operation.execution_context)": [[2, "adobe.pdfservices.operation.execution_context.ExecutionContext"], [12, "adobe.pdfservices.operation.execution_context.ExecutionContext"]], "operation (class in adobe.pdfservices.operation.operation)": [[2, "adobe.pdfservices.operation.operation.Operation"]], "adobe.pdfservices.operation": [[2, "module-adobe.pdfservices.operation"]], "adobe.pdfservices.operation.client_config": [[2, "module-adobe.pdfservices.operation.client_config"]], "adobe.pdfservices.operation.execution_context": [[2, "module-adobe.pdfservices.operation.execution_context"]], "adobe.pdfservices.operation.operation": [[2, "module-adobe.pdfservices.operation.operation"]], "build() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.build"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.build"]], "builder() (adobe.pdfservices.operation.client_config.clientconfig static method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.builder"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.builder"]], "create() (adobe.pdfservices.operation.execution_context.executioncontext static method)": [[2, "adobe.pdfservices.operation.execution_context.ExecutionContext.create"], [12, "adobe.pdfservices.operation.execution_context.ExecutionContext.create"]], "execute() (adobe.pdfservices.operation.operation.operation method)": [[2, "adobe.pdfservices.operation.operation.Operation.execute"]], "from_file() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.from_file"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.from_file"]], "with_connect_timeout() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_connect_timeout"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_connect_timeout"]], "with_pdf_services_uri() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_pdf_services_uri"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_pdf_services_uri"]], "with_read_timeout() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_read_timeout"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_read_timeout"]], "with_region() (adobe.pdfservices.operation.client_config.clientconfig.builder method)": [[2, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_region"], [12, "adobe.pdfservices.operation.client_config.ClientConfig.Builder.with_region"]], "credentials (class in adobe.pdfservices.operation.auth.credentials)": [[3, "adobe.pdfservices.operation.auth.credentials.Credentials"], [12, "adobe.pdfservices.operation.auth.credentials.Credentials"]], "serviceaccountcredentials (class in adobe.pdfservices.operation.auth.service_account_credentials)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials"]], "serviceaccountcredentials.builder (class in adobe.pdfservices.operation.auth.service_account_credentials)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder"]], "serviceprincipalcredentials (class in adobe.pdfservices.operation.auth.service_principal_credentials)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials"]], "serviceprincipalcredentials.builder (class in adobe.pdfservices.operation.auth.service_principal_credentials)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder"]], "account_id (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.account_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.account_id"]], "adobe.pdfservices.operation.auth": [[3, "module-adobe.pdfservices.operation.auth"]], "adobe.pdfservices.operation.auth.credentials": [[3, "module-adobe.pdfservices.operation.auth.credentials"]], "adobe.pdfservices.operation.auth.service_account_credentials": [[3, "module-adobe.pdfservices.operation.auth.service_account_credentials"]], "adobe.pdfservices.operation.auth.service_principal_credentials": [[3, "module-adobe.pdfservices.operation.auth.service_principal_credentials"]], "build() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.build"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.build"]], "build() (adobe.pdfservices.operation.auth.service_principal_credentials.serviceprincipalcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder.build"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder.build"]], "client_id (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_id"]], "client_id (adobe.pdfservices.operation.auth.service_principal_credentials.serviceprincipalcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.client_id"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.client_id"]], "client_secret (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_secret"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.client_secret"]], "client_secret (adobe.pdfservices.operation.auth.service_principal_credentials.serviceprincipalcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.client_secret"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.client_secret"]], "from_file() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.from_file"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.from_file"]], "organization_id (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.organization_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.organization_id"]], "private_key (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials property)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.private_key"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.private_key"]], "service_account_credentials_builder() (adobe.pdfservices.operation.auth.credentials.credentials static method)": [[3, "adobe.pdfservices.operation.auth.credentials.Credentials.service_account_credentials_builder"], [12, "adobe.pdfservices.operation.auth.credentials.Credentials.service_account_credentials_builder"]], "service_principal_credentials_builder() (adobe.pdfservices.operation.auth.credentials.credentials static method)": [[3, "adobe.pdfservices.operation.auth.credentials.Credentials.service_principal_credentials_builder"], [12, "adobe.pdfservices.operation.auth.credentials.Credentials.service_principal_credentials_builder"]], "with_account_id() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_account_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_account_id"]], "with_client_id() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_id"]], "with_client_id() (adobe.pdfservices.operation.auth.service_principal_credentials.serviceprincipalcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder.with_client_id"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder.with_client_id"]], "with_client_secret() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_secret"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_client_secret"]], "with_client_secret() (adobe.pdfservices.operation.auth.service_principal_credentials.serviceprincipalcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder.with_client_secret"], [12, "adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder.with_client_secret"]], "with_organization_id() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_organization_id"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_organization_id"]], "with_private_key() (adobe.pdfservices.operation.auth.service_account_credentials.serviceaccountcredentials.builder method)": [[3, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_private_key"], [12, "adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder.with_private_key"]], "autotagpdfoperation (class in adobe.pdfservices.operation.pdfops.autotag_pdf_operation)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation"]], "extractpdfoperation (class in adobe.pdfservices.operation.pdfops.extract_pdf_operation)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation"]], "supported_source_media_types (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation attribute)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"]], "supported_source_media_types (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation attribute)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.SUPPORTED_SOURCE_MEDIA_TYPES"]], "adobe.pdfservices.operation.pdfops": [[6, "module-adobe.pdfservices.operation.pdfops"]], "adobe.pdfservices.operation.pdfops.autotag_pdf_operation": [[6, "module-adobe.pdfservices.operation.pdfops.autotag_pdf_operation"]], "adobe.pdfservices.operation.pdfops.extract_pdf_operation": [[6, "module-adobe.pdfservices.operation.pdfops.extract_pdf_operation"]], "create_new() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation class method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.create_new"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.create_new"]], "create_new() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation class method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.create_new"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.create_new"]], "execute() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.execute"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.execute"]], "execute() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.execute"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.execute"]], "get_options() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.get_options"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.get_options"]], "get_options() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.get_options"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.get_options"]], "set_input() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_input"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_input"]], "set_input() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_input"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_input"]], "set_options() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.autotagpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_options"], [12, "adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation.set_options"]], "set_options() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.extractpdfoperation method)": [[6, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_options"], [12, "adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation.set_options"]], "autotagpdfoptions (class in adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions"]], "autotagpdfoptions.builder (class in adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder"]], "default_error_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.DEFAULT_ERROR_CODE"]], "default_error_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.DEFAULT_ERROR_CODE"]], "default_status_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.DEFAULT_STATUS_CODE"]], "default_status_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception attribute)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.DEFAULT_STATUS_CODE"]], "extractpdfoptions (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions"]], "extractpdfoptions.builder (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder"]], "fileref (class in adobe.pdfservices.operation.io.file_ref)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef"]], "sdkexception": [[12, "adobe.pdfservices.operation.exception.exceptions.SdkException"]], "serviceapiexception": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException"]], "serviceusageexception": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException"]], "adobe.pdfservices.operation.exception.exceptions": [[12, "module-adobe.pdfservices.operation.exception.exceptions"]], "build() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.build"]], "build() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.build"]], "builder() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions static method)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.builder"]], "builder() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions static method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.builder"]], "create_from_local_file() (adobe.pdfservices.operation.io.file_ref.fileref static method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.create_from_local_file"]], "create_from_stream() (adobe.pdfservices.operation.io.file_ref.fileref static method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.create_from_stream"]], "elements_to_extract (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.elements_to_extract"]], "elements_to_extract_renditions (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.elements_to_extract_renditions"]], "error_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.error_code"]], "error_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.error_code"]], "generate_report (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.generate_report"]], "get_char_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.get_char_info"]], "get_media_type() (adobe.pdfservices.operation.io.file_ref.fileref method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.get_media_type"]], "include_styling_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.include_styling_info"]], "request_tracking_id (adobe.pdfservices.operation.exception.exceptions.sdkexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.SdkException.request_tracking_id"]], "request_tracking_id (adobe.pdfservices.operation.exception.exceptions.serviceapiexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.request_tracking_id"]], "request_tracking_id (adobe.pdfservices.operation.exception.exceptions.serviceusageexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.request_tracking_id"]], "save_as() (adobe.pdfservices.operation.io.file_ref.fileref method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.save_as"]], "shift_headings (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.shift_headings"]], "status_code (adobe.pdfservices.operation.exception.exceptions.serviceapiexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceApiException.status_code"]], "status_code (adobe.pdfservices.operation.exception.exceptions.serviceusageexception property)": [[12, "adobe.pdfservices.operation.exception.exceptions.ServiceUsageException.status_code"]], "table_output_format (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions property)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.table_output_format"]], "with_element_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_element_to_extract"]], "with_element_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_element_to_extract_renditions"]], "with_elements_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_elements_to_extract"]], "with_elements_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_elements_to_extract_renditions"]], "with_generate_report() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.with_generate_report"]], "with_get_char_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_get_char_info"]], "with_include_styling_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_include_styling_info"]], "with_shift_headings() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.autotagpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder.with_shift_headings"]], "with_table_structure_format() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.extractpdfoptions.builder method)": [[12, "adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder.with_table_structure_format"]], "write_to_stream() (adobe.pdfservices.operation.io.file_ref.fileref method)": [[12, "adobe.pdfservices.operation.io.file_ref.FileRef.write_to_stream"]]}}) \ No newline at end of file diff --git a/docs/source/adobe.pdfservices.operation.auth.rst b/docs/source/adobe.pdfservices.operation.auth.rst index a866f39..2aa9de6 100644 --- a/docs/source/adobe.pdfservices.operation.auth.rst +++ b/docs/source/adobe.pdfservices.operation.auth.rst @@ -20,6 +20,14 @@ adobe.pdfservices.operation.auth.service\_account\_credentials module :undoc-members: :show-inheritance: +adobe.pdfservices.operation.auth.service\_principal\_credentials module +--------------------------------------------------------------------- + +.. automodule:: adobe.pdfservices.operation.auth.service_principal_credentials + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index bfa1df5..e5e0295 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -93,5 +93,20 @@ ServiceAccountCredentialsBuilder :show-inheritance: :noindex: +ServicePrincipalCredentials +-------------------------- +.. autoclass:: adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials + :members: + :undoc-members: + :show-inheritance: + +ServicePrincipalCredentialsBuilder +-------------------------------- +.. autoclass:: adobe.pdfservices.operation.auth.service_principal_credentials.ServicePrincipalCredentials.Builder + :members: + :undoc-members: + :show-inheritance: + :noindex: + diff --git a/setup.py b/setup.py index 0ce3e5c..d79b14c 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ def parse_requirements(filename, session=None): setuptools.setup( name="pdfservices-sdk", - version="2.2.0", + version="2.3.0", author='Adobe Document Services', author_email='extractapi@adobe.com', license='Apache2', diff --git a/src/adobe/pdfservices/operation/auth/credentials.py b/src/adobe/pdfservices/operation/auth/credentials.py index ff2a7af..9e3bcfb 100644 --- a/src/adobe/pdfservices/operation/auth/credentials.py +++ b/src/adobe/pdfservices/operation/auth/credentials.py @@ -9,11 +9,18 @@ # governing permissions and limitations under the License. from abc import ABC +from adobe.pdfservices.operation.internal.util.validation_util import is_empty + + +def _is_valid(value, name): + if is_empty(value): + raise ValueError(f'{name} must not be blank') + return value class Credentials(ABC): """ - Marker base class for different types of credentials. Currently it supports only :class:`.ServiceAccountCredentials`. + Marker base class for different types of credentials. Currently it supports :class:`.ServiceAccountCredentials` and :class:`.ServicePrincipalCredentials`. The factory methods within this class can be used to create instances of credentials classes. """ @@ -23,6 +30,19 @@ def service_account_credentials_builder(): :return: An instance of ServiceAccountCredentials Builder. :rtype: ServiceAccountCredentials.Builder + + .. deprecated:: 2.3.0 + Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based :class:`.ServicePrincipalCredentials`. """ from adobe.pdfservices.operation.auth.service_account_credentials import ServiceAccountCredentials return ServiceAccountCredentials.Builder() + + @staticmethod + def service_principal_credentials_builder(): + """ Creates a new :class:`.ServicePrincipalCredentials` builder. + + :return: An instance of ServicePrincipalCredentials Builder. + :rtype: ServicePrincipalCredentials.Builder + """ + from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials + return ServicePrincipalCredentials.Builder() diff --git a/src/adobe/pdfservices/operation/auth/service_account_credentials.py b/src/adobe/pdfservices/operation/auth/service_account_credentials.py index 69a3514..e739ac0 100644 --- a/src/adobe/pdfservices/operation/auth/service_account_credentials.py +++ b/src/adobe/pdfservices/operation/auth/service_account_credentials.py @@ -13,30 +13,24 @@ from adobe.pdfservices.operation.internal.constants.service_constants import ServiceConstants from adobe.pdfservices.operation.internal.util import path_util, file_utils -from .credentials import Credentials -from ..internal.util.validation_util import is_empty - - -def _is_valid(value, name): - if is_empty(value): - raise ValueError(name + " must not be blank") - return value +from .credentials import Credentials, _is_valid class ServiceAccountCredentials(Credentials, ABC): """ - Service Account credentials allow your application to call PDF Tools Extract API on behalf of the application itself, - or on behalf of an enterprise organization. For getting the credentials, - `Click Here `_. - """ + Service Account credentials allow your application to call PDF Services API on behalf of the application itself, + or on behalf of an enterprise organization. + + .. deprecated:: 2.3.0 + Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based :class:`ServicePrincipalCredentials`. + """ - # TODO Can this constructor be excluded from documentation def __init__(self, client_id, client_secret, private_key, organization_id, account_id): - self._client_id = _is_valid(client_id, "client_id") - self._client_secret = _is_valid(client_secret, "client_secret") - self._private_key = _is_valid(private_key, "private_key") - self._organization_id = _is_valid(organization_id, "organization_id") - self._account_id = _is_valid(account_id, "account_id") + self._client_id = _is_valid(client_id, 'client_id') + self._client_secret = _is_valid(client_secret, 'client_secret') + self._private_key = _is_valid(private_key, 'private_key') + self._organization_id = _is_valid(organization_id, 'organization_id') + self._account_id = _is_valid(account_id, 'account_id') @property def client_id(self): @@ -55,7 +49,7 @@ def private_key(self): @property def organization_id(self): - """Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.""" + """ Identifies the organization (format: org_ident@AdobeOrg) that has been configured for access to PDF Services API. """ return self._organization_id @property @@ -124,7 +118,7 @@ def with_private_key(self, private_key: str): return self def with_organization_id(self, organization_id: str): - """ Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API + """ Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Services API :param organization_id: Organization ID (format: org_ident@AdobeOrg) :type organization_id: str @@ -198,6 +192,9 @@ def build(self): :return: A ServiceAccountCredentials instance. :rtype: ServiceAccountCredentials + + .. deprecated:: 2.3.0 + Notice: JWT based service account credentials has been deprecated. Please use OAuth Server-to-Server based :class:`ServicePrincipalCredentials`. """ from adobe.pdfservices.operation.internal.auth.service_account_credentials_with_uri import ServiceAccountCredentialsWithUri diff --git a/src/adobe/pdfservices/operation/auth/service_principal_credentials.py b/src/adobe/pdfservices/operation/auth/service_principal_credentials.py new file mode 100644 index 0000000..73f7e2a --- /dev/null +++ b/src/adobe/pdfservices/operation/auth/service_principal_credentials.py @@ -0,0 +1,82 @@ +# Copyright 2023 Adobe. All rights reserved. +# This file is licensed to you under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. You may obtain a copy +# of the License at http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS +# OF ANY KIND, either express or implied. See the License for the specific language +# governing permissions and limitations under the License. + +import json +import os +from abc import ABC + +from adobe.pdfservices.operation.internal.constants.service_constants import ServiceConstants +from adobe.pdfservices.operation.internal.util import path_util, file_utils +from .credentials import Credentials, _is_valid + + +class ServicePrincipalCredentials(Credentials, ABC): + """ + OAuth Server-to-Server based Service Principal credentials allow your application to call PDF Services API on behalf of the application itself, + or on behalf of an enterprise organization. For getting the credentials, + `Click Here `_. + """ + + def __init__(self, client_id, client_secret): + self._client_id = _is_valid(client_id, 'client_id') + self._client_secret = _is_valid(client_secret, 'client_secret') + + @property + def client_id(self): + """ Client Id (API Key) """ + return self._client_id + + @property + def client_secret(self): + """ Client Secret""" + return self._client_secret + + class Builder: + """ + Builds a :class:`ServicePrincipalCredentials` instance. + """ + _CLIENT_ID = "client_id" + _CLIENT_SECRET = "client_secret" + + def __init__(self): + self._client_id = None + self._client_secret = None + return + + def with_client_id(self, client_id: str): + """ Set Client ID (API Key) + + :param client_id: Client Id (API Key) + :type client_id: str + :return: This Builder instance to add any additional parameters. + :rtype: ServicePrincipalCredentials.Builder + """ + self._client_id = client_id + return self + + def with_client_secret(self, client_secret: str): + """ Set Client Secret + + :param client_secret: Client Secret + :type client_secret: str + :return: This Builder instance to add any additional parameters. + :rtype: ServicePrincipalCredentials.Builder + """ + self._client_secret = client_secret + return self + + def build(self): + """ Returns a new :class:`ServicePrincipalCredentials` instance built from the current state of this builder. + + :return: A ServicePrincipalCredentials instance. + :rtype: ServicePrincipalCredentials + """ + + return ServicePrincipalCredentials(self._client_id, self._client_secret) diff --git a/src/adobe/pdfservices/operation/client_config.py b/src/adobe/pdfservices/operation/client_config.py index 616a2da..0f669a4 100644 --- a/src/adobe/pdfservices/operation/client_config.py +++ b/src/adobe/pdfservices/operation/client_config.py @@ -148,4 +148,4 @@ def build(self): :rtype: ClientConfig """ from adobe.pdfservices.operation.internal.internal_client_config import InternalClientConfig - return InternalClientConfig(self._connect_timeout, self._read_timeout, self._pdf_services_uri) \ No newline at end of file + return InternalClientConfig(self._connect_timeout, self._read_timeout, self._pdf_services_uri) diff --git a/src/adobe/pdfservices/operation/execution_context.py b/src/adobe/pdfservices/operation/execution_context.py index f094964..98940c8 100644 --- a/src/adobe/pdfservices/operation/execution_context.py +++ b/src/adobe/pdfservices/operation/execution_context.py @@ -26,9 +26,10 @@ class ExecutionContext: try: base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) - credentials = Credentials.service_account_credentials_builder() \\ - .from_file(base_path + "/pdfservices-api-credentials.json") \\ - .build() + credentials = Credentials.service_principal_credentials_builder(). \ + with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \ + with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \ + build() execution_context = ExecutionContext.create(credentials) extract_pdf_operation = ExtractPDFOperation.create_new() diff --git a/src/adobe/pdfservices/operation/internal/auth/auth_factory.py b/src/adobe/pdfservices/operation/internal/auth/auth_factory.py index 98cb75c..b20ff25 100644 --- a/src/adobe/pdfservices/operation/internal/auth/auth_factory.py +++ b/src/adobe/pdfservices/operation/internal/auth/auth_factory.py @@ -10,14 +10,19 @@ from adobe.pdfservices.operation.auth.credentials import Credentials from adobe.pdfservices.operation.auth.service_account_credentials import ServiceAccountCredentials +from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials from adobe.pdfservices.operation.internal.auth.jwt_authenticator import JwtAuthenticator +from adobe.pdfservices.operation.internal.auth.service_principal_authenticator import ServicePrincipalAuthenticator +from adobe.pdfservices.operation.internal.internal_client_config import InternalClientConfig class AuthenticatorFactory: @staticmethod - def get_authenticator(credential: Credentials): + def get_authenticator(credential: Credentials, client_config: InternalClientConfig): if isinstance(credential, ServiceAccountCredentials): return JwtAuthenticator(credential) + elif isinstance(credential, ServicePrincipalCredentials): + return ServicePrincipalAuthenticator(credential, client_config) else: raise ValueError("Invalid Credentials provided as argument") diff --git a/src/adobe/pdfservices/operation/internal/auth/jwt_authenticator.py b/src/adobe/pdfservices/operation/internal/auth/jwt_authenticator.py index ca191fe..47576f5 100644 --- a/src/adobe/pdfservices/operation/internal/auth/jwt_authenticator.py +++ b/src/adobe/pdfservices/operation/internal/auth/jwt_authenticator.py @@ -31,6 +31,9 @@ class JwtAuthenticator(Authenticator): + """ + Authenticator for JWT based Service Account credentials + """ token: SessionToken = None service_account_configuration: ServiceAccountCredentialsWithUri jwt_endpoint = '' @@ -41,15 +44,19 @@ def __init__(self, service_account_configuration): pass def session_token(self): + """ Access token for the PDF Services API """ if self.token: if self.older_in_minute() <= 2: return self.token return self.refresh_token() def older_in_minute(self): + """ Time remaining in minutes till token expiry """ return int((datetime.now() - self.token.expired_at).seconds / 60) def refresh_token(self): + """ Refreshes the access token sent to PDF Services API """ + jwt_token = self._prepare_jwt() url = "{jwt_endpoint}/{jwt_uri_suffix}".format( jwt_endpoint=self.service_account_configuration.ims_base_uri, @@ -70,9 +77,12 @@ def refresh_token(self): return self.token def get_api_key(self): + """ API key for Service Account credentials """ return self.service_account_configuration.client_id def handle_ims_failure(self, response): + """ Handling of IMS failure during call to PDF Services API """ + self._logger.error( "IMS call failed with status code {error_code}".format(error_code=response.status_code)) content = json.loads(response.content) @@ -92,6 +102,8 @@ def handle_ims_failure(self, response): request_tracking_id=ResponseUtil.get_request_tracking_id_from_response(response, True)) def _prepare_jwt(self): + """ Prepares the JWT token for the request to PDF Services API """ + audience = "{base_uri}/{audience_suffix}{client_id}".format( base_uri=self.service_account_configuration.ims_base_uri, audience_suffix=ServiceConstants.JWT_AUDIENCE_SUFFIX, diff --git a/src/adobe/pdfservices/operation/internal/auth/service_principal_authenticator.py b/src/adobe/pdfservices/operation/internal/auth/service_principal_authenticator.py new file mode 100644 index 0000000..ed193af --- /dev/null +++ b/src/adobe/pdfservices/operation/internal/auth/service_principal_authenticator.py @@ -0,0 +1,100 @@ +# Copyright 2023 Adobe. All rights reserved. +# This file is licensed to you under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. You may obtain a copy +# of the License at http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS +# OF ANY KIND, either express or implied. See the License for the specific language +# governing permissions and limitations under the License. + +import json +import logging +import sys +from datetime import datetime, timedelta +from http import HTTPStatus + +from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials +from adobe.pdfservices.operation.exception.exceptions import SdkException +from adobe.pdfservices.operation.internal.auth.authenticator import Authenticator +from adobe.pdfservices.operation.internal.auth.session_token import SessionToken +from adobe.pdfservices.operation.internal.constants.request_key import RequestKey +from adobe.pdfservices.operation.internal.exceptions import OperationException +from adobe.pdfservices.operation.internal.http.response_util import ResponseUtil +from adobe.pdfservices.operation.internal.constants.service_constants import ServiceConstants, custom_error_messages +from adobe.pdfservices.operation.internal.http import http_client +from adobe.pdfservices.operation.internal.http.http_method import HttpMethod +from adobe.pdfservices.operation.internal.http.http_request import HttpRequest + + +class ServicePrincipalAuthenticator(Authenticator): + """ + Authenticator for OAuth Server-to-Server based Service Principal credentials + """ + token: SessionToken = None + service_principal_configuration: ServicePrincipalCredentials + token_endpoint = '' + + def __init__(self, service_principal_configuration, client_config): + self.service_principal_configuration = service_principal_configuration + self.token_endpoint = client_config.get_pdf_services_uri() + self._logger = logging.getLogger(__name__) + pass + + def session_token(self): + """ Access token for the PDF Services API """ + if self.token: + if self.older_in_minute() <= 2: + return self.token + return self.refresh_token() + + def older_in_minute(self): + """ Time remaining in minutes till token expiry """ + return int((datetime.now() - self.token.expired_at).seconds / 60) + + def refresh_token(self): + """ Refreshes the access token sent to PDF Services API """ + + url = "{token_endpoint}/{ims_proxy_token_endpoint}".format( + token_endpoint=self.token_endpoint, + ims_proxy_token_endpoint='token' + ) + access_token_request_payload = {"client_id": self.service_principal_configuration.client_id, + "client_secret": self.service_principal_configuration.client_secret} + + try: + http_request = HttpRequest(http_method=HttpMethod.POST, request_key=RequestKey.AUTHN, url=url, + data=access_token_request_payload, headers={}) + response = http_client.process_request(http_request=http_request, success_status_codes=[HTTPStatus.OK], + error_response_handler=self.handle_ims_failure) + + content = json.loads(response.content) + self.token = SessionToken(content['access_token'], content['expires_in']) + except Exception: + raise SdkException("Exception in fetching access token", sys.exc_info()) + return self.token + + def get_api_key(self): + """ API key for Service Principle credentials """ + return self.service_principal_configuration.client_id + + def handle_ims_failure(self, response): + """ Handling of IMS failure during call to PDF Services API """ + + self._logger.error( + "IMS call failed with status code {error_code}".format(error_code=response.status_code)) + content = json.loads(response.content) + # When error is returned with no description + if not content.get("error_description", None) or content["error_description"].isspace(): + content["error_description"] = content.get("error", None) + # Special handling for invalid token and certificate expiry cases + if "invalid_token"==content.get("error", None): + if "Could not match signature to any of the bindings"==content.get("error_description",None): + content["error_description"] = custom_error_messages["imsCertificateExpiredErrorMessage"] + else: + content["error_description"] = custom_error_messages["imsInvalidTokenGenericErrorMessage"] + raise OperationException(message="Error response received for IMS request", + status_code=response.status_code, + error_code=content.get("error", None), + error_message=content.get("error_description", None), + request_tracking_id=ResponseUtil.get_request_tracking_id_from_response(response, True)) diff --git a/src/adobe/pdfservices/operation/internal/constants/service_constants.py b/src/adobe/pdfservices/operation/internal/constants/service_constants.py index 7ca7cbb..07c6fd8 100644 --- a/src/adobe/pdfservices/operation/internal/constants/service_constants.py +++ b/src/adobe/pdfservices/operation/internal/constants/service_constants.py @@ -11,11 +11,11 @@ custom_error_messages = { # Custom IMS error messages - "imsInvalidTokenGenericErrorMessage": 'Either your certificate for PDF Tools API credentials has expired or an ' + + "imsInvalidTokenGenericErrorMessage": 'Either your certificate for PDF Services API credentials has expired or an ' + 'invalid Organization_ID/Account_ID has been used in credentials. Please visit Adobe IO ' + 'Console(http://console.adobe.io/) to update your public certificate to use the same credentials or to check ' + 'the value of Organization Id or Account ID.', - "imsCertificateExpiredErrorMessage": 'Your certificate for PDF Tools API credentials might have expired. ' + + "imsCertificateExpiredErrorMessage": 'Your certificate for PDF Services API credentials might have expired. ' + 'Please visit Adobe IO Console(http://console.adobe.io/) to update your public certificate to use the same ' + 'credentials.', @@ -26,9 +26,9 @@ # Quota specific exception error messages "quotaExhaustedErrorMessage": 'Free trial quota exhausted. Please visit (www.adobe.com/go/pdftoolsapi_err_quota) to ' + - 'upgrade to paid credentials.', + 'upgrade to paid credentials.', "quotaUnavailableErrorMessage": 'Quota for this operation is not available. Please visit ' + - '(www.adobe.com/go/pdftoolsapi_home) to start using free trial quota.' + '(www.adobe.com/go/pdftoolsapi_home) to start using free trial quota.' } diff --git a/src/adobe/pdfservices/operation/internal/http/http_client.py b/src/adobe/pdfservices/operation/internal/http/http_client.py index 1e9201f..8b4a1ca 100644 --- a/src/adobe/pdfservices/operation/internal/http/http_client.py +++ b/src/adobe/pdfservices/operation/internal/http/http_client.py @@ -48,7 +48,7 @@ def _append_default_headers(headers: dict): # Set SDK Info header headers[DefaultHeaders.DC_APP_INFO_HEADER_KEY] = "{lang}-{name}-{version}".format(lang="python", name='pdfservices-sdk', - version='2.2.0') + version='2.3.0') headers[DefaultHeaders.ACCEPT_HEADER_NAME] = DefaultHeaders.JSON_TXT_CONTENT_TYPE diff --git a/src/adobe/pdfservices/operation/internal/internal_execution_context.py b/src/adobe/pdfservices/operation/internal/internal_execution_context.py index 97f22e0..5db9fdf 100644 --- a/src/adobe/pdfservices/operation/internal/internal_execution_context.py +++ b/src/adobe/pdfservices/operation/internal/internal_execution_context.py @@ -9,6 +9,7 @@ # governing permissions and limitations under the License. from adobe.pdfservices.operation.auth.service_account_credentials import ServiceAccountCredentials +from adobe.pdfservices.operation.auth.service_principal_credentials import ServicePrincipalCredentials from adobe.pdfservices.operation.execution_context import ExecutionContext from adobe.pdfservices.operation.internal.auth.auth_factory import AuthenticatorFactory @@ -21,14 +22,14 @@ class InternalExecutionContext(ExecutionContext): _client_config: InternalClientConfig = None def __init__(self, credentials, client_config): - if isinstance(credentials, ServiceAccountCredentials): + if isinstance(credentials, ServiceAccountCredentials) or isinstance(credentials, ServicePrincipalCredentials): self._credentials = credentials if isinstance(client_config, InternalClientConfig): self._client_config = client_config else: self._client_config = InternalClientConfig() self._client_config.validate() - self.authenticator = AuthenticatorFactory.get_authenticator(self._credentials) + self.authenticator = AuthenticatorFactory.get_authenticator(self._credentials, self._client_config) else: raise ValueError("Invalid Credentials provided as argument") diff --git a/src/adobe/pdfservices/operation/pdfops/autotag_pdf_operation.py b/src/adobe/pdfservices/operation/pdfops/autotag_pdf_operation.py index 3b53b62..1371853 100644 --- a/src/adobe/pdfservices/operation/pdfops/autotag_pdf_operation.py +++ b/src/adobe/pdfservices/operation/pdfops/autotag_pdf_operation.py @@ -41,9 +41,10 @@ class AutotagPDFOperation(Operation): try: base_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) - credentials = Credentials.service_account_credentials_builder() \\ - .from_file(base_path + "/pdfservices-api-credentials.json") \\ - .build() + credentials = Credentials.service_principal_credentials_builder(). \\ + with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \\ + with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \\ + build() execution_context = ExecutionContext.create(credentials) autotag_pdf_operation = AutotagPDFOperation.create_new() diff --git a/src/adobe/pdfservices/operation/pdfops/extract_pdf_operation.py b/src/adobe/pdfservices/operation/pdfops/extract_pdf_operation.py index d747a62..b1a08a6 100644 --- a/src/adobe/pdfservices/operation/pdfops/extract_pdf_operation.py +++ b/src/adobe/pdfservices/operation/pdfops/extract_pdf_operation.py @@ -36,9 +36,10 @@ class ExtractPDFOperation(Operation): try: base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) - credentials = Credentials.service_account_credentials_builder() \\ - .from_file(base_path + "/pdfservices-api-credentials.json") \\ - .build() + credentials = Credentials.service_principal_credentials_builder(). \\ + with_client_id(os.getenv('PDF_SERVICES_CLIENT_ID')). \\ + with_client_secret(os.getenv('PDF_SERVICES_CLIENT_SECRET')). \\ + build() execution_context = ExecutionContext.create(credentials) extract_pdf_operation = ExtractPDFOperation.create_new()