airflow.providers.tableau.operators.tableau_refresh_workbook

Module Contents

Classes

TableauRefreshWorkbookOperator

This operator is deprecated. Please use airflow.providers.tableau.operators.tableau.

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', check_interval: float = 20, **kwargs)[source]

Bases: airflow.models.BaseOperator

This operator is deprecated. Please use airflow.providers.tableau.operators.tableau.

Refreshes a Tableau Workbook/Extract

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) -- Defines if the job waits until the refresh has finished. Default: True.

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

  • check_interval (float) -- time in seconds that the job should wait in between each instance state checks until operation is completed

execute(self, context: airflow.utils.context.Context) str[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

Was this entry helpful?