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

PyContentMappingBuilder

class PyContentMappingBuilder(content_mapping_builder)

Bases: object

Default IContentMappingBuilder implementation.

  • Parameters: content_mapping_builder (IContentMappingBuilder)

__init__(content_mapping_builder)

Default init.

Args: : content_mapping_builder: An object with methods to build IContentMapping”

Returns: None.

  • Parameters: content_mapping_builder (IContentMappingBuilder)
  • Return type: None

Methods

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

clear()

Removes all currently registered mappings.

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

  • Return type: Self

add(input_0, input_1=None)

Adds an object or function to execute mappings.

Args: : input_0: Either: : 1. The mapping type to execute, or 2. The content type for a callback function
input_1: Either: : 1. The callback function to execute, or 2. None

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

  • Parameters:
    • input_0 (type)
    • input_1 (Callable | None)
  • 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 mappings.

Returns: : The created collection.

  • Return type: PyMigrationHookFactoryCollection
In this article