Class: OCI::DatabaseManagement::Models::JobSummary
- Inherits:
-
Object
- Object
- OCI::DatabaseManagement::Models::JobSummary
- Defined in:
- lib/oci/database_management/models/job_summary.rb
Overview
A summary of the job.
Constant Summary collapse
- DATABASE_SUB_TYPE_ENUM =
[ DATABASE_SUB_TYPE_CDB = 'CDB'.freeze, DATABASE_SUB_TYPE_PDB = 'PDB'.freeze, DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'.freeze, DATABASE_SUB_TYPE_ACD = 'ACD'.freeze, DATABASE_SUB_TYPE_ADB = 'ADB'.freeze, DATABASE_SUB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- JOB_TYPE_ENUM =
[ JOB_TYPE_SQL = 'SQL'.freeze, JOB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment in which the job resides.
-
#database_sub_type ⇒ String
The subtype of the Oracle Database where the job has to be executed.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the job.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the job.
-
#job_type ⇒ String
[Required] The type of job.
-
#lifecycle_state ⇒ String
[Required] The lifecycle state of the job.
-
#managed_database_group_id ⇒ String
The OCID of the Managed Database Group where the job has to be executed.
-
#managed_database_id ⇒ String
The OCID of the Managed Database where the job has to be executed.
-
#name ⇒ String
[Required] The display name of the job.
- #schedule_details ⇒ OCI::DatabaseManagement::Models::JobScheduleDetails
-
#schedule_type ⇒ String
[Required] The schedule type of the job.
-
#submission_error_message ⇒ String
The error message that is returned if the job submission fails.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time when the job was created.
-
#time_updated ⇒ DateTime
[Required] The date and time when the job was last updated.
-
#timeout ⇒ String
The job timeout duration, which is expressed like "1h 10m 15s".
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ JobSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ JobSummary
Initializes the object
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/oci/database_management/models/job_summary.rb', line 184 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.id = attributes[:'id'] if attributes[:'id'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self.managed_database_group_id = attributes[:'managedDatabaseGroupId'] if attributes[:'managedDatabaseGroupId'] raise 'You cannot provide both :managedDatabaseGroupId and :managed_database_group_id' if attributes.key?(:'managedDatabaseGroupId') && attributes.key?(:'managed_database_group_id') self.managed_database_group_id = attributes[:'managed_database_group_id'] if attributes[:'managed_database_group_id'] self.managed_database_id = attributes[:'managedDatabaseId'] if attributes[:'managedDatabaseId'] raise 'You cannot provide both :managedDatabaseId and :managed_database_id' if attributes.key?(:'managedDatabaseId') && attributes.key?(:'managed_database_id') self.managed_database_id = attributes[:'managed_database_id'] if attributes[:'managed_database_id'] self.database_sub_type = attributes[:'databaseSubType'] if attributes[:'databaseSubType'] raise 'You cannot provide both :databaseSubType and :database_sub_type' if attributes.key?(:'databaseSubType') && attributes.key?(:'database_sub_type') self.database_sub_type = attributes[:'database_sub_type'] if attributes[:'database_sub_type'] self.schedule_type = attributes[:'scheduleType'] if attributes[:'scheduleType'] raise 'You cannot provide both :scheduleType and :schedule_type' if attributes.key?(:'scheduleType') && attributes.key?(:'schedule_type') self.schedule_type = attributes[:'schedule_type'] if attributes[:'schedule_type'] self.schedule_details = attributes[:'scheduleDetails'] if attributes[:'scheduleDetails'] raise 'You cannot provide both :scheduleDetails and :schedule_details' if attributes.key?(:'scheduleDetails') && attributes.key?(:'schedule_details') self.schedule_details = attributes[:'schedule_details'] if attributes[:'schedule_details'] self.job_type = attributes[:'jobType'] if attributes[:'jobType'] raise 'You cannot provide both :jobType and :job_type' if attributes.key?(:'jobType') && attributes.key?(:'job_type') self.job_type = attributes[:'job_type'] if attributes[:'job_type'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.timeout = attributes[:'timeout'] if attributes[:'timeout'] self. = attributes[:'submissionErrorMessage'] if attributes[:'submissionErrorMessage'] raise 'You cannot provide both :submissionErrorMessage and :submission_error_message' if attributes.key?(:'submissionErrorMessage') && attributes.key?(:'submission_error_message') self. = attributes[:'submission_error_message'] if attributes[:'submission_error_message'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment in which the job resides.
32 33 34 |
# File 'lib/oci/database_management/models/job_summary.rb', line 32 def compartment_id @compartment_id end |
#database_sub_type ⇒ String
The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided.
52 53 54 |
# File 'lib/oci/database_management/models/job_summary.rb', line 52 def database_sub_type @database_sub_type end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
97 98 99 |
# File 'lib/oci/database_management/models/job_summary.rb', line 97 def @defined_tags end |
#description ⇒ String
The description of the job.
40 41 42 |
# File 'lib/oci/database_management/models/job_summary.rb', line 40 def description @description end |
#freeform_tags ⇒ Hash<String, String>
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\"}
90 91 92 |
# File 'lib/oci/database_management/models/job_summary.rb', line 90 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the job.
28 29 30 |
# File 'lib/oci/database_management/models/job_summary.rb', line 28 def id @id end |
#job_type ⇒ String
[Required] The type of job.
63 64 65 |
# File 'lib/oci/database_management/models/job_summary.rb', line 63 def job_type @job_type end |
#lifecycle_state ⇒ String
[Required] The lifecycle state of the job.
67 68 69 |
# File 'lib/oci/database_management/models/job_summary.rb', line 67 def lifecycle_state @lifecycle_state end |
#managed_database_group_id ⇒ String
The OCID of the Managed Database Group where the job has to be executed.
44 45 46 |
# File 'lib/oci/database_management/models/job_summary.rb', line 44 def managed_database_group_id @managed_database_group_id end |
#managed_database_id ⇒ String
The OCID of the Managed Database where the job has to be executed.
48 49 50 |
# File 'lib/oci/database_management/models/job_summary.rb', line 48 def managed_database_id @managed_database_id end |
#name ⇒ String
[Required] The display name of the job.
36 37 38 |
# File 'lib/oci/database_management/models/job_summary.rb', line 36 def name @name end |
#schedule_details ⇒ OCI::DatabaseManagement::Models::JobScheduleDetails
59 60 61 |
# File 'lib/oci/database_management/models/job_summary.rb', line 59 def schedule_details @schedule_details end |
#schedule_type ⇒ String
[Required] The schedule type of the job.
56 57 58 |
# File 'lib/oci/database_management/models/job_summary.rb', line 56 def schedule_type @schedule_type end |
#submission_error_message ⇒ String
The error message that is returned if the job submission fails. Null is returned in all other scenarios.
75 76 77 |
# File 'lib/oci/database_management/models/job_summary.rb', line 75 def @submission_error_message end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
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\"}}
106 107 108 |
# File 'lib/oci/database_management/models/job_summary.rb', line 106 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time when the job was created.
79 80 81 |
# File 'lib/oci/database_management/models/job_summary.rb', line 79 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The date and time when the job was last updated.
83 84 85 |
# File 'lib/oci/database_management/models/job_summary.rb', line 83 def time_updated @time_updated end |
#timeout ⇒ String
The job timeout duration, which is expressed like "1h 10m 15s".
71 72 73 |
# File 'lib/oci/database_management/models/job_summary.rb', line 71 def timeout @timeout end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/oci/database_management/models/job_summary.rb', line 109 def self.attribute_map { # rubocop:disable Style/SymbolLiteral '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' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/oci/database_management/models/job_summary.rb', line 135 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'name': :'String', 'description': :'String', 'managed_database_group_id': :'String', 'managed_database_id': :'String', 'database_sub_type': :'String', 'schedule_type': :'String', 'schedule_details': :'OCI::DatabaseManagement::Models::JobScheduleDetails', 'job_type': :'String', 'lifecycle_state': :'String', 'timeout': :'String', 'submission_error_message': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/oci/database_management/models/job_summary.rb', line 316 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && name == other.name && description == other.description && managed_database_group_id == other.managed_database_group_id && managed_database_id == other.managed_database_id && database_sub_type == other.database_sub_type && schedule_type == other.schedule_type && schedule_details == other.schedule_details && job_type == other.job_type && lifecycle_state == other.lifecycle_state && timeout == other.timeout && == other. && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/oci/database_management/models/job_summary.rb', line 363 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
343 344 345 |
# File 'lib/oci/database_management/models/job_summary.rb', line 343 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
352 353 354 |
# File 'lib/oci/database_management/models/job_summary.rb', line 352 def hash [id, compartment_id, name, description, managed_database_group_id, managed_database_id, database_sub_type, schedule_type, schedule_details, job_type, lifecycle_state, timeout, , time_created, time_updated, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
396 397 398 399 400 401 402 403 404 405 |
# File 'lib/oci/database_management/models/job_summary.rb', line 396 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
390 391 392 |
# File 'lib/oci/database_management/models/job_summary.rb', line 390 def to_s to_hash.to_s end |