MigrationJob#

class MigrationJob(sub_plan_ext_id=None, iteration_number=None, start_time=None, end_time=None, number_of_files_scanned=0, number_of_files_skipped=0, number_of_files_transferred=0, number_of_files_failed=0, number_of_directories_transferred=0, number_of_directories_failed=0, number_of_streams_transferred=0, number_of_streams_failed=0, number_of_streams_deleted=0, number_of_files_deleted=0, number_of_directories_deleted=0, total_data_skipped_bytes=0, total_data_transferred_bytes=0, total_metadata_transferred_bytes=0, average_data_throughput_bps=0, average_entities_throughput=0, average_files_scanned_per_second=0, overall_status=None, sub_jobs_status=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

Migration plan job details.

Parameters:

  • sub_plan_ext_id – (sub_plan_ext_id) The extId of migration sub-plan.

  • iteration_number – (iteration_number) The iteration number for the migration sub-plan.

  • start_time – (start_time) Start time for the migration sub-plan.

  • end_time – (end_time) End time for the migration sub-plan.

  • number_of_files_scanned – (number_of_files_scanned) The number of migration sub-plan files scanned. (Default 0)

  • number_of_files_skipped – (number_of_files_skipped) The number of migration sub-plan files skipped. (Default 0)

  • number_of_files_transferred – (number_of_files_transferred) The number of the transferred files for the migration sub-plan. (Default 0)

  • number_of_files_failed – (number_of_files_failed) The number of transferred failed files for the migration sub-plan. (Default 0)

  • number_of_directories_transferred – (number_of_directories_transferred) The number of the transferred directories for the migration sub-plan. (Default 0)

  • number_of_directories_failed – (number_of_directories_failed) The number of the transferred failed directories for the migration sub-plan. (Default 0)

  • number_of_streams_transferred – (number_of_streams_transferred) The number of migration sub-plan streams transferred. (Default 0)

  • number_of_streams_failed – (number_of_streams_failed) The number of migration sub-plan failed streams. (Default 0)

  • number_of_streams_deleted – (number_of_streams_deleted) The number of migration sub-plan deleted streams. (Default 0)

  • number_of_files_deleted – (number_of_files_deleted) The number of migration sub-plan deleted files. (Default 0)

  • number_of_directories_deleted – (number_of_directories_deleted) The number of migration sub-plan deleted directories. (Default 0)

  • total_data_skipped_bytes – (total_data_skipped_bytes) The skipped bytes for the migration sub-plan. (Default 0)

  • total_data_transferred_bytes – (total_data_transferred_bytes) The transferred bytes for the migration sub-plan. (Default 0)

  • total_metadata_transferred_bytes – (total_metadata_transferred_bytes) The number of migration sub-plan bytes metadata transferred. (Default 0)

  • average_data_throughput_bps – (average_data_throughput_bps) The average data throughput for the migration sub-plan in bytes/sec. (Default 0)

  • average_entities_throughput – (average_entities_throughput) The average entities throughput for migration sub-plan in entities/sec. (Default 0)

  • average_files_scanned_per_second – (average_files_scanned_per_second) The average average file scan rate for migration sub-plan in files/sec. (Default 0)

  • overall_status – (overall_status)

  • sub_jobs_status – (sub_jobs_status) List of sub-job status. When a migration leader’s job moves to running state, it creates node jobs on each node of the file server, and the status of the node job can be different than the leader job, for example: one node job can be queued, but another node job can be in a running state, but to maintain consistency, we cannot change the status of the leader job based on node jobs.

property average_data_throughput_bps#

The average data throughput for the migration sub-plan in bytes/sec.

Type:

float

property average_entities_throughput#

The average entities throughput for migration sub-plan in entities/sec.

Type:

int

property average_files_scanned_per_second#

The average average file scan rate for migration sub-plan in files/sec.

Type:

int

property end_time#

End time for the migration sub-plan.

Type:

datetime

property iteration_number#

The iteration number for the migration sub-plan.

Type:

int

property number_of_directories_deleted#

The number of migration sub-plan deleted directories.

Type:

int

property number_of_directories_failed#

The number of the transferred failed directories for the migration sub-plan.

Type:

int

property number_of_directories_transferred#

The number of the transferred directories for the migration sub-plan.

Type:

int

property number_of_files_deleted#

The number of migration sub-plan deleted files.

Type:

int

property number_of_files_failed#

The number of transferred failed files for the migration sub-plan.

Type:

int

property number_of_files_scanned#

The number of migration sub-plan files scanned.

Type:

int

property number_of_files_skipped#

The number of migration sub-plan files skipped.

Type:

int

property number_of_files_transferred#

The number of the transferred files for the migration sub-plan.

Type:

int

property number_of_streams_deleted#

The number of migration sub-plan deleted streams.

Type:

int

property number_of_streams_failed#

The number of migration sub-plan failed streams.

Type:

int

property number_of_streams_transferred#

The number of migration sub-plan streams transferred.

Type:

int

property overall_status#
Type:

MigrationStatusInfo

property start_time#

Start time for the migration sub-plan.

Type:

datetime

property sub_jobs_status#

List of sub-job status. When a migration leader’s job moves to running state, it creates node jobs on each node of the file server, and the status of the node job can be different than the leader job, for example: one node job can be queued, but another node job can be in a running state, but to maintain consistency, we cannot change the status of the leader job based on node jobs.

Type:

list[ MigrationStatusInfo ]

property sub_plan_ext_id#

The extId of migration sub-plan.

Type:

str

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property total_data_skipped_bytes#

The skipped bytes for the migration sub-plan.

Type:

int

property total_data_transferred_bytes#

The transferred bytes for the migration sub-plan.

Type:

int

property total_metadata_transferred_bytes#

The number of migration sub-plan bytes metadata transferred.

Type:

int