Class MigrationManifest
Default IMigrationManifest implementation.
Namespace: Tableau.Migration.Engine.Manifest
Assembly: Tableau.Migration.dll
Syntax
public class MigrationManifest : IMigrationManifestEditor, IMigrationManifest, IEquatable<IMigrationManifest>Constructors
MigrationManifest(ISharedResourcesLocalizer, ILoggerFactory, Guid, Guid, IMigrationManifest?)
Creates a new MigrationManifest object.
Declaration
public MigrationManifest(ISharedResourcesLocalizer localizer, ILoggerFactory loggerFactory, Guid planId, Guid migrationId, IMigrationManifest? copyEntriesManifest = null)Parameters
| Type | Name | Description |
|---|---|---|
| ISharedResourcesLocalizer | localizer | A localizer. |
| ILoggerFactory | loggerFactory | A logger factory; |
| Guid | planId | |
| Guid | migrationId | |
| 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. |
Fields
LatestManifestVersion
The latest manifest version number.
Declaration
public const uint LatestManifestVersion = 4Field 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 |
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(IEnumerable<Exception>)
Adds top-level errors that are not related to any Tableau content item.
Declaration
public IMigrationManifestEditor AddErrors(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 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. |
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
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 |
GetHashCode()
Serves as the default hash function.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| int | A hash code for the current object. |
Overrides
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 |