Ballerina library

tableau

Module tableau

OverviewPrerequisites

API

Client
Constructor
Remote functions
analyticsextensionsserviceGetanalyticsextensionsconnectionanalyticsextensionsserviceUpdateanalyticsextensionsconnectionanalyticsextensionsserviceDeleteanalyticsextensionsconnectiondashboardextensionssitesettingsserviceGetdashboardextensionssafelistitemdashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitemdashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitemanalyticsextensionsserviceGetconnectionoptionsforworkbookanalyticsextensionsserviceGetselectedconnectionforworkbookanalyticsextensionsserviceUpdateworkbookwithconnectionanalyticsextensionsserviceDeleteconnectionfromworkbookanalyticsextensionsserviceGetanalyticsextensionssitesettingsanalyticsextensionsserviceUpdateanalyticsextensionssitesettingsdashboardextensionssitesettingsserviceGetdashboardextensionssitesettingsdashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettingsdashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitemsdashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitemdashboardextensionssitesettingsserviceGetdashboardextensionssafelistitemsdashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitemanalyticsextensionsserviceGetanalyticsextensionsconnectionsanalyticsextensionsserviceAddanalyticsextensionsconnectionanalyticsextensionsserviceGetanalyticsextensionsserversettingsanalyticsextensionsserviceUpdateanalyticsextensionsserversettingsdashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitemdashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitemdashboardextensionsserversettingsserviceGetdashboardextensionsserversettingsdashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings

Definitions

ClientHttp1Settings
ConnectionConfig
ProxyConfig
TableauAnalyticsextensionsV1Connectionbrief
TableauAnalyticsextensionsV1Connectionitem
TableauAnalyticsextensionsV1Connectionlist
TableauAnalyticsextensionsV1Connectionmapping
TableauAnalyticsextensionsV1Connectionmetadata
TableauAnalyticsextensionsV1Connectionmetadatalist
TableauAnalyticsextensionsV1Serversettings
TableauAnalyticsextensionsV1Sitesettings
TableauError
TableauExtensionsDashboardV1Blocklistitem
TableauExtensionsDashboardV1Blocklistitems
TableauExtensionsDashboardV1Safelistitem
TableauExtensionsDashboardV1Safelistitems
TableauExtensionsDashboardV1Serversettings
TableauExtensionsDashboardV1Sitesettings

ballerinax/tableau Ballerina library

1.4.1

Overview

This is a generated connector for Tableau API v3.11 OpenAPI specification. The Tableau API is a collection of endpoints for Tableau which is an excellent data visualization and business intelligence tool used for reporting and analyzing vast volumes of data.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

tableau: Client

Isolated

Versions: Tableau Server 2021.1 / Tableau Online March 2022 and later

This documentation describes the growing number OpenAPI endpoints being released alongside more than 150 classic REST endpoints that are currently in wide usage in the Tableau community.

There are some differences users of the classic endpoints will recognize when viewing these new endpoints.

  • Request bodies for these new REST endpoints must be formatted using JSON.

  • Endpoint URIs may contain a hyphen ('-') instead of an API version number, indicating that the resource is versioned separately from the numbered API release. For more information, see REST API and Resource Versions.

Starting in Tableau Server 2022.1 / Tableau Online March 2022, differences between releases will be noted in this reference.To view the previous version of this reference, see Tableau REST API OpenAPI Endpoints (v2021.4).

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://tableau.example.com/" - URL of the target service

analyticsextensionsserviceGetanalyticsextensionsconnection

Isolated FunctionRemote Function
function analyticsextensionsserviceGetanalyticsextensionsconnection(string connectionLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionitem|error

Get analytics extension details

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceUpdateanalyticsextensionsconnection

Isolated FunctionRemote Function
function analyticsextensionsserviceUpdateanalyticsextensionsconnection(string connectionLuid, byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionitem|error

Update analytics extension connection of site

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceDeleteanalyticsextensionsconnection

Isolated FunctionRemote Function
function analyticsextensionsserviceDeleteanalyticsextensionsconnection(string connectionLuid, string? xTableauAuth) returns Response|error

Delete analytics extension connection from site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitem

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitem(string safeListItemLuid, string? xTableauAuth) returns TableauExtensionsDashboardV1Safelistitem|error

Get allowed dashboard extension on site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitem

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceUpdatedashboardextensionssafelistitem(string safeListItemLuid, byte[] payload, string? xTableauAuth) returns TableauExtensionsDashboardV1Safelistitem|error

Update settings for allowed dashboard extension on site

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitem

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceDeletedashboardextensionssafelistitem(string safeListItemLuid, string? xTableauAuth) returns Response|error

Disallow dashboard extension on site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceGetconnectionoptionsforworkbook

Isolated FunctionRemote Function
function analyticsextensionsserviceGetconnectionoptionsforworkbook(string workbookLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

List analytics extension connections of workbook

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceGetselectedconnectionforworkbook

Isolated FunctionRemote Function
function analyticsextensionsserviceGetselectedconnectionforworkbook(string workbookLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Get current analytics extension for workbook

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceUpdateworkbookwithconnection

Isolated FunctionRemote Function
function analyticsextensionsserviceUpdateworkbookwithconnection(string workbookLuid, byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Update analytics extension for workbook

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceDeleteconnectionfromworkbook

Isolated FunctionRemote Function
function analyticsextensionsserviceDeleteconnectionfromworkbook(string workbookLuid, string? xTableauAuth) returns Response|error

Remove current analytics extension connection for workbook

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceGetanalyticsextensionssitesettings

Isolated FunctionRemote Function
function analyticsextensionsserviceGetanalyticsextensionssitesettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Get enabled state of analytics extensions on site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceUpdateanalyticsextensionssitesettings

Isolated FunctionRemote Function
function analyticsextensionsserviceUpdateanalyticsextensionssitesettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Update enabled state of analytics extensions on site

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceGetdashboardextensionssitesettings

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceGetdashboardextensionssitesettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

List dashboard extension settings of site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettings

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceUpdatedashboardextensionssitesettings(byte[] payload, string? xTableauAuth) returns Response|error

Update dashboard extension settings of site

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitems

Isolated FunctionRemote Function
function dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitems(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

List blocked dashboard extensions on server

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitem

Isolated FunctionRemote Function
function dashboardextensionsserversettingsserviceCreatedashboardextensionsblocklistitem(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Block dashboard extension on server

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitems

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceGetdashboardextensionssafelistitems(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Lists allowed dashboard extensions on site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitem

Isolated FunctionRemote Function
function dashboardextensionssitesettingsserviceCreatedashboardextensionssafelistitem(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Allow dashboard extension on site

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceGetanalyticsextensionsconnections

Isolated FunctionRemote Function
function analyticsextensionsserviceGetanalyticsextensionsconnections(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

List analytics extension connections on site

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceAddanalyticsextensionsconnection

Isolated FunctionRemote Function
function analyticsextensionsserviceAddanalyticsextensionsconnection(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Add analytics extension connection to site

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceGetanalyticsextensionsserversettings

Isolated FunctionRemote Function
function analyticsextensionsserviceGetanalyticsextensionsserversettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Get enabled state of analytics extensions on server

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

analyticsextensionsserviceUpdateanalyticsextensionsserversettings

Isolated FunctionRemote Function
function analyticsextensionsserviceUpdateanalyticsextensionsserversettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Enable or disable analytics extensions on server

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitem

Isolated FunctionRemote Function
function dashboardextensionsserversettingsserviceGetdashboardextensionsblocklistitem(string blockListItemLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Get blocked dashboard extension on server

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitem

Isolated FunctionRemote Function
function dashboardextensionsserversettingsserviceDeletedashboardextensionsblocklistitem(string blockListItemLuid, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Unblock dashboard extension on server

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionsserversettingsserviceGetdashboardextensionsserversettings

Isolated FunctionRemote Function
function dashboardextensionsserversettingsserviceGetdashboardextensionsserversettings(string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

List settings for dashboard extensions on server

Parameters
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

dashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings

Isolated FunctionRemote Function
function dashboardextensionsserversettingsserviceUpdatedashboardextensionsserversettings(byte[] payload, string? xTableauAuth) returns TableauAnalyticsextensionsV1Connectionmetadatalist|error

Update dashboard extensions settings of server

Parameters
  • payload byte[] - 
  • xTableauAuth string? (default ()) - The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource.
Return Type

Records

tableau: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

tableau: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

tableau: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

tableau: TableauAnalyticsextensionsV1Connectionbrief

Fields
  • connection_name string? - Required. The title of the connection.

tableau: TableauAnalyticsextensionsV1Connectionitem

Fields
  • host string? - Required. The location of an external service (TabPy, Rserve, EINSTEIN_DISCOVERY, Generic API, or other) that responds to your analytics extension requests. The case sensitive value must be a URI, IPv4 or IPv6 address that is a maximum of 255 Unicode characters. Starting in Tableau 2022.1 / Online April 2022, a host address can include path information (www.example.com/path), where previous versions supported only the root domain name (www.example.com).
  • port int? - Required. Integer between 1 and 65535.
  • is_auth_enabled boolean? - For Tableau Online: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false.
  • username string? - For Tableau Online: A username is always required.
  • password string? - For Tableau Online: A password is always required.
  • is_ssl_enabled boolean? - For Tableau Online: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false.

tableau: TableauAnalyticsextensionsV1Connectionlist

Fields

tableau: TableauAnalyticsextensionsV1Connectionmapping

Fields

tableau: TableauAnalyticsextensionsV1Connectionmetadata

Fields

tableau: TableauAnalyticsextensionsV1Connectionmetadatalist

Fields

tableau: TableauAnalyticsextensionsV1Serversettings

Fields

tableau: TableauAnalyticsextensionsV1Sitesettings

Fields

tableau: TableauError

Fields

tableau: TableauExtensionsDashboardV1Blocklistitem

A dashboard extension that is blocked from running on a server.

Fields
  • url string? - Location of the dashboard extension to be blocked from a site.
  • block_list_item_luid string? -

tableau: TableauExtensionsDashboardV1Blocklistitems

List of dashboard extensions blocked from running on a server.

Fields

tableau: TableauExtensionsDashboardV1Safelistitem

A dashboard extension that is allowed to run on a site.

Fields
  • safe_list_item_luid string? -
  • url string? - Location (URL) of the dashboard extension to be allowed on a site.
  • allow_full_data boolean? - When true, the extension has access to underlying data of a workbook. This setting is only effective when the extension is on the site safe list. Default is false.
  • prompt_needed boolean? - When true, the user will be prompted to grant an extension access to the underlying data of a workbook. This setting is only effective when the extension is on the site safe list. Default is false.

tableau: TableauExtensionsDashboardV1Safelistitems

List of dashboard extensions allowed to run on a site.

Fields

tableau: TableauExtensionsDashboardV1Serversettings

Extension settings of a Tableau server.

Fields
  • extensions_enabled boolean? - Specifies whether sandboxed extensions are allowed to run on the site.

tableau: TableauExtensionsDashboardV1Sitesettings

Dashboard extension settings of a site.

Fields
  • extensions_enabled boolean? - Specifies whether extensions are allowed to run on the site.
  • allow_sandboxed boolean? - Specifies whether sandboxed extensions are allowed to run on the site.

Import

import ballerinax/tableau;Copy

Metadata

Released date: over 1 year ago

Version: 1.4.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 3

Current verison: 3

Weekly downloads

Source repository

Keywords

Business Intelligence/Visualization

Cost/Freemium

Contributors

Other versions

1.4.1

1.4.01.3.01.0.0

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC