SyncJob¶

class oci.lustre_file_storage.models.SyncJob(**kwargs)¶

Bases: object

Details associated with sync job runs.

Attributes

`JOB_TYPE_EXPORT`	A constant which can be used with the job_type property of a SyncJob.
`JOB_TYPE_IMPORT`	A constant which can be used with the job_type property of a SyncJob.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a SyncJob.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a SyncJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SyncJob.
`LIFECYCLE_STATE_FAILING`	A constant which can be used with the lifecycle_state property of a SyncJob.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a SyncJob.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a SyncJob.
`bytes_transferred`	[Required] Gets the bytes_transferred of this SyncJob.
`defined_tags`	[Required] Gets the defined_tags of this SyncJob.
`freeform_tags`	[Required] Gets the freeform_tags of this SyncJob.
`id`	[Required] Gets the id of this SyncJob.
`is_overwrite`	[Required] Gets the is_overwrite of this SyncJob.
`job_type`	[Required] Gets the job_type of this SyncJob.
`lifecycle_details`	Gets the lifecycle_details of this SyncJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this SyncJob.
`lustre_file_system_path`	[Required] Gets the lustre_file_system_path of this SyncJob.
`object_storage_path`	[Required] Gets the object_storage_path of this SyncJob.
`objects_transferred`	[Required] Gets the objects_transferred of this SyncJob.
`parent_id`	Gets the parent_id of this SyncJob.
`skipped_error_count`	[Required] Gets the skipped_error_count of this SyncJob.
`system_tags`	[Required] Gets the system_tags of this SyncJob.
`time_finished`	Gets the time_finished of this SyncJob.
`time_started`	[Required] Gets the time_started of this SyncJob.
`total_objects_scanned`	[Required] Gets the total_objects_scanned of this SyncJob.

Methods

__init__(**kwargs) Initializes a new SyncJob object with values from keyword arguments.

JOB_TYPE_EXPORT = 'EXPORT'¶: A constant which can be used with the job_type property of a SyncJob. This constant has a value of “EXPORT”

JOB_TYPE_IMPORT = 'IMPORT'¶: A constant which can be used with the job_type property of a SyncJob. This constant has a value of “IMPORT”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a SyncJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a SyncJob. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a SyncJob. This constant has a value of “FAILED”

LIFECYCLE_STATE_FAILING = 'FAILING'¶: A constant which can be used with the lifecycle_state property of a SyncJob. This constant has a value of “FAILING”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a SyncJob. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a SyncJob. This constant has a value of “SUCCEEDED”

__init__(**kwargs)¶

Initializes a new SyncJob object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this SyncJob.
parent_id (str) – The value to assign to the parent_id property of this SyncJob.
job_type (str) – The value to assign to the job_type property of this SyncJob. Allowed values for this property are: “IMPORT”, “EXPORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SyncJob. Allowed values for this property are: “IN_PROGRESS”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “FAILED”, “FAILING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this SyncJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SyncJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SyncJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SyncJob.
is_overwrite (bool) – The value to assign to the is_overwrite property of this SyncJob.
total_objects_scanned (int) – The value to assign to the total_objects_scanned property of this SyncJob.
objects_transferred (int) – The value to assign to the objects_transferred property of this SyncJob.
bytes_transferred (int) – The value to assign to the bytes_transferred property of this SyncJob.
skipped_error_count (int) – The value to assign to the skipped_error_count property of this SyncJob.
time_started (datetime) – The value to assign to the time_started property of this SyncJob.
time_finished (datetime) – The value to assign to the time_finished property of this SyncJob.
lustre_file_system_path (str) – The value to assign to the lustre_file_system_path property of this SyncJob.
object_storage_path (str) – The value to assign to the object_storage_path property of this SyncJob.

bytes_transferred¶

[Required] Gets the bytes_transferred of this SyncJob. Bytes transferred during the sync. This value changes while the sync is still in progress.

Returns:	The bytes_transferred of this SyncJob.
Return type:	int

defined_tags¶

[Required] Gets the defined_tags of this SyncJob. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this SyncJob.
Return type:	dict(str, dict(str, object))

freeform_tags¶

[Required] Gets the freeform_tags of this SyncJob. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this SyncJob.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this SyncJob. The OCID of the sync job.

Returns:	The id of this SyncJob.
Return type:	str

is_overwrite¶

[Required] Gets the is_overwrite of this SyncJob. The flag is an identifier to tell whether this specific job run has overwrite enabled. If isOverwrite is false, the file to be imported or exported will be skipped if it already exists. If isOverwrite is true, the file to be imported or exported will be overwritten if it already exists.

Returns:	The is_overwrite of this SyncJob.
Return type:	bool

job_type¶

[Required] Gets the job_type of this SyncJob. The type of the sync job.

Allowed values for this property are: “IMPORT”, “EXPORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The job_type of this SyncJob.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this SyncJob. A message that describes the current state of the sync job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this SyncJob.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this SyncJob. The current state of the sync job.

Allowed values for this property are: “IN_PROGRESS”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “FAILED”, “FAILING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this SyncJob.
Return type:	str

lustre_file_system_path¶

[Required] Gets the lustre_file_system_path of this SyncJob. The path in the Lustre file system used for this Object Storage link.

Example: myFileSystem/mount/myDirectory

Returns:	The lustre_file_system_path of this SyncJob.
Return type:	str

object_storage_path¶

[Required] Gets the object_storage_path of this SyncJob. The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports.

Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix

Returns:	The object_storage_path of this SyncJob.
Return type:	str

objects_transferred¶

[Required] Gets the objects_transferred of this SyncJob. Count of total files that transferred successfully.

Returns:	The objects_transferred of this SyncJob.
Return type:	int

parent_id¶

Gets the parent_id of this SyncJob. The OCID of the Object Storage link.

Returns:	The parent_id of this SyncJob.
Return type:	str

skipped_error_count¶

[Required] Gets the skipped_error_count of this SyncJob. Count of files or objects that failed to export or import due to errors.

Returns:	The skipped_error_count of this SyncJob.
Return type:	int

system_tags¶

[Required] Gets the system_tags of this SyncJob. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this SyncJob.
Return type:	dict(str, dict(str, object))

time_finished¶

Gets the time_finished of this SyncJob. The date and time the job finished, expressed in RFC 3339 timestamp format.

Example: 2020-07-25T21:10:29.600Z

Returns:	The time_finished of this SyncJob.
Return type:	datetime

time_started¶

[Required] Gets the time_started of this SyncJob. The date and time the job was started, expressed in RFC 3339 timestamp format.

Example: 2020-07-25T21:10:29.600Z

Returns:	The time_started of this SyncJob.
Return type:	datetime

total_objects_scanned¶

[Required] Gets the total_objects_scanned of this SyncJob. Total object count for scanned files for import or export as part of this sync job.

Returns:	The total_objects_scanned of this SyncJob.
Return type:	int