JobSummary

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

Bases: object

A summary of the job.

Attributes:

DATABASE_SUB_TYPE_ACD

A constant which can be used with the database_sub_type property of a JobSummary.

DATABASE_SUB_TYPE_ADB

A constant which can be used with the database_sub_type property of a JobSummary.

DATABASE_SUB_TYPE_CDB

A constant which can be used with the database_sub_type property of a JobSummary.

DATABASE_SUB_TYPE_NON_CDB

A constant which can be used with the database_sub_type property of a JobSummary.

DATABASE_SUB_TYPE_PDB

A constant which can be used with the database_sub_type property of a JobSummary.

JOB_TYPE_SQL

A constant which can be used with the job_type property of a JobSummary.

compartment_id

[Required] Gets the compartment_id of this JobSummary.

database_sub_type

Gets the database_sub_type of this JobSummary.

defined_tags

Gets the defined_tags of this JobSummary.

description

Gets the description of this JobSummary.

freeform_tags

Gets the freeform_tags of this JobSummary.

id

[Required] Gets the id of this JobSummary.

job_type

[Required] Gets the job_type of this JobSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this JobSummary.

managed_database_group_id

Gets the managed_database_group_id of this JobSummary.

managed_database_id

Gets the managed_database_id of this JobSummary.

name

[Required] Gets the name of this JobSummary.

schedule_details

Gets the schedule_details of this JobSummary.

schedule_type

[Required] Gets the schedule_type of this JobSummary.

submission_error_message

Gets the submission_error_message of this JobSummary.

system_tags

Gets the system_tags of this JobSummary.

time_created

[Required] Gets the time_created of this JobSummary.

time_updated

[Required] Gets the time_updated of this JobSummary.

timeout

Gets the timeout of this JobSummary.

Methods:

__init__(**kwargs)

Initializes a new JobSummary object with values from keyword arguments.

DATABASE_SUB_TYPE_ACD = 'ACD'

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

DATABASE_SUB_TYPE_ADB = 'ADB'

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

DATABASE_SUB_TYPE_CDB = 'CDB'

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

DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'

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

DATABASE_SUB_TYPE_PDB = 'PDB'

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

JOB_TYPE_SQL = 'SQL'

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

__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.

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

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

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

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

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

  • database_sub_type (str) – The value to assign to the database_sub_type property of this JobSummary. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • schedule_details (oci.database_management.models.JobScheduleDetails) – The value to assign to the schedule_details property of this JobSummary.

  • job_type (str) – The value to assign to the job_type property of this JobSummary. Allowed values for this property are: “SQL”, ‘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 JobSummary.

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

  • submission_error_message (str) – The value to assign to the submission_error_message 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.

  • 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 compartment_id

[Required] Gets the compartment_id of this JobSummary. The OCID of the compartment in which the job resides.

Returns

The compartment_id of this JobSummary.

Return type

str

property database_sub_type

Gets the database_sub_type of this JobSummary. The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided.

Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The database_sub_type of this JobSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

Gets the description of this JobSummary. The description of the job.

Returns

The description 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 job.

Returns

The id of this JobSummary.

Return type

str

property job_type

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

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

Returns

The job_type of this JobSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this JobSummary. The lifecycle state of the job.

Returns

The lifecycle_state of this JobSummary.

Return type

str

property managed_database_group_id

Gets the managed_database_group_id of this JobSummary. The OCID of the Managed Database Group where the job has to be executed.

Returns

The managed_database_group_id of this JobSummary.

Return type

str

property managed_database_id

Gets the managed_database_id of this JobSummary. The OCID of the Managed Database where the job has to be executed.

Returns

The managed_database_id of this JobSummary.

Return type

str

property name

[Required] Gets the name of this JobSummary. The display name of the job.

Returns

The name of this JobSummary.

Return type

str

property schedule_details

Gets the schedule_details of this JobSummary.

Returns

The schedule_details of this JobSummary.

Return type

oci.database_management.models.JobScheduleDetails

property schedule_type

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

Returns

The schedule_type of this JobSummary.

Return type

str

property submission_error_message

Gets the submission_error_message of this JobSummary. The error message that is returned if the job submission fails. Null is returned in all other scenarios.

Returns

The submission_error_message of this JobSummary.

Return type

str

property system_tags

Gets the system_tags of this JobSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

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 date and time when the job was created.

Returns

The time_created of this JobSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this JobSummary. The date and time when the job was last updated.

Returns

The time_updated of this JobSummary.

Return type

datetime

property timeout

Gets the timeout of this JobSummary. The job timeout duration, which is expressed like “1h 10m 15s”.

Returns

The timeout of this JobSummary.

Return type

str