Class EndpointSettingCapabilityManagerBase

Base class for IMigrationCapabilityManagers that are determined by source/destination endpoint settings.

Inheritance
object
MigrationCapabilityManagerBase
EndpointSettingCapabilityManagerBase
Implements
Inherited Members
Namespace: Tableau.Migration.Engine.Hooks.InitializeMigration.Capabilities
Assembly: Tableau.Migration.dll
Syntax
public abstract class EndpointSettingCapabilityManagerBase : MigrationCapabilityManagerBase, IMigrationCapabilityManager

Constructors

EndpointSettingCapabilityManagerBase(IMigrationCapabilitiesEditor, ISharedResourcesLocalizer, ILogger)

Creates a new EndpointSettingCapabilityManagerBase object.

Declaration
protected EndpointSettingCapabilityManagerBase(IMigrationCapabilitiesEditor capabilities, ISharedResourcesLocalizer localizer, ILogger logger)
Parameters
Type Name Description
IMigrationCapabilitiesEditor capabilities

The migration capabilities to populate/manage.The localizer.The logger.
ISharedResourcesLocalizer localizer

The migration capabilities to populate/manage.The localizer.The logger.
ILogger logger

The migration capabilities to populate/manage.The localizer.The logger.

Properties

CapabilityContentTypes

Gets the content type(s) managed by this capability manager.

Declaration
protected abstract IEnumerable<Type> CapabilityContentTypes { get; }
Property Value
Type Description
IEnumerable<Type>

DisplayCapabilityContentTypes

Gets the content type used for display text in log messages.

Declaration
protected virtual Type DisplayCapabilityContentTypes { get; }
Property Value
Type Description
Type

Methods

GetEndpointDisabledSetting(IEndpointPreflightContext)

Gets whether the endpoint has a setting disabling the content type(s) managed by this capability manager.

Declaration
protected abstract bool GetEndpointDisabledSetting(IEndpointPreflightContext ctx)
Parameters
Type Name Description
IEndpointPreflightContext ctx

The endpoint's preflight context.
Returns
Type Description
bool

True if the content type(s) are disabled, otherwise false.

SetMigrationCapabilityAsync(IInitializeMigrationContext, CancellationToken)

Sets the migration capability.

Declaration
public override 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.
Overrides

Implements