Interface IMigrationPlanBuilder<TSelf>

Interface for an object that can build IMigrationPlan objects.

Namespace: Tableau.Migration

Assembly: Tableau.Migration.dll

Syntax

public interface IMigrationPlanBuilder<TSelf>

Type Parameters

Name	Description
TSelf	The plan builder type used for fluent API return types.

Properties

Destination

Gets the destination endpoint builder.

Declaration

IMigrationPlanEndpointBuilder Destination { get; }

Property Value

Type	Description
IMigrationPlanEndpointBuilder

Filters

Gets the filters to execute at various points during the migration.

Declaration

IContentFilterBuilder Filters { get; }

Property Value

Type	Description
IContentFilterBuilder

Hooks

Gets the hooks to execute at various points during the migration, determined by hook type.

Declaration

IMigrationHookBuilder Hooks { get; }

Property Value

Type	Description
IMigrationHookBuilder

Mappings

Gets the mappings to execute at various points during the migration.

Declaration

IContentMappingBuilder Mappings { get; }

Property Value

Type	Description
IContentMappingBuilder

Options

Gets the per-plan options to supply.

Declaration

IMigrationPlanOptionsBuilder Options { get; }

Property Value

Type	Description
IMigrationPlanOptionsBuilder

PipelineProfile

Gets the pipeline profile to execute.

Declaration

PipelineProfile PipelineProfile { get; }

Property Value

Type	Description
PipelineProfile

Services

Gets the migration service overrides.

Declaration

IMigrationServiceBuilder Services { get; }

Property Value

Type	Description
IMigrationServiceBuilder

Source

Gets the source endpoint builder.

Declaration

IMigrationPlanEndpointBuilder Source { get; }

Property Value

Type	Description
IMigrationPlanEndpointBuilder

Transformers

Gets the transformations to execute at various points during the migration.

Declaration

IContentTransformerBuilder Transformers { get; }

Property Value

Type	Description
IContentTransformerBuilder

Methods

AppendDefaultExtensions()

Adds default hooks, filters, etc. that are common between all migration scenarios.

Declaration

TSelf AppendDefaultExtensions()

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

Build()

Finalizes the IMigrationPlan based on the current state.

Declaration

IMigrationPlan Build()

Returns

Type	Description
IMigrationPlan	The created IMigrationPlan.

ClearExtensions()

Clears all hooks, filters, mappings, and transformations.

Declaration

TSelf ClearExtensions()

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

ForCustomPipelineFactory(Func<IServiceProvider, IMigrationPipelineFactory>, params IEnumerable<MigrationPipelineContentType>)

Initializes the plan to perform a custom migration pipeline using the given pipeline factory.

Declaration

TSelf ForCustomPipelineFactory(Func<IServiceProvider, IMigrationPipelineFactory> pipelineFactoryOverride, params IEnumerable<MigrationPipelineContentType> supportedContentTypes)

Parameters

Type	Name	Description
Func<IServiceProvider, IMigrationPipelineFactory>	pipelineFactoryOverride	An initializer function to build the pipeline factory.
IEnumerable<MigrationPipelineContentType>	supportedContentTypes	The supported content types of the custom pipeline.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

ForCustomPipelineFactory<T>(params IEnumerable<MigrationPipelineContentType>)

Initializes the plan to perform a custom migration pipeline using the given pipeline factory.

Declaration

TSelf ForCustomPipelineFactory<T>(params IEnumerable<MigrationPipelineContentType> supportedContentTypes) where T : IMigrationPipelineFactory

Parameters

Type	Name	Description
IEnumerable<MigrationPipelineContentType>	supportedContentTypes	The supported content types of the custom pipeline.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

Type Parameters

Name	Description
T

ForCustomPipeline<T>(params IEnumerable<MigrationPipelineContentType>)

Initializes the plan to perform a custom migration pipeline.

Declaration

TSelf ForCustomPipeline<T>(params IEnumerable<MigrationPipelineContentType> supportedContentTypes) where T : IMigrationPipeline

Parameters

Type	Name	Description
IEnumerable<MigrationPipelineContentType>	supportedContentTypes	The supported content types of the custom pipeline.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

Type Parameters

Name	Description
T

ForServerToCloud()

Initializes the plan to perform a migration of content between a Tableau Server and Tableau Cloud site.

Declaration

IServerToCloudMigrationPlanBuilder ForServerToCloud()

Returns

Type	Description
IServerToCloudMigrationPlanBuilder	The same plan builder object for fluent API calls.

FromSource(IMigrationPlanEndpointConfiguration)

Sets or overwrites the configuration for the source endpoint to migrate content from.

Declaration

TSelf FromSource(IMigrationPlanEndpointConfiguration config)

Parameters

Type	Name	Description
IMigrationPlanEndpointConfiguration	config	The endpoint configuration.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

FromSourceTableauServer(Uri, string, string, string, bool, string?)

Sets or overwrites the configuration for the source Tableau Server site to migrate content from.

Declaration

TSelf FromSourceTableauServer(Uri serverUrl, string siteContentUrl, string accessTokenName, string accessToken, bool createApiSimulator = false, string? restApiVersion = null)

Parameters

Type	Name	Description
Uri	serverUrl	The base URL of the Tableau Server to connect to.
string	siteContentUrl	The URL namespace of the site to connect to. Can be empty string for default site.
string	accessTokenName	The name of the personal access token to use to sign into the site.
string	accessToken	The personal access token to use to sign into the site.
bool	createApiSimulator	Whether or not to create an API simulator for the serverUrl.
string	restApiVersion	The REST API version to use, or null to use the default version.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

SkipContentType(Type, bool)

Configures the migration plan to skip migration of all items of a particular content type.

Declaration

TSelf SkipContentType(Type contentType, bool preCache = true)

Parameters

Type	Name	Description
Type	contentType	The content type to skip.
bool	preCache	True to find and map all source items so references in dependent content types can be efficiently updated. False to find and map items individually when they are referenced in dependent content types to avoid listing all items.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

SkipContentType<TContent>(bool)

Configures the migration plan to skip migration of all items of a particular content type.

Declaration

TSelf SkipContentType<TContent>(bool preCache = true)

Parameters

Type	Name	Description
bool	preCache	True to find and map all source items so references in dependent content types can be efficiently updated. False to find and map items individually when they are referenced in dependent content types to avoid listing all items.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

Type Parameters

Name	Description
TContent	The content type to skip.

ToDestination(IMigrationPlanEndpointConfiguration)

Sets or overwrites the configuration for the destination endpoint to migrate content to.

Declaration

TSelf ToDestination(IMigrationPlanEndpointConfiguration config)

Parameters

Type	Name	Description
IMigrationPlanEndpointConfiguration	config	The endpoint configuration.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

ToDestinationTableauCloud(Uri, string, string, string, bool, string?)

Sets or overwrites the configuration for the destination Tableau Cloud site to migrate content to.

Declaration

TSelf ToDestinationTableauCloud(Uri podUrl, string siteContentUrl, string accessTokenName, string accessToken, bool createApiSimulator = false, string? restApiVersion = null)

Parameters

Type	Name	Description
Uri	podUrl	The base URL of Tableau Cloud pod to connect to.
string	siteContentUrl	The URL namespace of the site to connect to.
string	accessTokenName	The name of the personal access token to use to sign into the site.
string	accessToken	The personal access token to use to sign into the site.
bool	createApiSimulator	Whether or not to create an API simulator for the podUrl.
string	restApiVersion	The REST API version to use, or null to use the default version.

Returns

Type	Description
TSelf	The same plan builder object for fluent API calls.

Validate()

Validates that the plan that would be built has enough information to execute.

Declaration

IResult Validate()

Returns

Type	Description
IResult	The validation result.