Class Index: jobs.job_rest_export.JobRESTExport

TableauCredentials

Tableau server credentials.

type

object

properties

  • username

Username

Tableau username.

type

string

examples

steve

  • password

Password

Tableau password.

type

string

examples

steve-password

additionalProperties

False

TableauServer

Tableau server configuration.

type

object

properties

  • server

Server

Tableau server to use.

type

string

examples

https://tableau.zuar.com

  • site

Site

Tableau site to use. Note: to use the "Default" site, provide a empty string value (i.e., a value of "").

type

string

examples

  • user_id_to_impersonate

User Id To Impersonate

Tableau username to impersonate when authenticating. If not provided, no impersonation is performed.

type

string

examples

3908c4ce-b171-46f3-b12b-d8827c162199

additionalProperties

False

CSVExport

Complete definition of the Tableau REST CSV export

type

object

properties

  • name

Name

Name that the export will be saved under. Do not include the extension; it will be determined automatically.

type

string

default

tableau-export

  • workbook

Workbook

_content_url of the workbook

type

string

  • view

View

_content_url of the view

type

string

  • view_filters

View Filters

View filters to apply to data.

type

object

examples

OrderedDict([(‘State’, [‘Louisiana’, ‘Texas’]), (‘Category’, [‘Office Supplies’])])

OrderedDict([(‘region’, [‘LATAM’, ‘NA’]), (‘sub_region’, []), (‘plant_name’, []), (‘global_start_datetime’, ‘2020-06-12 00:00:00.000’), (‘global_end_datetime’, ‘2020-06-12 23:59:59.999’)])

default

OrderedDict()

  • full

Full

Process all views in workbook, not just the view specified by view.

type

boolean

examples

true

false

null

  • timeout

Timeout

Maximum number of seconds to allow before killing request.

type

integer

default

300

  • retries

Retries

Maximum number of times to retry a failed request.

type

integer

default

5

  • maxage

Maxage

The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between 1 and 240 minutes. 0 will be interpreted as 1 minute on server, as that is the shortest interval allowed.

type

integer

maximum

240

minimum

-1

default

-1

  • type

Type

Type of export being performed.

type

string

examples

csv

default

csv

additionalProperties

False

XLSXExport

Complete definition of the Tableau REST XLSX export

type

object

properties

  • name

Name

Name that the export will be saved under. Do not include the extension; it will be determined automatically.

type

string

default

tableau-export

  • workbook

Workbook

_content_url of the workbook

type

string

  • view

View

_content_url of the view

type

string

  • view_filters

View Filters

View filters to apply to data.

type

object

examples

OrderedDict([(‘State’, [‘Louisiana’, ‘Texas’]), (‘Category’, [‘Office Supplies’])])

OrderedDict([(‘region’, [‘LATAM’, ‘NA’]), (‘sub_region’, []), (‘plant_name’, []), (‘global_start_datetime’, ‘2020-06-12 00:00:00.000’), (‘global_end_datetime’, ‘2020-06-12 23:59:59.999’)])

default

OrderedDict()

  • full

Full

Process all views in workbook, not just the view specified by view.

type

boolean

examples

true

false

null

  • timeout

Timeout

Maximum number of seconds to allow before killing request.

type

integer

default

300

  • retries

Retries

Maximum number of times to retry a failed request.

type

integer

default

5

  • maxage

Maxage

The maximum number of minutes the CSV data will be cached on the server before being refreshed. The value must be an integer between 1 and 240 minutes. 0 will be interpreted as 1 minute on server, as that is the shortest interval allowed.

type

integer

maximum

240

minimum

-1

default

-1

  • type

Type

Type of export being performed.

type

string

examples

xlsx

default

xlsx

additionalProperties

False