MigrationSubPlan#

class MigrationSubPlan(name=None, source_path=None, target_path=None, target_mount_target_ext_id=None, is_sync_type_mirror=False, status=None, status_msg=None, is_final_iteration=False, should_allow_unknown_sids=True, should_ignore_long_tld_names=True, should_ignore_files_at_root=True, should_retry_only_failed_files=False, protocol=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

Migration sub-plan details.

Parameters:

  • name (required min=1 chars, max=30 chars) – (name) Migration sub-plan name

  • source_path (required min=1 chars, max=4096 chars) – (source_path) Source path

  • target_path (max=4096 chars) – (target_path) Target path

  • target_mount_target_ext_id (required) – (target_mount_target_ext_id) Target mount-target extId.

  • is_sync_type_mirror – (is_sync_type_mirror) Indicates the flag for sync type. If false, then only the source will be synced. The delete and rename are not honored on the target, if anything is deleted or renamed on the source. If true, then the source will be mirrored on the target, that is, every delete and rename will be honored. (Default False)

  • status – (status)

  • status_msg (max=4096 chars) – (status_msg) Indicates the status message of the migration sub-plan. It updates after each migration step, informing the current migration sub-plan stage. This is a read-only field.

  • is_final_iteration – (is_final_iteration) A flag to identify if its final iteration. This flag should be given as true to do the final round of migration. It is recommended to keep the sub-plan source as readonly to migrate all the content from the source to the target. We prioritize such an iteration so that the read-only time for the source can be decreased by utilising migrator resources only for the subplans in final iteration. After the completion of this iteration, if no failed files are found, we need to update the sub-plan status as COMPLETED, and no further action on this sub-plan will be allowed. If there are failed files under max-limit while migration, the subplan status will be changed to succeded and you will have numberOfFilesFailed/numberOfDirectoriesFailed/numberOfStreamsFailed on migration job. These failed files name and error can be retrieved using GET failed-files-summary API, and upon error correction, the user can start another iteration to sync failed files only the flag shouldRetryOnlyFailedFiles flag. (Default False)

  • should_allow_unknown_sids – (should_allow_unknown_sids) A flag to indicate whether unknown SIDs should be allowed during migration instead of failing it. (Default True)

  • should_ignore_long_tld_names – (should_ignore_long_tld_names) A flag to indicate whether long TLD name should be ignored while migration instead of failing it. (Default True)

  • should_ignore_files_at_root – (should_ignore_files_at_root) A flag to indicate whether files at root should be ignored while migration instead of failing it. (Default True)

  • should_retry_only_failed_files – (should_retry_only_failed_files) A flag to indicate whether the migration iteration is only to migrate failed files/directories from the last iteration. If it is false and status is changed to running from default, then the migration will start for the whole source mount target. If it is true, then only a list of failed files from the last iteration are retried for migration. (Default False)

  • protocol – (protocol)

property is_final_iteration#

A flag to identify if its final iteration. This flag should be given as true to do the final round of migration. It is recommended to keep the sub-plan source as readonly to migrate all the content from the source to the target. We prioritize such an iteration so that the read-only time for the source can be decreased by utilising migrator resources only for the subplans in final iteration. After the completion of this iteration, if no failed files are found, we need to update the sub-plan status as COMPLETED, and no further action on this sub-plan will be allowed. If there are failed files under max-limit while migration, the subplan status will be changed to succeded and you will have numberOfFilesFailed/numberOfDirectoriesFailed/numberOfStreamsFailed on migration job. These failed files name and error can be retrieved using GET failed-files-summary API, and upon error correction, the user can start another iteration to sync failed files only the flag shouldRetryOnlyFailedFiles flag.

Type:

bool

property is_sync_type_mirror#

Indicates the flag for sync type. If false, then only the source will be synced. The delete and rename are not honored on the target, if anything is deleted or renamed on the source. If true, then the source will be mirrored on the target, that is, every delete and rename will be honored.

Type:

bool

property name#

Migration sub-plan name

Type:

str

property protocol#
Type:

MountTargetProtocolType

property should_allow_unknown_sids#

A flag to indicate whether unknown SIDs should be allowed during migration instead of failing it.

Type:

bool

property should_ignore_files_at_root#

A flag to indicate whether files at root should be ignored while migration instead of failing it.

Type:

bool

property should_ignore_long_tld_names#

A flag to indicate whether long TLD name should be ignored while migration instead of failing it.

Type:

bool

property should_retry_only_failed_files#

A flag to indicate whether the migration iteration is only to migrate failed files/directories from the last iteration. If it is false and status is changed to running from default, then the migration will start for the whole source mount target. If it is true, then only a list of failed files from the last iteration are retried for migration.

Type:

bool

property source_path#

Source path

Type:

str

property status#
Type:

MigrationStatus

property status_msg#

Indicates the status message of the migration sub-plan. It updates after each migration step, informing the current migration sub-plan stage. This is a read-only field.

Type:

str

property target_mount_target_ext_id#

Target mount-target extId.

Type:

str

property target_path#

Target path

Type:

str

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model