airflow.providers.tableau.operators.tableau_refresh_workbook

Module Contents

class airflow.providers.tableau.operators.tableau_refresh_workbook.TableauRefreshWorkbookOperator(*, workbook_name: str, site_id: Optional[str] = None, blocking: bool = True, tableau_conn_id: str = 'tableau_default', **kwargs)[source]

Bases: airflow.models.BaseOperator

Refreshes a Tableau Workbook/Extract

See also

https://tableau.github.io/server-client-python/docs/api-ref#workbooks

Parameters

  • workbook_name (str) -- The name of the workbook to refresh.

  • site_id (Optional[str]) -- The id of the site where the workbook belongs to.

  • blocking (bool) -- By default the extract refresh will be blocking means it will wait until it has finished.

  • tableau_conn_id (str) -- The Tableau Connection id containing the credentials to authenticate to the Tableau Server.

execute(self, context: dict)[source]

Executes the Tableau Extract Refresh and pushes the job id to xcom.

Parameters

context (dict) -- The task context during execution.

Returns

the id of the job that executes the extract refresh

Return type

str

_get_workbook_by_name(self, tableau_hook: TableauHook)[source]
_refresh_workbook(self, tableau_hook: TableauHook, workbook_id: str)[source]

Was this entry helpful?