Class MigrationManifest

Default IMigrationManifest implementation.

Inheritance
object
MigrationManifest
LoggingMigrationManifest
Implements
Namespace: Tableau.Migration.Engine.Manifest
Assembly: Tableau.Migration.dll
Syntax
public class MigrationManifest : IMigrationManifestEditor, IMigrationManifest, IEquatable<IMigrationManifest>

Constructors

MigrationManifest(Guid, Guid, PipelineProfile, IMigrationManifest?)

Creates a new MigrationManifest object.

Declaration
public MigrationManifest(Guid planId, Guid migrationId, PipelineProfile pipelineProfile, IMigrationManifest? copyEntriesManifest = null)
Parameters
Type Name Description
Guid planId
Guid migrationId
PipelineProfile pipelineProfile
IMigrationManifest copyEntriesManifest

An optional manifest to copy entries from. Null will initialize the manifest with an empty set of entries. Top-level information is not copied.

MigrationManifest(Guid, Guid, PipelineProfile, IMigrationManifest?, Func<IMigrationManifestEntryCollection?, MigrationManifestEntryCollection>)

Protected constructor that allows derived classes to provide a factory for creating entry collections. This allows derived classes to use their own dependencies without the base class needing to know about them.

Declaration
protected MigrationManifest(Guid planId, Guid migrationId, PipelineProfile pipelineProfile, IMigrationManifest? copyEntriesManifest, Func<IMigrationManifestEntryCollection?, MigrationManifestEntryCollection> createEntryCollection)
Parameters
Type Name Description
Guid planId
Guid migrationId
PipelineProfile pipelineProfile
IMigrationManifest copyEntriesManifest

An optional manifest to copy entries from. Null will initialize the manifest with an empty set of entries. Top-level information is not copied.
Func<IMigrationManifestEntryCollection, MigrationManifestEntryCollection> createEntryCollection

Factory function to create the entry collection.

MigrationManifest(IMigrationManifest)

Creates a new MigrationManifest object.

Declaration
public MigrationManifest(IMigrationManifest copyEntriesManifest)
Parameters
Type Name Description
IMigrationManifest copyEntriesManifest

An optional manifest to copy entries from. Null will initialize the manifest with an empty set of entries. Top-level information is not copied.

MigrationManifest(PipelineProfile)

Creates a new MigrationManifest object.

Declaration
public MigrationManifest(PipelineProfile pipelineProfile)
Parameters
Type Name Description
PipelineProfile pipelineProfile

Fields

LatestManifestVersion

The latest manifest version number.

Declaration
public const uint LatestManifestVersion = 4
Field Value
Type Description
uint

Properties

Entries

Gets an object to edit manifest entries with.

Declaration
public virtual IMigrationManifestEntryCollectionEditor Entries { get; }
Property Value
Type Description
IMigrationManifestEntryCollectionEditor

Errors

Gets top-level errors that are not related to any Tableau content item but occurred during the migration.

Declaration
public IReadOnlyList<Exception> Errors { get; }
Property Value
Type Description
IReadOnlyList<Exception>

ManifestVersion

Gets the version of this manifest. Used for serialization.

Declaration
public virtual uint ManifestVersion { get; }
Property Value
Type Description
uint

MigrationId

Gets the unique identifier of the migration run that produced this manifest.

Declaration
public Guid MigrationId { get; }
Property Value
Type Description
Guid

PipelineProfile

Gets the profile of the pipeline that was executed to produce this manifest.

Declaration
public PipelineProfile PipelineProfile { get; }
Property Value
Type Description
PipelineProfile

PlanId

Gets the unique identifier of the IMigrationPlan that was executed to produce this manifest.

Declaration
public Guid PlanId { get; }
Property Value
Type Description
Guid

Methods

AddErrors(params IEnumerable<Exception>)

Adds top-level errors that are not related to any Tableau content item.

Declaration
public virtual IMigrationManifestEditor AddErrors(params IEnumerable<Exception> errors)
Parameters
Type Name Description
IEnumerable<Exception> errors

The errors to add.
Returns
Type Description
IMigrationManifestEditor

This manifest editor, for fluent API usage.

AddErrors(params Exception[])

Adds top-level errors that are not related to any Tableau content item.

Declaration
public virtual IMigrationManifestEditor AddErrors(params Exception[] errors)
Parameters
Type Name Description
Exception[] errors

The errors to add.
Returns
Type Description
IMigrationManifestEditor

This manifest editor, for fluent API usage.

CreateEntryCollection(IMigrationManifestEntryCollection?)

Creates a new entry collection. Override in derived classes to create a custom entry collection type. This method is used by the public constructor to create the default entry collection. Derived classes should use the protected constructor with a factory delegate instead.

Declaration
protected static MigrationManifestEntryCollection CreateEntryCollection(IMigrationManifestEntryCollection? copy)
Parameters
Type Name Description
IMigrationManifestEntryCollection copy

An optional collection to copy entries from.
Returns
Type Description
MigrationManifestEntryCollection

The newly created entry collection.

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? other)
Parameters
Type Name Description
object other
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
Overrides
object.Equals(object)

Equals(IMigrationManifest?)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(IMigrationManifest? other)
Parameters
Type Name Description
IMigrationManifest other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides
object.GetHashCode()

Operators

operator ==(MigrationManifest?, MigrationManifest?)

Declaration
public static bool operator ==(MigrationManifest? a, MigrationManifest? b)
Parameters
Type Name Description
MigrationManifest a
MigrationManifest b
Returns
Type Description
bool

operator !=(MigrationManifest?, MigrationManifest?)

Declaration
public static bool operator !=(MigrationManifest? a, MigrationManifest? b)
Parameters
Type Name Description
MigrationManifest a
MigrationManifest b
Returns
Type Description
bool

Implements