File: //lib/mysqlsh/lib/python3.8/site-packages/oci/database_management/models/job_summary.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20201101
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class JobSummary(object):
"""
A summary of the job.
"""
#: 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_CDB = "CDB"
#: A constant which can be used with the database_sub_type property of a JobSummary.
#: This constant has a value of "PDB"
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 "NON_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 "ACD"
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 "ADB"
DATABASE_SUB_TYPE_ADB = "ADB"
#: A constant which can be used with the job_type property of a JobSummary.
#: This constant has a value of "SQL"
JOB_TYPE_SQL = "SQL"
def __init__(self, **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):
:param id:
The value to assign to the id property of this JobSummary.
:type id: str
:param compartment_id:
The value to assign to the compartment_id property of this JobSummary.
:type compartment_id: str
:param name:
The value to assign to the name property of this JobSummary.
:type name: str
:param description:
The value to assign to the description property of this JobSummary.
:type description: str
:param managed_database_group_id:
The value to assign to the managed_database_group_id property of this JobSummary.
:type managed_database_group_id: str
:param managed_database_id:
The value to assign to the managed_database_id property of this JobSummary.
:type managed_database_id: str
:param database_sub_type:
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'.
:type database_sub_type: str
:param schedule_type:
The value to assign to the schedule_type property of this JobSummary.
:type schedule_type: str
:param schedule_details:
The value to assign to the schedule_details property of this JobSummary.
:type schedule_details: oci.database_management.models.JobScheduleDetails
:param job_type:
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'.
:type job_type: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this JobSummary.
:type lifecycle_state: str
:param timeout:
The value to assign to the timeout property of this JobSummary.
:type timeout: str
:param submission_error_message:
The value to assign to the submission_error_message property of this JobSummary.
:type submission_error_message: str
:param time_created:
The value to assign to the time_created property of this JobSummary.
:type time_created: datetime
:param time_updated:
The value to assign to the time_updated property of this JobSummary.
:type time_updated: datetime
:param freeform_tags:
The value to assign to the freeform_tags property of this JobSummary.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this JobSummary.
:type defined_tags: dict(str, dict(str, object))
:param system_tags:
The value to assign to the system_tags property of this JobSummary.
:type system_tags: dict(str, dict(str, object))
"""
self.swagger_types = {
'id': 'str',
'compartment_id': 'str',
'name': 'str',
'description': 'str',
'managed_database_group_id': 'str',
'managed_database_id': 'str',
'database_sub_type': 'str',
'schedule_type': 'str',
'schedule_details': 'JobScheduleDetails',
'job_type': 'str',
'lifecycle_state': 'str',
'timeout': 'str',
'submission_error_message': 'str',
'time_created': 'datetime',
'time_updated': 'datetime',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'system_tags': 'dict(str, dict(str, object))'
}
self.attribute_map = {
'id': 'id',
'compartment_id': 'compartmentId',
'name': 'name',
'description': 'description',
'managed_database_group_id': 'managedDatabaseGroupId',
'managed_database_id': 'managedDatabaseId',
'database_sub_type': 'databaseSubType',
'schedule_type': 'scheduleType',
'schedule_details': 'scheduleDetails',
'job_type': 'jobType',
'lifecycle_state': 'lifecycleState',
'timeout': 'timeout',
'submission_error_message': 'submissionErrorMessage',
'time_created': 'timeCreated',
'time_updated': 'timeUpdated',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'system_tags': 'systemTags'
}
self._id = None
self._compartment_id = None
self._name = None
self._description = None
self._managed_database_group_id = None
self._managed_database_id = None
self._database_sub_type = None
self._schedule_type = None
self._schedule_details = None
self._job_type = None
self._lifecycle_state = None
self._timeout = None
self._submission_error_message = None
self._time_created = None
self._time_updated = None
self._freeform_tags = None
self._defined_tags = None
self._system_tags = None
@property
def id(self):
"""
**[Required]** Gets the id of this JobSummary.
The `OCID`__ of the job.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The id of this JobSummary.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this JobSummary.
The `OCID`__ of the job.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param id: The id of this JobSummary.
:type: str
"""
self._id = id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this JobSummary.
The `OCID`__ of the compartment in which the job resides.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this JobSummary.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this JobSummary.
The `OCID`__ of the compartment in which the job resides.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this JobSummary.
:type: str
"""
self._compartment_id = compartment_id
@property
def name(self):
"""
**[Required]** Gets the name of this JobSummary.
The display name of the job.
:return: The name of this JobSummary.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets the name of this JobSummary.
The display name of the job.
:param name: The name of this JobSummary.
:type: str
"""
self._name = name
@property
def description(self):
"""
Gets the description of this JobSummary.
The description of the job.
:return: The description of this JobSummary.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this JobSummary.
The description of the job.
:param description: The description of this JobSummary.
:type: str
"""
self._description = description
@property
def managed_database_group_id(self):
"""
Gets the managed_database_group_id of this JobSummary.
The `OCID`__ of the Managed Database Group where the job has to be executed.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The managed_database_group_id of this JobSummary.
:rtype: str
"""
return self._managed_database_group_id
@managed_database_group_id.setter
def managed_database_group_id(self, managed_database_group_id):
"""
Sets the managed_database_group_id of this JobSummary.
The `OCID`__ of the Managed Database Group where the job has to be executed.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param managed_database_group_id: The managed_database_group_id of this JobSummary.
:type: str
"""
self._managed_database_group_id = managed_database_group_id
@property
def managed_database_id(self):
"""
Gets the managed_database_id of this JobSummary.
The `OCID`__ of the Managed Database where the job has to be executed.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The managed_database_id of this JobSummary.
:rtype: str
"""
return self._managed_database_id
@managed_database_id.setter
def managed_database_id(self, managed_database_id):
"""
Sets the managed_database_id of this JobSummary.
The `OCID`__ of the Managed Database where the job has to be executed.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param managed_database_id: The managed_database_id of this JobSummary.
:type: str
"""
self._managed_database_id = managed_database_id
@property
def database_sub_type(self):
"""
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'.
:return: The database_sub_type of this JobSummary.
:rtype: str
"""
return self._database_sub_type
@database_sub_type.setter
def database_sub_type(self, database_sub_type):
"""
Sets 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.
:param database_sub_type: The database_sub_type of this JobSummary.
:type: str
"""
allowed_values = ["CDB", "PDB", "NON_CDB", "ACD", "ADB"]
if not value_allowed_none_or_none_sentinel(database_sub_type, allowed_values):
database_sub_type = 'UNKNOWN_ENUM_VALUE'
self._database_sub_type = database_sub_type
@property
def schedule_type(self):
"""
**[Required]** Gets the schedule_type of this JobSummary.
The schedule type of the job.
:return: The schedule_type of this JobSummary.
:rtype: str
"""
return self._schedule_type
@schedule_type.setter
def schedule_type(self, schedule_type):
"""
Sets the schedule_type of this JobSummary.
The schedule type of the job.
:param schedule_type: The schedule_type of this JobSummary.
:type: str
"""
self._schedule_type = schedule_type
@property
def schedule_details(self):
"""
Gets the schedule_details of this JobSummary.
:return: The schedule_details of this JobSummary.
:rtype: oci.database_management.models.JobScheduleDetails
"""
return self._schedule_details
@schedule_details.setter
def schedule_details(self, schedule_details):
"""
Sets the schedule_details of this JobSummary.
:param schedule_details: The schedule_details of this JobSummary.
:type: oci.database_management.models.JobScheduleDetails
"""
self._schedule_details = schedule_details
@property
def job_type(self):
"""
**[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'.
:return: The job_type of this JobSummary.
:rtype: str
"""
return self._job_type
@job_type.setter
def job_type(self, job_type):
"""
Sets the job_type of this JobSummary.
The type of job.
:param job_type: The job_type of this JobSummary.
:type: str
"""
allowed_values = ["SQL"]
if not value_allowed_none_or_none_sentinel(job_type, allowed_values):
job_type = 'UNKNOWN_ENUM_VALUE'
self._job_type = job_type
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this JobSummary.
The lifecycle state of the job.
:return: The lifecycle_state of this JobSummary.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this JobSummary.
The lifecycle state of the job.
:param lifecycle_state: The lifecycle_state of this JobSummary.
:type: str
"""
self._lifecycle_state = lifecycle_state
@property
def timeout(self):
"""
Gets the timeout of this JobSummary.
The job timeout duration, which is expressed like \"1h 10m 15s\".
:return: The timeout of this JobSummary.
:rtype: str
"""
return self._timeout
@timeout.setter
def timeout(self, timeout):
"""
Sets the timeout of this JobSummary.
The job timeout duration, which is expressed like \"1h 10m 15s\".
:param timeout: The timeout of this JobSummary.
:type: str
"""
self._timeout = timeout
@property
def submission_error_message(self):
"""
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.
:return: The submission_error_message of this JobSummary.
:rtype: str
"""
return self._submission_error_message
@submission_error_message.setter
def submission_error_message(self, submission_error_message):
"""
Sets 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.
:param submission_error_message: The submission_error_message of this JobSummary.
:type: str
"""
self._submission_error_message = submission_error_message
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this JobSummary.
The date and time when the job was created.
:return: The time_created of this JobSummary.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this JobSummary.
The date and time when the job was created.
:param time_created: The time_created of this JobSummary.
:type: datetime
"""
self._time_created = time_created
@property
def time_updated(self):
"""
**[Required]** Gets the time_updated of this JobSummary.
The date and time when the job was last updated.
:return: The time_updated of this JobSummary.
:rtype: datetime
"""
return self._time_updated
@time_updated.setter
def time_updated(self, time_updated):
"""
Sets the time_updated of this JobSummary.
The date and time when the job was last updated.
:param time_updated: The time_updated of this JobSummary.
:type: datetime
"""
self._time_updated = time_updated
@property
def freeform_tags(self):
"""
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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this JobSummary.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets 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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this JobSummary.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
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\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this JobSummary.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets 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\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this JobSummary.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def system_tags(self):
"""
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\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The system_tags of this JobSummary.
:rtype: dict(str, dict(str, object))
"""
return self._system_tags
@system_tags.setter
def system_tags(self, system_tags):
"""
Sets 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\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param system_tags: The system_tags of this JobSummary.
:type: dict(str, dict(str, object))
"""
self._system_tags = system_tags
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other