Table Of Contents

Module - builtin.extract.jobs.job_extract

JobExtractConfig

Configuration for Tableau Extract Job

This job runs a given Tableau Extract Refresh. The desired refresh is identified by the combination of either its workbook id or datasource id and its schedule id. Specifying the extract in this manner insulates the job from changes in extract ids that take place from time to time.

Credentials contains private attributes which must be redacted prior to creating an extract job. The cleanest way to do this is to sublass from PlaybookForm, which allows recursively redacting private variables. Although this is a PlaybookForm subclass, it is never sent to the frontend and it is not a part of the wizard.

type

object

properties

  • name

Name

Job name

type

string

  • title

Title

Job title

type

string

  • type

Type

Mitto job type. Should not be changed.

type

string

  • credentials

Credentials name or dict.

Credentials

anyOf

type

string

allOf

Credentials

  • target_id

Target Id

Either a workbook id or a datasource id related to the desired extract refresh.

type

string

examples

1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b

  • schedule_id

Schedule Id

Schedule id associated with desired extract.

type

string

examples

1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b

  • max_retries

Max Retries

Maximum number of times to retry Tableau Server errors.

type

integer

default

100

  • retry_seconds

Retry Seconds

Seconds to wait before retrying failed request to Tableau Server.

type

integer

default

60

  • default_rate_limit_delay

Default Rate Limit Delay

When rate limited by Tableau Server, the number of seconds to wait before retrying. If a rate limit response from the Tableau Server specifies the amount of time to wait before issuing another request, the value provided by Tableau Server is used instead of this value.

type

integer

default

120

definitions

  • Credentials

Credentials

Credentials for Tableau server

type

object

properties

  • server_url

Server URL

Tableau URL

type

string

examples

https://10ay.online.tableau.com

maxLength

65536

minLength

1

format

uri

  • username

User Name

Tableau username

type

string

examples

steve@zuar.com

  • password

Password

Tableau password

type

string

examples

QFt7Z8DR3f95Wo

format

password

  • site

Site

Tableau Site - leave blank to use default site

type

string

examples

SuperStore

default