`airflow.providers.salesforce.hooks.tableau`¶

Module Contents¶

class airflow.providers.salesforce.hooks.tableau.TableauJobFinishCode[source]¶

Bases: enum.Enum

The finish code indicates the status of the job.

See also

https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_job

PENDING[source]¶

SUCCESS = 0[source]¶

ERROR = 1[source]¶

CANCELED = 2[source]¶

class airflow.providers.salesforce.hooks.tableau.TableauHook(site_id: Optional[str] = None, tableau_conn_id: str = default_conn_name)[source]¶

Bases: airflow.hooks.base.BaseHook

Connects to the Tableau Server Instance and allows to communicate with it.

See also

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

Parameters

site_id (Optional[str]) -- The id of the site where the workbook belongs to. It will connect to the default site if you don't provide an id.
tableau_conn_id (str) -- The Tableau Connection id containing the credentials to authenticate to the Tableau Server.

conn_name_attr = tableau_conn_id[source]¶

default_conn_name = tableau_default[source]¶

conn_type = tableau[source]¶

hook_name = Tableau[source]¶

__enter__(self)[source]¶

__exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any)[source]¶

get_conn(self)[source]¶

Signs in to the Tableau Server and automatically signs out if used as ContextManager.

Returns: an authorized Tableau Server Context Manager object.
Return type: tableauserverclient.server.Auth.contextmgr

_auth_via_password(self)[source]¶

_auth_via_token(self)[source]¶

get_all(self, resource_name: str)[source]¶

Get all items of the given resource.

See also

https://tableau.github.io/server-client-python/docs/page-through-results

Parameters: resource_name (str) -- The name of the resource to paginate. For example: jobs or workbooks
Returns: all items by returning a Pager.
Return type: tableauserverclient.Pager

Was this entry helpful?