Tableau.Migration

Interface IServerToCloudMigrationPlanBuilder

Interface for an object that can build IMigrationPlan objects that migrate content from Tableau Server to Tableau Cloud.

Inherited Members

IMigrationPlanBuilder.ForServerToCloud()

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

IMigrationPlanBuilder.ForCustomPipelineFactory<T>(params IEnumerable<MigrationPipelineContentType>)

IMigrationPlanBuilder.ForCustomPipeline<T>(params IEnumerable<MigrationPipelineContentType>)

IMigrationPlanBuilder.ClearExtensions()

IMigrationPlanBuilder.AppendDefaultExtensions()

IMigrationPlanBuilder.FromSource(IMigrationPlanEndpointConfiguration)

IMigrationPlanBuilder.FromSourceTableauServer(Uri, string, string, string, bool)

IMigrationPlanBuilder.ToDestination(IMigrationPlanEndpointConfiguration)

IMigrationPlanBuilder.ToDestinationTableauCloud(Uri, string, string, string, bool)

IMigrationPlanBuilder.Options

IMigrationPlanBuilder.Hooks

IMigrationPlanBuilder.Validate()

IMigrationPlanBuilder.Mappings

IMigrationPlanBuilder.Filters

IMigrationPlanBuilder.Transformers

IMigrationPlanBuilder.PipelineProfile

IMigrationPlanBuilder.Build()

Namespace: Tableau.Migration

Assembly: Tableau.Migration.dll

Syntax

public interface IServerToCloudMigrationPlanBuilder : IMigrationPlanBuilder

Methods

AppendDefaultServerToCloudExtensions()

Appends default hooks, filters, mappings, and transformations for server-to-cloud migrations. This method is intended for upgrading existing plan builders - new plan builders should use ForServerToCloud() instead.

Declaration

IServerToCloudMigrationPlanBuilder AppendDefaultServerToCloudExtensions()

Returns

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

WithAuthenticationType(string, Func<ContentMappingContext<IUsernameContent>, CancellationToken, Task<string?>>)

Adds an object to map user and group domains based on the destination authentication type. Use when the destination site is Tableau Server or has a single authentication configuration.

Declaration

IServerToCloudMigrationPlanBuilder WithAuthenticationType(string authenticationType, Func<ContentMappingContext<IUsernameContent>, CancellationToken, Task<string?>> callback)

Parameters

Type	Name	Description
string	authenticationType	The authentication type to assign to users. For sites without multiple authentication types an authSetting value from the Tableau API should be used. If the site has multiple authentication types the IdP configuration name shown in the authentication configuration list should be used.
Func<ContentMappingContext<IUsernameContent>, CancellationToken, Task<string>>	callback	A callback to call for the mapping.

Returns

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

WithAuthenticationType(string, string, string)

Adds an object to map user and group domains based on the destination authentication type. Use when the destination site is Tableau Server or has a single authentication configuration.

Declaration

IServerToCloudMigrationPlanBuilder WithAuthenticationType(string authenticationType, string userDomain, string groupDomain)

Parameters

Type	Name	Description
string	authenticationType	The authentication type to assign to users. For sites without multiple authentication types an authSetting value from the Tableau API should be used. If the site has multiple authentication types the IdP configuration name shown in the authentication configuration list should be used.
string	userDomain	The domain to map users to.
string	groupDomain	The domain to map groups to.

Returns

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

WithAuthenticationType(string, IAuthenticationTypeDomainMapping)

Adds an object to map user and group domains based on the destination authentication type. Use when the destination site is Tableau Server or has a single authentication configuration.

Declaration

IServerToCloudMigrationPlanBuilder WithAuthenticationType(string authenticationType, IAuthenticationTypeDomainMapping authenticationTypeMapping)

Parameters

Type	Name	Description
string	authenticationType	The authentication type to assign to users. For sites without multiple authentication types an authSetting value from the Tableau API should be used. If the site has multiple authentication types the IdP configuration name shown in the authentication configuration list should be used.
IAuthenticationTypeDomainMapping	authenticationTypeMapping	The mapping to execute.

Returns

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

WithAuthenticationType<TMapping>(string, Func<IServiceProvider, TMapping>?)

Adds an object to map user and group domains based on the destination authentication type. Use when the destination site is Tableau Server or has a single authentication configuration.

Declaration

IServerToCloudMigrationPlanBuilder WithAuthenticationType<TMapping>(string authenticationType, Func<IServiceProvider, TMapping>? authenticationTypeMappingFactory = null) where TMapping : IAuthenticationTypeDomainMapping

Parameters

Type	Name	Description
string	authenticationType	The authentication type to assign to users. For sites without multiple authentication types an authSetting value from the Tableau API should be used. If the site has multiple authentication types the IdP configuration name shown in the authentication configuration list should be used.
Func<IServiceProvider, TMapping>	authenticationTypeMappingFactory	An initializer function to create the object from, potentially from the migration-scoped dependency injection container.

Returns

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

Type Parameters

Name	Description
TMapping	The mapping type.

WithSamlAuthenticationType(string, string?)

Adds an object to map user and group domains based on the SAML authentication type.

Declaration

IServerToCloudMigrationPlanBuilder WithSamlAuthenticationType(string domain, string? idpConfigurationName = null)

Parameters

Type	Name	Description
string	domain	The domain to map users and groups to.
string	idpConfigurationName	The IdP configuration name for the authentication type to assign to users. Should be null when the destination site is Tableau Server or has a single authentication configuration. Should be non-null when the destination site is Tableau Cloud and has multiple authentication configurations.

Returns

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

WithTableauCloudUsernames(Func<ContentMappingContext<IUser>, CancellationToken, Task<ContentMappingContext<IUser>?>>)

Adds an object to map usernames to be in the form of an email.

Declaration

IServerToCloudMigrationPlanBuilder WithTableauCloudUsernames(Func<ContentMappingContext<IUser>, CancellationToken, Task<ContentMappingContext<IUser>?>> callback)

Parameters

Type	Name	Description
Func<ContentMappingContext<IUser>, CancellationToken, Task<ContentMappingContext<IUser>>>	callback	A callback to call for the mapping.

Returns

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

WithTableauCloudUsernames(string, bool)

Adds an object to map usernames to be in the form of an email.

Declaration

IServerToCloudMigrationPlanBuilder WithTableauCloudUsernames(string mailDomain, bool useExistingEmail = true)

Parameters

Type	Name	Description
string	mailDomain	A domain name to use to build email usernames for users that lack emails. Usernames will be generated as "@`mailDomain`".
bool	useExistingEmail	Whether or not existing user emails should be used when available, defaults to true.

Returns

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

WithTableauCloudUsernames(ITableauCloudUsernameMapping)

Adds an object to map usernames to be in the form of an email.

Declaration

IServerToCloudMigrationPlanBuilder WithTableauCloudUsernames(ITableauCloudUsernameMapping usernameMapping)

Parameters

Type	Name	Description
ITableauCloudUsernameMapping	usernameMapping	The mapping to execute.

Returns

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

WithTableauCloudUsernames<TMapping>(Func<IServiceProvider, TMapping>?)

Adds an object to map usernames to be in the form of an email.

Declaration

IServerToCloudMigrationPlanBuilder WithTableauCloudUsernames<TMapping>(Func<IServiceProvider, TMapping>? usernameMappingFactory = null) where TMapping : ITableauCloudUsernameMapping

Parameters

Type	Name	Description
Func<IServiceProvider, TMapping>	usernameMappingFactory	An initializer function to create the object from, potentially from the migration-scoped dependency injection container.

Returns

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

Type Parameters

Name	Description
TMapping	The mapping type.

WithTableauIdAuthenticationType(bool, string?)

Adds an object to map user and group domains based on the Tableau ID authentication type.

Declaration

IServerToCloudMigrationPlanBuilder WithTableauIdAuthenticationType(bool mfa = true, string? idpConfigurationName = null)

Parameters

Type	Name	Description
bool	mfa	Whether or not MFA is used, defaults to true.
string	idpConfigurationName	The IdP configuration name for the authentication type to assign to users. Should be null when the destination site is Tableau Server or has a single authentication configuration. Should be non-null when the destination site is Tableau Cloud and has multiple authentication configurations.

Returns

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