:tocdepth: 3

:py:mod:`gws.base.printer.action`
=================================

.. py:module:: gws.base.printer.action

.. autoapi-nested-parse::

   Provides the printing API.



**Source code:** :source:`gws.base.printer.action<gws/base/printer/action.py>`



Module Contents
---------------



.. py:class:: CliParams(*args, **kwargs)


   Bases: :py:obj:`gws.CliParams`

   CLI params

   .. py:attribute:: output
      :type:  str

      output path

   .. py:attribute:: project
      :type:  Optional[str]

      project uid

   .. py:attribute:: request
      :type:  str

      path to request.json


.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.base.action.Config`

   Configuration for the printer action.


.. py:class:: Object


   Bases: :py:obj:`gws.base.action.Object`

   Generic action object, the parent of all action objects.

   .. py:method:: print(p: CliParams)

      Print using the specified params


   .. py:method:: printer_cancel(req: gws.WebRequester, p: gws.JobRequest) -> gws.JobStatusResponse

   .. py:method:: printer_output(req: gws.WebRequester, p: gws.JobRequest) -> gws.ContentResponse

   .. py:method:: printer_start(req: gws.WebRequester, p: gws.PrintRequest) -> gws.JobStatusResponse

      Start a background print job


   .. py:method:: printer_status(req: gws.WebRequester, p: gws.JobRequest) -> gws.JobStatusResponse


.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.base.action.Props`

   Object properties.