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

PyMigrationManifest

class PyMigrationManifest(migration_manifest)

Bases: object

Interface for an object that describes the various Tableau data items found to migrate and their migration results.

  • Parameters: migration_manifest (IMigrationManifestEditor)

__init__(migration_manifest)

Default init.

Args: : migration_manifest: IMigrationManifest that can be edited

Returns: None.

  • Parameters: migration_manifest (IMigrationManifestEditor)
  • Return type: None

Methods

__init__(migration_manifest) Default init.
add_errors(errors) Adds top-level errors that are not related to any Tableau content item.

Attributes

entries Gets the collection of manifest entries.
errors Gets top-level errors that are not related to any Tableau content item but occurred during the migration.
manifest_version Gets the version of this manifest.
migration_id Gets the unique identifier of the migration run that produced this manifest.
pipeline_profile Gets the profile of the migration pipeline that produced this manifest.
plan_id Gets the unique identifier of the IMigrationPlan that was executed to produce this manifest.

property plan_id : UUID

Gets the unique identifier of the IMigrationPlan that was executed to produce this manifest.

property migration_id : UUID

Gets the unique identifier of the migration run that produced this manifest.

property manifest_version : int

Gets the version of this manifest. Used for serialization.

property pipeline_profile : PyPipelineProfile

Gets the profile of the migration pipeline that produced this manifest.

property errors

Gets top-level errors that are not related to any Tableau content item but occurred during the migration.

property entries

Gets the collection of manifest entries.

add_errors(errors)

Adds top-level errors that are not related to any Tableau content item.

Args: : errors: The errors to add. Either a List[System.Exception] or System.Exception

Returns: This manifest editor, for fluent API usage.

  • Return type: Self
In this article