airflow.providers.tableau.operators.tableau¶

Attributes¶

RESOURCES_METHODS

Classes¶

TableauOperator

Execute a Tableau API Resource.

Module Contents¶

airflow.providers.tableau.operators.tableau.RESOURCES_METHODS[source]¶

class airflow.providers.tableau.operators.tableau.TableauOperator(*, resource, method, find, match_with='id', site_id=None, blocking_refresh=True, check_interval=20, tableau_conn_id='tableau_default', **kwargs)[source]¶

Bases: airflow.providers.common.compat.sdk.BaseOperator

Execute a Tableau API Resource.

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

See also

For more information on how to use this operator, take a look at the guide: TableauOperator

Parameters:

resource (str) – The name of the resource to use.
method (str) – The name of the resource’s method to execute.
find (str) – The reference of resource that will receive the action.
match_with (str) – The resource field name to be matched with find parameter.
site_id (str | None) – The id of the site where the workbook belongs to.
blocking_refresh (bool) – By default will be blocking means it will wait until it has finished.
check_interval (float) – time in seconds that the job should wait in between each instance state checks until operation is completed
tableau_conn_id (str) – The Tableau Connection id containing the credentials to authenticate to the Tableau Server.

template_fields: collections.abc.Sequence[str] = ('find', 'match_with')[source]¶

resource[source]¶

method[source]¶

find[source]¶

match_with = 'id'[source]¶

check_interval = 20[source]¶

site_id = None[source]¶

blocking_refresh = True[source]¶

tableau_conn_id = 'tableau_default'[source]¶

execute(context)[source]¶

Execute the Tableau API resource and push the job id or downloaded file URI to xcom.

Parameters:: context (airflow.providers.common.compat.sdk.Context) – The task context during execution.
Returns:: the id of the job that executes the extract refresh or downloaded file URI.
Return type:: str