Class MigrationCapabilityManagerBase
Standard base class for IMigrationCapabilityManager implementations.
Implements
Namespace: Tableau.Migration.Engine.Hooks.InitializeMigration.Capabilities
Assembly: Tableau.Migration.dll
Syntax
public abstract class MigrationCapabilityManagerBase : IMigrationCapabilityManager
Constructors
MigrationCapabilityManagerBase(IMigrationCapabilitiesEditor, ISharedResourcesLocalizer, ILogger)
Creates a new MigrationCapabilityManagerBase object.
Declaration
public MigrationCapabilityManagerBase(IMigrationCapabilitiesEditor capabilities, ISharedResourcesLocalizer localizer, ILogger logger)
Parameters
Type | Name | Description |
---|---|---|
IMigrationCapabilitiesEditor | capabilities | The migration capabilities to populate/manage. |
ISharedResourcesLocalizer | localizer | The localizer. |
ILogger | logger | The logger. |
Properties
Capabilities
Gets the migration capabilities to populate/manage.
Declaration
protected IMigrationCapabilitiesEditor Capabilities { get; }
Property Value
Type | Description |
---|---|
IMigrationCapabilitiesEditor |
Localizer
Gets the localizer.
Declaration
protected ISharedResourcesLocalizer Localizer { get; }
Property Value
Type | Description |
---|---|
ISharedResourcesLocalizer |
Logger
Gets the logger.
Declaration
protected ILogger Logger { get; }
Property Value
Type | Description |
---|---|
ILogger |
Methods
LogCapabilityDisabled(string, string)
Logs a warning that a content type will be disabled for a capability reason.
Declaration
protected void LogCapabilityDisabled(string typeName, string reason)
Parameters
Type | Name | Description |
---|---|---|
string | typeName | The content type name. |
string | reason | The reason for the capability being disabled. |
SetMigrationCapabilityAsync(IInitializeMigrationContext, CancellationToken)
Sets the migration capability.
Declaration
public abstract Task<IResult> SetMigrationCapabilityAsync(IInitializeMigrationContext ctx, CancellationToken cancel)
Parameters
Type | Name | Description |
---|---|---|
IInitializeMigrationContext | ctx | The preflight context. |
CancellationToken | cancel | The cancellation token to obey. |
Returns
Type | Description |
---|---|
Task<IResult> | The result of setting the capability. Return a failure result to fail the preflight check and prevent migration from continuing. |