Tableau Migration SDK 5.2.0
  • 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

PyMigrationPipelineContentType

class PyMigrationPipelineContentType(migration_pipeline_content_type)

Bases: object

Object that represents a definition of a content type that a pipeline migrates.

  • Parameters: migration_pipeline_content_type (MigrationPipelineContentType)

__init__(migration_pipeline_content_type)

Creates a new PyMigrationPipelineContentType object.

Args: : migration_pipeline_content_type: A MigrationPipelineContentType object.

Returns: None.

  • Parameters: migration_pipeline_content_type (MigrationPipelineContentType)
  • Return type: None

Methods

__init__(migration_pipeline_content_type) Creates a new PyMigrationPipelineContentType object.
get_all_migration_pipeline_content_types() Gets all static instances of MigrationPipelineContentType.
get_cloud_to_cloud_extract_refresh_tasks() Gets the Cloud to Cloud extract refresh tasks MigrationPipelineContentType.
get_cloud_to_cloud_subscriptions() Gets the Cloud to Cloud subscriptions MigrationPipelineContentType.
get_config_key() Gets the config key for this content type.
get_config_key_for_type(content_type) Gets the config key for a content type.
get_custom_views() Gets the custom views MigrationPipelineContentType.
get_data_sources() Gets the data sources MigrationPipelineContentType.
get_display_name_for_type(content_type, plural) Gets the friendly display name for a content type.
get_groups() Gets the groups MigrationPipelineContentType.
get_migration_pipeline_content_types(profile) Gets the content types for a given profile.
get_projects() Gets the projects MigrationPipelineContentType.
get_server_to_cloud_extract_refresh_tasks() Gets the Server to Cloud extract refresh tasks MigrationPipelineContentType.
get_server_to_cloud_subscriptions() Gets the Server to Cloud subscriptions MigrationPipelineContentType.
get_server_to_server_extract_refresh_tasks() Gets the Server to Server extract refresh tasks MigrationPipelineContentType.
get_server_to_server_subscriptions() Gets the Server to Server subscriptions MigrationPipelineContentType.
get_users() Gets the user MigrationPipelineContentType.
get_views() Gets the views MigrationPipelineContentType.
get_workbooks() Gets the workbooks MigrationPipelineContentType.

Attributes

content_type The content type.
prepare_type Gets the preparation type that is pulled and converted for publishing.
publish_type Gets the publish type.
result_type Gets the result type returned by publishing.
types Gets the types for this instance.

classmethod get_users()

Gets the user MigrationPipelineContentType.

  • Return type: Self

classmethod get_groups()

Gets the groups MigrationPipelineContentType.

  • Return type: Self

classmethod get_projects()

Gets the projects MigrationPipelineContentType.

  • Return type: Self

classmethod get_data_sources()

Gets the data sources MigrationPipelineContentType.

  • Return type: Self

classmethod get_workbooks()

Gets the workbooks MigrationPipelineContentType.

  • Return type: Self

classmethod get_views()

Gets the views MigrationPipelineContentType.

  • Return type: Self

classmethod get_server_to_server_extract_refresh_tasks()

Gets the Server to Server extract refresh tasks MigrationPipelineContentType.

  • Return type: Self

classmethod get_server_to_cloud_extract_refresh_tasks()

Gets the Server to Cloud extract refresh tasks MigrationPipelineContentType.

  • Return type: Self

classmethod get_cloud_to_cloud_extract_refresh_tasks()

Gets the Cloud to Cloud extract refresh tasks MigrationPipelineContentType.

  • Return type: Self

classmethod get_custom_views()

Gets the custom views MigrationPipelineContentType.

  • Return type: Self

classmethod get_server_to_server_subscriptions()

Gets the Server to Server subscriptions MigrationPipelineContentType.

  • Return type: Self

classmethod get_server_to_cloud_subscriptions()

Gets the Server to Cloud subscriptions MigrationPipelineContentType.

  • Return type: Self

classmethod get_cloud_to_cloud_subscriptions()

Gets the Cloud to Cloud subscriptions MigrationPipelineContentType.

  • Return type: Self

property content_type : Type

The content type. Content type is returned from list step, pre-pull.

property prepare_type : Type

Gets the preparation type that is pulled and converted for publishing. The Prepare type is the post-pull, pre-conversion type.

property publish_type : Type

Gets the publish type. The publish type is post-conversion, ready to publish.

property result_type : Type

Gets the result type returned by publishing.

property types : Sequence[Type]

Gets the types for this instance.

get_config_key()

Gets the config key for this content type.

Returns: The config key string.

  • Return type: str

classmethod get_config_key_for_type(content_type)

Gets the config key for a content type.

Args: : content_type: The content type.

Returns: The config key string.

  • Parameters: content_type (Type)
  • Return type: str

classmethod get_display_name_for_type(content_type, plural)

Gets the friendly display name for a content type.

Args: : content_type: The content type. plural: Whether the display name should be in plural form.

Returns: The display name string.

  • Parameters:
    • content_type (Type)
    • plural (bool)
  • Return type: str

classmethod get_migration_pipeline_content_types(profile)

Gets the content types for a given profile.

Args: : profile: Profile to get the types for.

Returns: Array of content types supported by the given pipeline profile.

  • Parameters: profile (PyPipelineProfile)
  • Return type: Sequence[Self]

classmethod get_all_migration_pipeline_content_types()

Gets all static instances of MigrationPipelineContentType.

  • Return type: Sequence[Self]
In this article