Class MigrationManifestEntry

Default IMigrationManifestEntry and IMigrationManifestEntryEditor implementation.

Inheritance

object

MigrationManifestEntry

Implements

IMigrationManifestEntryEditor

IMigrationManifestEntry

IEquatable<IMigrationManifestEntry>

Namespace: Tableau.Migration.Engine.Manifest

Assembly: Tableau.Migration.dll

Syntax

public class MigrationManifestEntry : IMigrationManifestEntryEditor, IMigrationManifestEntry, IEquatable<IMigrationManifestEntry>

Constructors

MigrationManifestEntry(IMigrationManifestEntryBuilder, ContentReferenceStub)

Creates a new MigrationManifestEntry object.

Declaration

public MigrationManifestEntry(IMigrationManifestEntryBuilder entryBuilder, ContentReferenceStub sourceReference)

Parameters

Type	Name	Description
IMigrationManifestEntryBuilder	entryBuilder	The entry builder to notify with changes.
ContentReferenceStub	sourceReference	The content item's source information, as a stub.

MigrationManifestEntry(IMigrationManifestEntryBuilder, IMigrationManifestEntry)

Creates a new MigrationManifestEntry object.

Declaration

public MigrationManifestEntry(IMigrationManifestEntryBuilder entryBuilder, IMigrationManifestEntry copy)

Parameters

Type	Name	Description
IMigrationManifestEntryBuilder	entryBuilder	The entry builder to notify with changes.
IMigrationManifestEntry	copy	An entry from to copy values from.

MigrationManifestEntry(IMigrationManifestEntryBuilder, IMigrationManifestEntry, ContentReferenceStub)

Creates a new MigrationManifestEntry object.

Declaration

public MigrationManifestEntry(IMigrationManifestEntryBuilder entryBuilder, IMigrationManifestEntry copy, ContentReferenceStub sourceReference)

Parameters

Type	Name	Description
IMigrationManifestEntryBuilder	entryBuilder	The entry builder to notify with changes.
IMigrationManifestEntry	copy	An entry to copy values from.
ContentReferenceStub	sourceReference	The content item's updated source information, as a stub.

Properties

Destination

Gets the content item's destination information, or null if the content item was not migrated due to filtering, or otherwise not found in the destination during the course of the migration.

Declaration

public virtual IContentReference? Destination { get; set; }

Property Value

Type	Description
IContentReference

Errors

Gets errors that occurred while migrating the content item.

Declaration

public virtual IReadOnlyList<Exception> Errors { get; }

Property Value

Type	Description
IReadOnlyList<Exception>

HasMigrated

Gets whether or not the content item has been migrated, either in a previous run or the current run.

Declaration

public virtual bool HasMigrated { get; }

Property Value

Type	Description
bool

MappedLocation

Gets the content item's intended destination location, regardless if a Destination value is available or not. This value should match the Destination value's location if available.

Declaration

public virtual ContentLocation MappedLocation { get; }

Property Value

Type	Description
ContentLocation

SkippedReason

Gets the reason why the content item was skipped, if applicable.

Declaration

public virtual string SkippedReason { get; set; }

Property Value

Type	Description
string

Source

Gets the content item's source information.

Declaration

public virtual IContentReference Source { get; }

Property Value

Type	Description
IContentReference

Status

Gets the migration status code of the content item for the current run. See HasMigrated for the migration status across all runs.

Declaration

public virtual MigrationManifestEntryStatus Status { get; set; }

Property Value

Type	Description
MigrationManifestEntryStatus

Methods

DestinationFound(IContentReference)

Sets the Destination and MappedLocation information based on the given destination item reference.

Declaration

public virtual IMigrationManifestEntryEditor DestinationFound(IContentReference destinationInfo)

Parameters

Type	Name	Description
IContentReference	destinationInfo	The destination reference information.

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry 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

object.Equals(object)

Equals(IMigrationManifestEntry?)

Indicates if the current IMigrationManifestEntry is equal to another IMigrationManifestEntry. Note: This ignores if the errors are different

Declaration

public bool Equals(IMigrationManifestEntry? other)

Parameters

Type	Name	Description
IMigrationManifestEntry	other

Returns

Type	Description
bool	True if the current object is equal to the other parameter. Otherwise false.

Equals(IMigrationManifestEntry, IMigrationManifestEntry?)

Indicates if the current IMigrationManifestEntry is equal to another IMigrationManifestEntry.

Declaration

public static bool Equals(IMigrationManifestEntry entry, IMigrationManifestEntry? other)

Parameters

Type	Name	Description
IMigrationManifestEntry	entry
IMigrationManifestEntry	other

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()

MapToDestination(ContentLocation)

Sets the intended mapped destination location to the manifest entry. Clears the Destination information if the mapped location is different.

Declaration

public virtual IMigrationManifestEntryEditor MapToDestination(ContentLocation destinationLocation)

Parameters

Type	Name	Description
ContentLocation	destinationLocation	The intended destination location to migrate to.

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry editor, for fluent API usage.

ResetStatus()

Resets the status to Pending.

Declaration

public virtual IMigrationManifestEntryEditor ResetStatus()

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry editor, for fluent API usage.

SetCanceled()

Sets the entry to canceled status.

Declaration

public virtual IMigrationManifestEntryEditor SetCanceled()

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry editor, for fluent API usage.

SetFailed(params IEnumerable<Exception>)

Sets the entry to failed status and adding errors to the entry.

Declaration

public virtual IMigrationManifestEntryEditor SetFailed(params IEnumerable<Exception> errors)

Parameters

Type	Name	Description
IEnumerable<Exception>	errors	The errors to add to the entry.

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry editor, for fluent API usage.

SetMigrated()

Sets the entry to migrated status.

Declaration

public virtual IMigrationManifestEntryEditor SetMigrated()

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry editor, for fluent API usage.

SetSkipped(string?)

Sets the entry to skipped status.

Declaration

public virtual IMigrationManifestEntryEditor SetSkipped(string? skippedReason)

Parameters

Type	Name	Description
string	skippedReason	Reason this item was skipped. Generally the skipped filter name.

Returns

Type	Description
IMigrationManifestEntryEditor	The current entry editor, for fluent API usage.

Operators

operator ==(MigrationManifestEntry?, MigrationManifestEntry?)

Declaration

public static bool operator ==(MigrationManifestEntry? a, MigrationManifestEntry? b)

Parameters

Type	Name	Description
MigrationManifestEntry	a
MigrationManifestEntry	b

Returns

Type	Description
bool

operator !=(MigrationManifestEntry?, MigrationManifestEntry?)

Declaration

public static bool operator !=(MigrationManifestEntry? a, MigrationManifestEntry? b)

Parameters

Type	Name	Description
MigrationManifestEntry	a
MigrationManifestEntry	b

Returns

Type	Description
bool

Implements

IMigrationManifestEntryEditor

IMigrationManifestEntry

IEquatable<T>