gws.base.exporter.action

Exporter action.

Source code: gws.base.exporter.action

Module Contents

class gws.base.exporter.action.CliParams(*args, **kwargs)

Bases: gws.CliParams

Parameters of the gws exporter export command.

output: str

Path to copy the export result to.

request: str

Path to a JSON file with a gws.ExportRequest.

class gws.base.exporter.action.Config

Bases: gws.base.action.Config

Feature export in the client, run as background jobs.

class gws.base.exporter.action.Object

Bases: gws.base.action.Object

Exporter action.

do_export(p: CliParams)

Run an export from the command line.

exporter_cancel(req: gws.WebRequester, p: gws.JobRequest) → gws.JobStatusResponse

Cancel an export job.

exporter_output(req: gws.WebRequester, p: gws.JobRequest) → gws.ContentResponse

Return the result file of a completed export job.

exporter_start(req: gws.WebRequester, p: gws.ExportRequest) → gws.JobStatusResponse

Start a background export job.

exporter_status(req: gws.WebRequester, p: gws.JobRequest) → gws.JobStatusResponse

Return the status of an export job.

class gws.base.exporter.action.Props

Bases: gws.base.action.Props