PyMigrationManifestEntryEditor

class PyMigrationManifestEntryEditor(migration_manifest_entry_editor)

Bases: PyMigrationManifestEntry

Interface for a IMigrationManifestEntry that can be edited.

  • Parameters: migration_manifest_entry_editor (IMigrationManifestEntryEditor)

__init__(migration_manifest_entry_editor)

Creates a new PyMigrationManifestEntryEditor object.

Args: : migration_manifest_entry_editor: A IMigrationManifestEntryEditor object.

Returns: None.

  • Parameters: migration_manifest_entry_editor (IMigrationManifestEntryEditor)
  • Return type: None

Methods

__init__(migration_manifest_entry_editor) Creates a new PyMigrationManifestEntryEditor object.
destination_found(destination_info) Sets the MappedLocation information based on the given destination item reference.
map_to_destination(destination_location) Sets the intended mapped destination location to the manifest entry.
reset_status() Resets the status to Pending.
set_canceled() Sets the entry to canceled status.
set_migrated() Sets the entry to migrated status.
set_skipped(skipped_reason) Sets the entry to skipped status.

Attributes

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.
errors Gets errors that occurred while migrating the content item.
has_migrated Gets whether or not the content item has been migrated, either in a previous run or the current run.
mapped_location Gets the content item's intended destination location, regardless if a Destination value's location if available.
skipped_reason Gets the reason why the content item was skipped, if applicable.
source Gets the content item's source information.
status Gets the migration status code of the content item for the current run.

reset_status()

Resets the status to Pending.

Returns: The current entry editor, for fluent API usage.

  • Return type: Self

map_to_destination(destination_location)

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

Args: : destination_location: The intended destination location to migrate to.

Returns: The current entry editor, for fluent API usage.

property destination : PyContentReference

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.

destination_found(destination_info)

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

Args: : destination_info: The destination reference information.

Returns: The current entry editor, for fluent API usage.

property errors : Sequence[Exception]

Gets errors that occurred while migrating the content item.

property has_migrated : bool

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

property mapped_location : PyContentLocation

Gets the content item’s intended destination location, regardless if a Destination value’s location if available.

property skipped_reason : str

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

property source : PyContentReference

Gets the content item’s source information.

property status : PyMigrationManifestEntryStatus

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

set_skipped(skipped_reason)

Sets the entry to skipped status.

Args: : skipped_reason: Reason this item was skipped. Generally the skipped filter name.

Returns: The current entry editor, for fluent API usage.

  • Parameters: skipped_reason (str)
  • Return type: Self

set_canceled()

Sets the entry to canceled status.

Returns: The current entry editor, for fluent API usage.

  • Return type: Self

set_migrated()

Sets the entry to migrated status.

Returns: The current entry editor, for fluent API usage.

  • Return type: Self