Class: OCI::OsManagementHub::Models::ScheduledJobSummary
- Inherits:
-
Object
- Object
- OCI::OsManagementHub::Models::ScheduledJobSummary
- Defined in:
- lib/oci/os_management_hub/models/scheduled_job_summary.rb
Overview
Provides summary information for a scheduled job.
Constant Summary collapse
- SCHEDULE_TYPE_ENUM =
[ SCHEDULE_TYPE_ONETIME = 'ONETIME'.freeze, SCHEDULE_TYPE_RECURRING = 'RECURRING'.freeze, SCHEDULE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the scheduled job.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource.
-
#display_name ⇒ String
[Required] User-friendly name for the scheduled job.
-
#freeform_tags ⇒ Hash<String, String>
[Required] Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the scheduled job.
-
#is_managed_by_autonomous_linux ⇒ BOOLEAN
Indicates whether this scheduled job is managed by the Autonomous Linux service.
-
#is_restricted ⇒ BOOLEAN
Indicates if the schedule job has restricted update and deletion capabilities.
-
#lifecycle_stage_ids ⇒ Array<String>
The lifecycle stage OCIDs that this scheduled job operates on.
-
#lifecycle_state ⇒ String
[Required] The current state of the scheduled job.
-
#locations ⇒ Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>
The list of locations this scheduled job should operate on for a job targeting on compartments.
-
#managed_compartment_ids ⇒ Array<String>
The compartment OCIDs that this scheduled job operates on.
-
#managed_instance_group_ids ⇒ Array<String>
The managed instance group OCIDs that this scheduled job operates on.
-
#managed_instance_ids ⇒ Array<String>
The managed instance OCIDs that this scheduled job operates on.
-
#operations ⇒ Array<OCI::OsManagementHub::Models::ScheduledJobOperation>
[Required] The list of operations this scheduled job needs to perform.
-
#retry_intervals ⇒ Array<Integer>
The amount of time in minutes to wait until retrying the scheduled job.
-
#schedule_type ⇒ String
[Required] The type of scheduling this scheduled job follows.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The time this scheduled job was created (in RFC 3339 format).
-
#time_last_execution ⇒ DateTime
The time of the last execution of this scheduled job (in RFC 3339 format).b.
-
#time_next_execution ⇒ DateTime
[Required] The time of the next execution of this scheduled job (in RFC 3339 format).
-
#time_updated ⇒ DateTime
[Required] The time this scheduled job was updated (in RFC 3339 format).
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 = {}) ⇒ ScheduledJobSummary
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 = {}) ⇒ ScheduledJobSummary
Initializes the object
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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 223 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.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] 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.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.locations = attributes[:'locations'] if attributes[:'locations'] 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.time_next_execution = attributes[:'timeNextExecution'] if attributes[:'timeNextExecution'] raise 'You cannot provide both :timeNextExecution and :time_next_execution' if attributes.key?(:'timeNextExecution') && attributes.key?(:'time_next_execution') self.time_next_execution = attributes[:'time_next_execution'] if attributes[:'time_next_execution'] self.time_last_execution = attributes[:'timeLastExecution'] if attributes[:'timeLastExecution'] raise 'You cannot provide both :timeLastExecution and :time_last_execution' if attributes.key?(:'timeLastExecution') && attributes.key?(:'time_last_execution') self.time_last_execution = attributes[:'time_last_execution'] if attributes[:'time_last_execution'] self.managed_instance_ids = attributes[:'managedInstanceIds'] if attributes[:'managedInstanceIds'] raise 'You cannot provide both :managedInstanceIds and :managed_instance_ids' if attributes.key?(:'managedInstanceIds') && attributes.key?(:'managed_instance_ids') self.managed_instance_ids = attributes[:'managed_instance_ids'] if attributes[:'managed_instance_ids'] self.managed_instance_group_ids = attributes[:'managedInstanceGroupIds'] if attributes[:'managedInstanceGroupIds'] raise 'You cannot provide both :managedInstanceGroupIds and :managed_instance_group_ids' if attributes.key?(:'managedInstanceGroupIds') && attributes.key?(:'managed_instance_group_ids') self.managed_instance_group_ids = attributes[:'managed_instance_group_ids'] if attributes[:'managed_instance_group_ids'] self.managed_compartment_ids = attributes[:'managedCompartmentIds'] if attributes[:'managedCompartmentIds'] raise 'You cannot provide both :managedCompartmentIds and :managed_compartment_ids' if attributes.key?(:'managedCompartmentIds') && attributes.key?(:'managed_compartment_ids') self.managed_compartment_ids = attributes[:'managed_compartment_ids'] if attributes[:'managed_compartment_ids'] self.lifecycle_stage_ids = attributes[:'lifecycleStageIds'] if attributes[:'lifecycleStageIds'] raise 'You cannot provide both :lifecycleStageIds and :lifecycle_stage_ids' if attributes.key?(:'lifecycleStageIds') && attributes.key?(:'lifecycle_stage_ids') self.lifecycle_stage_ids = attributes[:'lifecycle_stage_ids'] if attributes[:'lifecycle_stage_ids'] self.operations = attributes[:'operations'] if attributes[:'operations'] 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.is_managed_by_autonomous_linux = attributes[:'isManagedByAutonomousLinux'] unless attributes[:'isManagedByAutonomousLinux'].nil? raise 'You cannot provide both :isManagedByAutonomousLinux and :is_managed_by_autonomous_linux' if attributes.key?(:'isManagedByAutonomousLinux') && attributes.key?(:'is_managed_by_autonomous_linux') self.is_managed_by_autonomous_linux = attributes[:'is_managed_by_autonomous_linux'] unless attributes[:'is_managed_by_autonomous_linux'].nil? 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'] self.is_restricted = attributes[:'isRestricted'] unless attributes[:'isRestricted'].nil? raise 'You cannot provide both :isRestricted and :is_restricted' if attributes.key?(:'isRestricted') && attributes.key?(:'is_restricted') self.is_restricted = attributes[:'is_restricted'] unless attributes[:'is_restricted'].nil? self.retry_intervals = attributes[:'retryIntervals'] if attributes[:'retryIntervals'] raise 'You cannot provide both :retryIntervals and :retry_intervals' if attributes.key?(:'retryIntervals') && attributes.key?(:'retry_intervals') self.retry_intervals = attributes[:'retry_intervals'] if attributes[:'retry_intervals'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the scheduled job.
28 29 30 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 28 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
116 117 118 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 116 def @defined_tags end |
#display_name ⇒ String
[Required] User-friendly name for the scheduled job.
24 25 26 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 24 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
[Required] 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\"}
109 110 111 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 109 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the scheduled job.
20 21 22 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 20 def id @id end |
#is_managed_by_autonomous_linux ⇒ BOOLEAN
Indicates whether this scheduled job is managed by the Autonomous Linux service.
102 103 104 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 102 def is_managed_by_autonomous_linux @is_managed_by_autonomous_linux end |
#is_restricted ⇒ BOOLEAN
Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
128 129 130 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 128 def is_restricted @is_restricted end |
#lifecycle_stage_ids ⇒ Array<String>
The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
80 81 82 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 80 def lifecycle_stage_ids @lifecycle_stage_ids end |
#lifecycle_state ⇒ String
[Required] The current state of the scheduled job.
98 99 100 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 98 def lifecycle_state @lifecycle_state end |
#locations ⇒ Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>
The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
36 37 38 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 36 def locations @locations end |
#managed_compartment_ids ⇒ Array<String>
The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
73 74 75 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 73 def managed_compartment_ids @managed_compartment_ids end |
#managed_instance_group_ids ⇒ Array<String>
The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
66 67 68 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 66 def managed_instance_group_ids @managed_instance_group_ids end |
#managed_instance_ids ⇒ Array<String>
The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
59 60 61 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 59 def managed_instance_ids @managed_instance_ids end |
#operations ⇒ Array<OCI::OsManagementHub::Models::ScheduledJobOperation>
[Required] The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: * UPDATE_PACKAGES * UPDATE_ALL * UPDATE_SECURITY * UPDATE_BUGFIX * UPDATE_ENHANCEMENT * UPDATE_OTHER * UPDATE_KSPLICE_USERSPACE * UPDATE_KSPLICE_KERNEL
94 95 96 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 94 def operations @operations end |
#retry_intervals ⇒ Array<Integer>
The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
136 137 138 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 136 def retry_intervals @retry_intervals end |
#schedule_type ⇒ String
[Required] The type of scheduling this scheduled job follows.
32 33 34 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 32 def schedule_type @schedule_type end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
122 123 124 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 122 def @system_tags end |
#time_created ⇒ DateTime
[Required] The time this scheduled job was created (in RFC 3339 format).
40 41 42 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 40 def time_created @time_created end |
#time_last_execution ⇒ DateTime
The time of the last execution of this scheduled job (in RFC 3339 format).b.
52 53 54 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 52 def time_last_execution @time_last_execution end |
#time_next_execution ⇒ DateTime
[Required] The time of the next execution of this scheduled job (in RFC 3339 format).
48 49 50 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 48 def time_next_execution @time_next_execution end |
#time_updated ⇒ DateTime
[Required] The time this scheduled job was updated (in RFC 3339 format).
44 45 46 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 44 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 139 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'schedule_type': :'scheduleType', 'locations': :'locations', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'time_next_execution': :'timeNextExecution', 'time_last_execution': :'timeLastExecution', 'managed_instance_ids': :'managedInstanceIds', 'managed_instance_group_ids': :'managedInstanceGroupIds', 'managed_compartment_ids': :'managedCompartmentIds', 'lifecycle_stage_ids': :'lifecycleStageIds', 'operations': :'operations', 'lifecycle_state': :'lifecycleState', 'is_managed_by_autonomous_linux': :'isManagedByAutonomousLinux', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags', 'is_restricted': :'isRestricted', 'retry_intervals': :'retryIntervals' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 168 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'schedule_type': :'String', 'locations': :'Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'time_next_execution': :'DateTime', 'time_last_execution': :'DateTime', 'managed_instance_ids': :'Array<String>', 'managed_instance_group_ids': :'Array<String>', 'managed_compartment_ids': :'Array<String>', 'lifecycle_stage_ids': :'Array<String>', 'operations': :'Array<OCI::OsManagementHub::Models::ScheduledJobOperation>', 'lifecycle_state': :'String', 'is_managed_by_autonomous_linux': :'BOOLEAN', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'is_restricted': :'BOOLEAN', 'retry_intervals': :'Array<Integer>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 364 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && schedule_type == other.schedule_type && locations == other.locations && time_created == other.time_created && time_updated == other.time_updated && time_next_execution == other.time_next_execution && time_last_execution == other.time_last_execution && managed_instance_ids == other.managed_instance_ids && managed_instance_group_ids == other.managed_instance_group_ids && managed_compartment_ids == other.managed_compartment_ids && lifecycle_stage_ids == other.lifecycle_stage_ids && operations == other.operations && lifecycle_state == other.lifecycle_state && is_managed_by_autonomous_linux == other.is_managed_by_autonomous_linux && == other. && == other. && == other. && is_restricted == other.is_restricted && retry_intervals == other.retry_intervals end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 414 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
394 395 396 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 394 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
403 404 405 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 403 def hash [id, display_name, compartment_id, schedule_type, locations, time_created, time_updated, time_next_execution, time_last_execution, managed_instance_ids, managed_instance_group_ids, managed_compartment_ids, lifecycle_stage_ids, operations, lifecycle_state, is_managed_by_autonomous_linux, , , , is_restricted, retry_intervals].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
447 448 449 450 451 452 453 454 455 456 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 447 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
441 442 443 |
# File 'lib/oci/os_management_hub/models/scheduled_job_summary.rb', line 441 def to_s to_hash.to_s end |