Class ContentMigrationBatch<TContent, TPublish>

Class representing the state of a batch of content items being migrated.

Inheritance

object

ContentMigrationBatch<TContent, TPublish>

Implements

IAsyncDisposable

Namespace: Tableau.Migration.Engine.Migrators.Batch

Assembly: Tableau.Migration.dll

Syntax

public class ContentMigrationBatch<TContent, TPublish> : IAsyncDisposable

Type Parameters

Name	Description
TContent	The content type.
TPublish	The publish type.

Constructors

ContentMigrationBatch(ImmutableArray<ContentMigrationItem<TContent>>, CancellationToken)

Creates a new ContentMigrationBatch<TContent, TPublish> object.

Declaration

public ContentMigrationBatch(ImmutableArray<ContentMigrationItem<TContent>> items, CancellationToken migrationCancel)

Parameters

Type	Name	Description
ImmutableArray<ContentMigrationItem<TContent>>	items	The items in the batch.
CancellationToken	migrationCancel	A migration-level cancellation token to gnerate a batch cancellation source from.

Properties

BatchCancelSource

Gets the batch-level cancellation source, linked to migration cancellation token.

Declaration

public CancellationTokenSource BatchCancelSource { get; }

Property Value

Type	Description
CancellationTokenSource

ItemResults

Gets the collection of item-level migration results.

Declaration

public ConcurrentQueue<IContentItemMigrationResult<TContent>> ItemResults { get; }

Property Value

Type	Description
ConcurrentQueue<IContentItemMigrationResult<TContent>>

Items

Gets the items in the batch.

Declaration

public ImmutableArray<ContentMigrationItem<TContent>> Items { get; }

Property Value

Type	Description
ImmutableArray<ContentMigrationItem<TContent>>

PublishItems

Gets the collection of items to publish.

Declaration

public ConcurrentDictionary<ContentMigrationItem<TContent>, TPublish> PublishItems { get; }

Property Value

Type	Description
ConcurrentDictionary<ContentMigrationItem<TContent>, TPublish>

Methods

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

Declaration

public virtual ValueTask DisposeAsync()

Returns

Type	Description
ValueTask	A task that represents the asynchronous dispose operation.

Implements

IAsyncDisposable