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

PyMigrationPlan

class PyMigrationPlan(migration_plan)

Bases: object

Default IMigrationPlan implementation.

  • Parameters: migration_plan (IMigrationPlan)

__init__(migration_plan)

Default init.

Args: : migration_plan: An object that describes how to perform a migration of Tableau data between sites.

Returns: None.

  • Parameters: migration_plan (IMigrationPlan)
  • Return type: None

Methods

__init__(migration_plan) Default init.

Attributes

destination Gets the defined destination endpoint configuration.
filters Gets the collection of registered filters for each content type.
hooks Gets the collection of registered hooks for each hook type.
mappings Gets the collection of registered mappings for each content type.
options Gets the per-plan options.
pipeline_profile Gets the profile of the pipeline that will be built and executed.
plan_id Gets the per-plan options to supply.
source Gets the defined source endpoint configuration.
transformers Gets the collection of registered transformers for each content type.

property plan_id : UUID

Gets the per-plan options to supply.

property pipeline_profile : PyPipelineProfile

Gets the profile of the pipeline that will be built and executed.

property options

Gets the per-plan options.

property source

Gets the defined source endpoint configuration.

property destination

Gets the defined destination endpoint configuration.

property hooks : PyMigrationHookFactoryCollection

Gets the collection of registered hooks for each hook type.

property mappings : PyMigrationHookFactoryCollection

Gets the collection of registered mappings for each content type.

property filters : PyMigrationHookFactoryCollection

Gets the collection of registered filters for each content type.

property transformers : PyMigrationHookFactoryCollection

Gets the collection of registered transformers for each content type.

In this article