json.schema.entity.services.connections.dashboard.tableauConnection.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/entity/services/connections/dashboard/tableauConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TableauConnection",
  "description": "Tableau Connection Config",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.dashboard.TableauConnection",
  "definitions": {
    "tableauType": {
      "description": "Tableau service type",
      "type": "string",
      "enum": ["Tableau"],
      "default": "Tableau"
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/tableauType",
      "default": "Tableau"
    },
    "hostPort": {
      "expose": true,
      "title": "Host and Port",
      "description": "Tableau Server.",
      "type": "string",
      "format": "uri"
    },
    "authType": {
      "mask": true,
      "title": "Authentication type for Tableau",
      "description": "Types of methods used to authenticate to the tableau instance",
      "oneOf": [
        {
          "$ref": "../../../../security/credentials/basicAuth.json"
        },
        {
          "$ref": "../../../../security/credentials/accessTokenAuth.json"
        }
      ]
    },
    "apiVersion": {
      "title": "API Version",
      "description": "Tableau API version.",
      "type": "string"
    },
    "siteName": {
      "title": "Site Name",
      "description": "Tableau Site Name.",
      "type": "string"
    },
    "siteUrl": {
      "title": "Site Url",
      "description": "Tableau Site Url.",
      "type": "string"
    },
    "env": {
      "title": "Tableau Environment",
      "description": "Tableau Environment Name.",
      "type": "string",
      "default": "tableau_prod"
    },
    "paginationLimit": {
      "title": "Pagination Limit",
      "description": "Pagination limit used while querying the tableau metadata API for getting data sources",
      "type": "integer",
      "default": 10
    },
    "verifySSL": {
      "$ref": "../../../../security/ssl/verifySSLConfig.json#/definitions/verifySSL",
      "default": "no-ssl"
    },
    "sslConfig": {
      "$ref": "../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig"
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    }
  },
  "additionalProperties": false,
  "required": ["apiVersion", "env", "hostPort"]
}