Class - builtin.extract.jobs.job_extract.JobConfig

JSON Schema

JobConfig

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
	default	extract
	const	extract
credentials	Credentials
	Credentials name or dict.
	anyOf	type	string
		BasicCredentials
		PersonalAccessTokenCredentials
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
max_retries	Max Retries
	Maximum number of times to retry Tableau Server errors.
	type	integer
	default	5
max_wait	Max Wait
	Maximum number of seconds to wait between retries.
	type	integer
	default	30
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
BasicCredentials	BasicCredentials
	Basic 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
PersonalAccessTokenCredentials	PersonalAccessTokenCredentials
	PersonalAccessTokenCredentials 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
	token_name	Token Name
		Tableau Personal Access Token Name
		type	string
		examples	test_token_name
	personal_access_token	Personal Access Token
		Tableau Personal Access Token Value
		type	string
		examples	F3QtOEOzRDKW8wGIe1LOmQ==:DlgqULXdhInxWqQMhM5WGjJ05hzRP3nM
	site	Site
		Tableau Site - leave blank to use default site
		type	string
		examples	SuperStore

JSON Schema Definitions

#/definitions/BasicCredentials

BasicCredentials

Basic 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

#/definitions/PersonalAccessTokenCredentials

PersonalAccessTokenCredentials

PersonalAccessTokenCredentials 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
token_name	Token Name
	Tableau Personal Access Token Name
	type	string
	examples	test_token_name
personal_access_token	Personal Access Token
	Tableau Personal Access Token Value
	type	string
	examples	F3QtOEOzRDKW8wGIe1LOmQ==:DlgqULXdhInxWqQMhM5WGjJ05hzRP3nM
site	Site
	Tableau Site - leave blank to use default site
	type	string
	examples	SuperStore