JobSummary

class oci.database_migration.models.JobSummary(**kwargs)

Bases: object

Job description

Attributes:

LIFECYCLE_STATE_ACCEPTED	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_CANCELED	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_CANCELING	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_FAILED	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_IN_PROGRESS	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_SUCCEEDED	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_TERMINATED	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_UNKNOWN	A constant which can be used with the lifecycle_state property of a JobSummary.
LIFECYCLE_STATE_WAITING	A constant which can be used with the lifecycle_state property of a JobSummary.
TYPE_EVALUATION	A constant which can be used with the type property of a JobSummary.
TYPE_MIGRATION	A constant which can be used with the type property of a JobSummary.
defined_tags	Gets the defined_tags of this JobSummary.
display_name	[Required] Gets the display_name of this JobSummary.
freeform_tags	Gets the freeform_tags of this JobSummary.
id	[Required] Gets the id of this JobSummary.
lifecycle_details	Gets the lifecycle_details of this JobSummary.
lifecycle_state	[Required] Gets the lifecycle_state of this JobSummary.
migration_id	[Required] Gets the migration_id of this JobSummary.
progress	Gets the progress of this JobSummary.
system_tags	Gets the system_tags of this JobSummary.
time_created	[Required] Gets the time_created of this JobSummary.
time_updated	Gets the time_updated of this JobSummary.
type	[Required] Gets the type of this JobSummary.

Methods:

__init__(**kwargs)

Initializes a new JobSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the lifecycle_state property of a JobSummary. 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 JobSummary. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_UNKNOWN = 'UNKNOWN'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “UNKNOWN”

LIFECYCLE_STATE_WAITING = 'WAITING'

A constant which can be used with the lifecycle_state property of a JobSummary. This constant has a value of “WAITING”

TYPE_EVALUATION = 'EVALUATION'

A constant which can be used with the type property of a JobSummary. This constant has a value of “EVALUATION”

TYPE_MIGRATION = 'MIGRATION'

A constant which can be used with the type property of a JobSummary. This constant has a value of “MIGRATION”

__init__(**kwargs)

Initializes a new JobSummary 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 JobSummary.

• display_name (str) – The value to assign to the display_name property of this JobSummary.

• migration_id (str) – The value to assign to the migration_id property of this JobSummary.

• type (str) – The value to assign to the type property of this JobSummary. Allowed values for this property are: “EVALUATION”, “MIGRATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• progress (oci.database_migration.models.MigrationJobProgressSummary) – The value to assign to the progress property of this JobSummary.

• time_created (datetime) – The value to assign to the time_created property of this JobSummary.

• time_updated (datetime) – The value to assign to the time_updated property of this JobSummary.

• lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “UNKNOWN”, “TERMINATED”, “FAILED”, “SUCCEEDED”, “WAITING”, “CANCELING”, “CANCELED”, ‘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 JobSummary.

• freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this JobSummary.

• defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this JobSummary.

• system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this JobSummary.

property defined_tags

Gets the defined_tags of this JobSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this JobSummary.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this JobSummary. Name of the job.

Returns

The display_name of this JobSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this JobSummary. 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 JobSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this JobSummary. The OCID of the Migration Job.

Returns

The id of this JobSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this JobSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns

The lifecycle_details of this JobSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this JobSummary. The current state of the migration Deployment.

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

Returns

The lifecycle_state of this JobSummary.

Return type

str

property migration_id

[Required] Gets the migration_id of this JobSummary. The OCID of the Migration that this job belongs to.

Returns

The migration_id of this JobSummary.

Return type

str

property progress

Gets the progress of this JobSummary.

Returns

The progress of this JobSummary.

Return type

oci.database_migration.models.MigrationJobProgressSummary

property system_tags

Gets the system_tags of this JobSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this JobSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this JobSummary. The time the Migration Job was created. An RFC3339 formatted datetime string

Returns

The time_created of this JobSummary.

Return type

datetime

property time_updated

Gets the time_updated of this JobSummary. The time the Migration Job was last updated. An RFC3339 formatted datetime string

Returns

The time_updated of this JobSummary.

Return type

datetime

property type

[Required] Gets the type of this JobSummary. The job type.

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

Returns

The type of this JobSummary.

Return type

str