Tableau Migration SDK 5.3.0
  • Articles
  • Code Samples
  • Python API Reference
  • C# API Reference
Show / Hide Table of Contents
  • tableau_migration
    • migration
      • get_service_provider
      • get_service
      • reload_configuration
      • PyContentLocation
      • PyContentReference
      • PyEmptyIdContentReference
      • PyMigrationCompletionStatus
      • PyMigrationManifest
      • PyMigrationResult
      • PyPipelineProfile
      • PyResult
    • migration_api_rest
      • PyRestIdentifiable
    • migration_api_rest_models
      • PyAdministratorLevels
      • PyContentPermissions
      • PyExtractEncryptionModes
      • PyLabelCategories
      • PyLicenseLevels
      • PyPermissionsCapabilityModes
      • PyPermissionsCapabilityNames
      • PySiteRoles
    • migration_api_rest_models_types
      • PyAuthenticationTypes
      • PyDataSourceFileTypes
      • PyWorkbookFileTypes
    • migration_content
      • PyWorkbook
      • PyPublishableGroupSet
      • PyPublishableWorkbook
      • PyPublishedContent
      • PyServerSubscription
      • PySubscription
      • PySubscriptionContent
      • PyTag
      • PyUser
      • PyUserAuthenticationType
      • PyUsernameContent
      • PyView
      • PyWithDomain
      • PyWithOwner
      • PyWithTags
      • PyWithWorkbook
      • PyPublishableGroup
      • PyWorkbookDetails
      • PyPublishableDataSource
      • PyProject
      • PyCloudSubscription
      • PyConnection
      • PyConnectionsContent
      • PyContainerContent
      • PyCustomView
      • PyDataSource
      • PyDataSourceDetails
      • PyDescriptionContent
      • PyExtractContent
      • PyFavorite
      • PyFavoriteContentType
      • PyGroup
      • PyGroupSet
      • PyGroupUser
      • PyLabel
      • PyPublishableCustomView
    • migration_content_permissions
      • PyPermissions
      • PyPermissionSet
      • PyGranteeType
      • PyGranteeCapability
      • PyCapability
    • migration_content_schedules
      • PyExtractRefreshContentType
      • PyExtractRefreshTask
      • PyFrequencyDetails
      • PyInterval
      • PySchedule
      • PyWithSchedule
    • migration_content_schedules_cloud
      • PyCloudExtractRefreshTask
      • PyCloudSchedule
    • migration_content_schedules_server
      • PyServerExtractRefreshTask
      • PyServerSchedule
    • migration_content_search
      • PyContentReferenceFinder
    • migration_engine
      • PyServerToCloudMigrationPlanBuilder
      • PyMigrationPlanBuilder
      • PyContentMigrationItem
      • PyMigrationPlan
    • migration_engine_actions
      • PyMigrationActionResult
    • migration_engine_endpoints_search
      • PyDestinationContentReferenceFinder
      • PyDestinationContentReferenceFinderFactory
      • PySourceContentReferenceFinder
      • PySourceContentReferenceFinderFactory
    • migration_engine_hooks
      • PyMigrationHookBuilder
      • PyMigrationHookFactoryCollection
    • migration_engine_hooks_filters
      • PyContentFilterBuilder
    • migration_engine_hooks_filters_interop
      • PyContentFilterBase
    • migration_engine_hooks_initializemigration
      • PyInitializeMigrationHookResult
    • migration_engine_hooks_interop
      • PyContentBatchMigrationCompletedHookBase
      • PyInitializeMigrationHookBase
      • PyMigrationActionCompletedHookBase
    • migration_engine_hooks_mappings
      • PyContentMappingBuilder
      • PyContentMappingContext
    • migration_engine_hooks_mappings_interop
      • PyTableauCloudUsernameMappingBase
      • PyContentMappingBase
    • migration_engine_hooks_postpublish
      • PyBulkPostPublishContext
      • PyContentItemPostPublishContext
    • migration_engine_hooks_postpublish_interop
      • PyBulkPostPublishHookBase
      • PyContentItemPostPublishHookBase
    • migration_engine_hooks_transformers
      • PyContentTransformerBuilder
    • migration_engine_hooks_transformers_interop
      • PyContentTransformerBase
      • PyXmlContentTransformerBase
    • migration_engine_manifest
      • PyMigrationManifestEntry
      • PyMigrationManifestEntryEditor
      • PyMigrationManifestEntryStatus
      • PyMigrationManifestSerializer
    • 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

PyContentTransformerBuilder

class PyContentTransformerBuilder(content_transformer_builder)

Bases: object

Default IContentTransformerBuilder implementation.

  • Parameters: content_transformer_builder (IContentTransformerBuilder)

__init__(content_transformer_builder)

Default init.

Args: : content_transformer_builder: An object with methods to build IContentTransformer”/

Returns: None.

  • Parameters: content_transformer_builder (IContentTransformerBuilder)
  • Return type: None

Methods

__init__(content_transformer_builder) Default init.
add(input_0[, input_1, is_xml]) Adds an object or function to execute transformers.
build() Builds an immutable collection from the currently added transformers.
by_content_type() Gets the currently registered hook factories by their content types.
clear() Removes all currently registered transformers.

clear()

Removes all currently registered transformers.

Returns: : The same transformer builder object for fluent API calls.

  • Return type: Self

add(input_0, input_1=None, is_xml=False)

Adds an object or function to execute transformers.

Args: : input_0: Either: : 1. The transformer type to execute, or 2. The content type for a callback function
input_1: Either: : 1. The callback function to execute, or 2. None
is_xml: True if the given callback function is an xml transformer callback, otherwise false.

Returns: : The same mapping builder object for fluent API calls.

  • Parameters:
    • input_0 (type)
    • input_1 (Callable | None)
    • is_xml (bool)
  • Return type: Self

by_content_type()

Gets the currently registered hook factories by their content types.

Returns: : The hook factories by their content types.

build()

Builds an immutable collection from the currently added transformers.

Returns: : The created collection.

  • Return type: PyMigrationHookFactoryCollection
In this article