Tableau Migration SDK 5.1.1
  • Articles
  • Code Samples
  • Python API Reference
  • C# API Reference
Show / Hide Table of Contents
  • tableau_migration
    • migration
      • get_service
      • get_service_provider
      • PyMigrationResult
      • PyMigrationManifest
      • PyMigrationCompletionStatus
      • PyContentReference
      • PyContentLocation
      • PyPipelineProfile
      • PyResult
    • migration_api_rest
      • PyRestIdentifiable
    • migration_api_rest_models
      • PyAdministratorLevels
      • PyContentPermissions
      • PyLabelCategories
      • PyLicenseLevels
      • PyPermissionsCapabilityModes
      • PyPermissionsCapabilityNames
      • PySiteRoles
      • PyExtractEncryptionModes
    • migration_api_rest_models_types
      • PyAuthenticationTypes
      • PyDataSourceFileTypes
      • PyWorkbookFileTypes
    • migration_content
      • PyCloudSubscription
      • PySubscription
      • PySubscriptionContent
      • PyTag
      • PyUser
      • PyUserAuthenticationType
      • PyUsernameContent
      • PyServerSubscription
      • PyView
      • PyWithOwner
      • PyWithTags
      • PyWithWorkbook
      • PyWorkbook
      • PyWorkbookDetails
      • PyWithDomain
      • PyPublishedContent
      • PyPublishableGroup
      • PyConnection
      • PyConnectionsContent
      • PyContainerContent
      • PyCustomView
      • PyDataSource
      • PyDataSourceDetails
      • PyPublishableWorkbook
      • PyDescriptionContent
      • PyGroup
      • PyGroupUser
      • PyLabel
      • PyProject
      • PyPublishableCustomView
      • PyPublishableDataSource
      • PyExtractContent
    • migration_content_permissions
      • PyPermissions
      • PyGranteeType
      • PyGranteeCapability
      • PyCapability
    • migration_content_schedules
      • PyInterval
      • PyFrequencyDetails
      • PyExtractRefreshTask
      • PyExtractRefreshContentType
      • PySchedule
      • PyWithSchedule
    • migration_content_schedules_cloud
      • PyCloudSchedule
      • PyCloudExtractRefreshTask
    • migration_content_schedules_server
      • PyServerSchedule
      • PyServerExtractRefreshTask
    • migration_engine
      • PyServerToCloudMigrationPlanBuilder
      • PyMigrationPlanBuilder
      • PyMigrationPlan
      • PyContentMigrationItem
    • migration_engine_actions
      • PyMigrationActionResult
    • migration_engine_endpoints_search
      • PySourceContentReferenceFinder
      • PySourceContentReferenceFinderFactory
      • PyDestinationContentReferenceFinderFactory
      • PyDestinationContentReferenceFinder
    • migration_engine_hooks
      • PyMigrationHookBuilder
      • PyMigrationHookFactoryCollection
    • migration_engine_hooks_filters
      • PyContentFilterBuilder
    • migration_engine_hooks_filters_interop
      • PyContentFilterBase
    • migration_engine_hooks_interop
      • PyInitializeMigrationHookBase
      • PyMigrationActionCompletedHookBase
      • PyContentBatchMigrationCompletedHookBase
    • migration_engine_hooks_mappings
      • PyContentMappingContext
      • PyContentMappingBuilder
    • migration_engine_hooks_mappings_interop
      • PyContentMappingBase
      • PyTableauCloudUsernameMappingBase
    • migration_engine_hooks_postpublish
      • PyContentItemPostPublishContext
      • PyBulkPostPublishContext
    • migration_engine_hooks_postpublish_interop
      • PyContentItemPostPublishHookBase
      • PyBulkPostPublishHookBase
    • migration_engine_hooks_results
      • PyInitializeMigrationHookResult
    • migration_engine_hooks_transformers
      • PyContentTransformerBuilder
    • migration_engine_hooks_transformers_interop
      • PyXmlContentTransformerBase
      • PyContentTransformerBase
    • migration_engine_manifest
      • PyMigrationManifestEntryEditor
      • PyMigrationManifestEntryStatus
      • PyMigrationManifestSerializer
      • PyMigrationManifestEntry
    • migration_engine_migrators
      • PyContentItemMigrationResult
      • PyMigrator
    • migration_engine_migrators_batch
      • PyContentBatchMigrationResult
    • migration_engine_options
      • PyMigrationPlanOptionsBuilder
      • PyMigrationPlanOptionsCollection
    • migration_engine_pipelines
      • PyMigrationPipelineContentType
      • PyServerToCloudMigrationPipeline
    • migration_enum
    • migration_logger
      • MigrationLogger
    • migration_services
      • ScopedMigrationServices

PyPublishableDataSource

class PyPublishableDataSource(publishable_data_source)

Bases: PyDataSourceDetails, PyConnectionsContent

Interface for a IDataSource that has been downloaded and has full information necessary for re-publishing.

  • Parameters: publishable_data_source (IPublishableDataSource)

__init__(publishable_data_source)

Creates a new PyPublishableDataSource object.

Args: : publishable_data_source: A IPublishableDataSource object.

Returns: None.

  • Parameters: publishable_data_source (IPublishableDataSource)
  • Return type: None

Methods

__init__(publishable_data_source) Creates a new PyPublishableDataSource object.

Attributes

certification_note Gets the certification note.
connections Gets the connection metadata.
container Gets the container for the content item.
content_url Get the site-unique "content URL" of the content item, or an empty string if the content type does not use a content URL.
created_at Gets the created timestamp.
description Gets or sets the description.
encrypt_extracts Gets or sets whether or not extracts are encrypted.
has_embedded_o_auth_credentials Gets whether any Connections have an embedded password and an OAuth authentication type.
has_embedded_o_auth_managed_keychain Gets whether any Connections have an embedded password and uses OAuth managed keychain.
has_embedded_password Gets whether any Connections have an embedded password.
has_extracts Gets whether or not the data source has extracts.
id Gets the unique identifier.
is_certified Gets the IsCertified flag for the data source.
location Gets the logical location path of the content item, for project-level content this is the project path and the content item name.
name Gets the name of the content item.
owner Gets or sets the owner for the content item.
tags Gets or sets the tags for the content item.
updated_at Gets the updated timestamp.
use_remote_query_agent Gets or sets the UseRemoteQueryAgent flag for the data source.
webpage_url Gets the webpage URL.

property certification_note : str

Gets the certification note.

property connections : Sequence[PyConnection]

Gets the connection metadata. Connection metadata is read only because connection metadata should not be transformed directly. Instead, connections should be modified by either: 1) manipulating XML before publishing, or 2) updating connection metadata in a post-publish hook.

property container : PyContentReference

Gets the container for the content item. Relocating the content should be done through mapping.

property content_url : str

Get the site-unique “content URL” of the content item, or an empty string if the content type does not use a content URL.

property created_at : str

Gets the created timestamp.

property description : str

Gets or sets the description.

property encrypt_extracts : bool

Gets or sets whether or not extracts are encrypted.

property has_embedded_o_auth_credentials : bool

Gets whether any Connections have an embedded password and an OAuth authentication type.

property has_embedded_o_auth_managed_keychain : bool

Gets whether any Connections have an embedded password and uses OAuth managed keychain.

property has_embedded_password : bool

Gets whether any Connections have an embedded password.

property has_extracts : bool

Gets whether or not the data source has extracts.

property id : UUID

Gets the unique identifier.

property is_certified : bool

Gets the IsCertified flag for the data source. Should be updated through a post-publish hook.

property location : PyContentLocation

Gets the logical location path of the content item, for project-level content this is the project path and the content item name.

property name : str

Gets the name of the content item. This is equivalent to the last segment of the Location. Renames should be performed through mapping.

property owner : PyContentReference

Gets or sets the owner for the content item.

property tags : List[PyTag]

Gets or sets the tags for the content item.

property updated_at : str

Gets the updated timestamp.

property use_remote_query_agent : bool

Gets or sets the UseRemoteQueryAgent flag for the data source.

property webpage_url : str

Gets the webpage URL.

In this article