Class: OCI::OsManagementHub::Models::ScheduledJob

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/scheduled_job.rb

Overview

The object that defines a scheduled job. For more information about jobs, see Managing Jobs.

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
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduledJob

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :description (String) —

    The value to assign to the #description property

  • :schedule_type (String) —

    The value to assign to the #schedule_type property

  • :locations (Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>) —

    The value to assign to the #locations property

  • :time_next_execution (DateTime) —

    The value to assign to the #time_next_execution property

  • :time_last_execution (DateTime) —

    The value to assign to the #time_last_execution property

  • :recurring_rule (String) —

    The value to assign to the #recurring_rule property

  • :managed_instance_ids (Array<String>) —

    The value to assign to the #managed_instance_ids property

  • :managed_instance_group_ids (Array<String>) —

    The value to assign to the #managed_instance_group_ids property

  • :managed_compartment_ids (Array<String>) —

    The value to assign to the #managed_compartment_ids property

  • :lifecycle_stage_ids (Array<String>) —

    The value to assign to the #lifecycle_stage_ids property

  • :dynamic_set_ids (Array<String>) —

    The value to assign to the #dynamic_set_ids property

  • :is_subcompartment_included (BOOLEAN) —

    The value to assign to the #is_subcompartment_included property

  • :operations (Array<OCI::OsManagementHub::Models::ScheduledJobOperation>) —

    The value to assign to the #operations property

  • :work_request_ids (Array<String>) —

    The value to assign to the #work_request_ids property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :is_managed_by_autonomous_linux (BOOLEAN) —

    The value to assign to the #is_managed_by_autonomous_linux property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :is_restricted (BOOLEAN) —

    The value to assign to the #is_restricted property

  • :retry_intervals (Array<Integer>) —

    The value to assign to the #retry_intervals property

  • :work_request_id (String) —

    The value to assign to the #work_request_id property



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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 277

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.description = attributes[:'description'] if attributes[:'description']

  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_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.recurring_rule = attributes[:'recurringRule'] if attributes[:'recurringRule']

  raise 'You cannot provide both :recurringRule and :recurring_rule' if attributes.key?(:'recurringRule') && attributes.key?(:'recurring_rule')

  self.recurring_rule = attributes[:'recurring_rule'] if attributes[:'recurring_rule']

  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.dynamic_set_ids = attributes[:'dynamicSetIds'] if attributes[:'dynamicSetIds']

  raise 'You cannot provide both :dynamicSetIds and :dynamic_set_ids' if attributes.key?(:'dynamicSetIds') && attributes.key?(:'dynamic_set_ids')

  self.dynamic_set_ids = attributes[:'dynamic_set_ids'] if attributes[:'dynamic_set_ids']

  self.is_subcompartment_included = attributes[:'isSubcompartmentIncluded'] unless attributes[:'isSubcompartmentIncluded'].nil?
  self.is_subcompartment_included = false if is_subcompartment_included.nil? && !attributes.key?(:'isSubcompartmentIncluded') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isSubcompartmentIncluded and :is_subcompartment_included' if attributes.key?(:'isSubcompartmentIncluded') && attributes.key?(:'is_subcompartment_included')

  self.is_subcompartment_included = attributes[:'is_subcompartment_included'] unless attributes[:'is_subcompartment_included'].nil?
  self.is_subcompartment_included = false if is_subcompartment_included.nil? && !attributes.key?(:'isSubcompartmentIncluded') && !attributes.key?(:'is_subcompartment_included') # rubocop:disable Style/StringLiterals

  self.operations = attributes[:'operations'] if attributes[:'operations']

  self.work_request_ids = attributes[:'workRequestIds'] if attributes[:'workRequestIds']

  raise 'You cannot provide both :workRequestIds and :work_request_ids' if attributes.key?(:'workRequestIds') && attributes.key?(:'work_request_ids')

  self.work_request_ids = attributes[:'work_request_ids'] if attributes[:'work_request_ids']

  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.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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = 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']

  self.work_request_id = attributes[:'workRequestId'] if attributes[:'workRequestId']

  raise 'You cannot provide both :workRequestId and :work_request_id' if attributes.key?(:'workRequestId') && attributes.key?(:'work_request_id')

  self.work_request_id = attributes[:'work_request_id'] if attributes[:'work_request_id']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the scheduled job.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 39

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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


148
149
150
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 148

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description for the scheduled job.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 43

def description
  @description
end

#display_name ⇒ String

[Required] User-friendly name for the scheduled job.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 35

def display_name
  @display_name
end

#dynamic_set_ids ⇒ Array<String>

The dynamic set 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.

Returns:

  • (Array<String>) 


95
96
97
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 95

def dynamic_set_ids
  @dynamic_set_ids
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\"}

Returns:

  • (Hash<String, String>) 


141
142
143
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 141

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the scheduled job.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 31

def id
  @id
end

#is_managed_by_autonomous_linux ⇒ BOOLEAN

Indicates whether this scheduled job is managed by the Autonomous Linux service.

Returns:

  • (BOOLEAN) 


134
135
136
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 134

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.

Returns:

  • (BOOLEAN) 


160
161
162
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 160

def is_restricted
  @is_restricted
end

#is_subcompartment_included ⇒ BOOLEAN

Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).

Returns:

  • (BOOLEAN) 


100
101
102
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 100

def is_subcompartment_included
  @is_subcompartment_included
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, managedCompartmentIds, and dynamicSetIds.

Returns:

  • (Array<String>) 


88
89
90
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 88

def lifecycle_stage_ids
  @lifecycle_stage_ids
end

#lifecycle_state ⇒ String

[Required] The current state of the scheduled job.

Returns:

  • (String) 


130
131
132
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 130

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.

Returns:

  • (Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>) 


51
52
53
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 51

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.

Returns:

  • (Array<String>) 


81
82
83
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 81

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.

Returns:

  • (Array<String>) 


77
78
79
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 77

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.

Returns:

  • (Array<String>) 


73
74
75
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 73

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

Returns:



114
115
116
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 114

def operations
  @operations
end

#recurring_rule ⇒ String

The frequency schedule for a recurring scheduled job in the RFC5535 format. Currently, only FREQ/INTERVAL/BYMONTHDAY/BYDAY/BYSETPOS/BYMONTH/BYHOUR/BYMINUTE/BYSECOND rules are supported. In FREQ, only YEARLY, MONTHLY, WEEKLY, DAILY", HOURLY are supported.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 66

def recurring_rule
  @recurring_rule
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.

Returns:

  • (Array<Integer>) 


168
169
170
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 168

def retry_intervals
  @retry_intervals
end

#schedule_type ⇒ String

[Required] The type of scheduling frequency for the job.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 47

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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


154
155
156
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 154

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time this scheduled job was created (in RFC 3339 format).

Returns:

  • (DateTime) 


122
123
124
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 122

def time_created
  @time_created
end

#time_last_execution ⇒ DateTime

The time of the last execution of this scheduled job (in RFC 3339 format).

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 59

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

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 55

def time_next_execution
  @time_next_execution
end

#time_updated ⇒ DateTime

[Required] The time this scheduled job was updated (in RFC 3339 format).

Returns:

  • (DateTime) 


126
127
128
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 126

def time_updated
  @time_updated
end

#work_request_id ⇒ String

The OCID for the work request that will be rerun.

Returns:

  • (String) 


172
173
174
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 172

def work_request_id
  @work_request_id
end

#work_request_ids ⇒ Array<String>

The list of work request OCIDs associated with this scheduled job.

Returns:

  • (Array<String>) 


118
119
120
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 118

def work_request_ids
  @work_request_ids
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 175

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'schedule_type': :'scheduleType',
    'locations': :'locations',
    'time_next_execution': :'timeNextExecution',
    'time_last_execution': :'timeLastExecution',
    'recurring_rule': :'recurringRule',
    'managed_instance_ids': :'managedInstanceIds',
    'managed_instance_group_ids': :'managedInstanceGroupIds',
    'managed_compartment_ids': :'managedCompartmentIds',
    'lifecycle_stage_ids': :'lifecycleStageIds',
    'dynamic_set_ids': :'dynamicSetIds',
    'is_subcompartment_included': :'isSubcompartmentIncluded',
    'operations': :'operations',
    'work_request_ids': :'workRequestIds',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'is_managed_by_autonomous_linux': :'isManagedByAutonomousLinux',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'is_restricted': :'isRestricted',
    'retry_intervals': :'retryIntervals',
    'work_request_id': :'workRequestId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 210

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'schedule_type': :'String',
    'locations': :'Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>',
    'time_next_execution': :'DateTime',
    'time_last_execution': :'DateTime',
    'recurring_rule': :'String',
    'managed_instance_ids': :'Array<String>',
    'managed_instance_group_ids': :'Array<String>',
    'managed_compartment_ids': :'Array<String>',
    'lifecycle_stage_ids': :'Array<String>',
    'dynamic_set_ids': :'Array<String>',
    'is_subcompartment_included': :'BOOLEAN',
    'operations': :'Array<OCI::OsManagementHub::Models::ScheduledJobOperation>',
    'work_request_ids': :'Array<String>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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>',
    'work_request_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 465

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    schedule_type == other.schedule_type &&
    locations == other.locations &&
    time_next_execution == other.time_next_execution &&
    time_last_execution == other.time_last_execution &&
    recurring_rule == other.recurring_rule &&
    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 &&
    dynamic_set_ids == other.dynamic_set_ids &&
    is_subcompartment_included == other.is_subcompartment_included &&
    operations == other.operations &&
    work_request_ids == other.work_request_ids &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    is_managed_by_autonomous_linux == other.is_managed_by_autonomous_linux &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    is_restricted == other.is_restricted &&
    retry_intervals == other.retry_intervals &&
    work_request_id == other.work_request_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 521

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


501
502
503
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 501

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



510
511
512
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 510

def hash
  [id, display_name, compartment_id, description, schedule_type, locations, time_next_execution, time_last_execution, recurring_rule, managed_instance_ids, managed_instance_group_ids, managed_compartment_ids, lifecycle_stage_ids, dynamic_set_ids, is_subcompartment_included, operations, work_request_ids, time_created, time_updated, lifecycle_state, is_managed_by_autonomous_linux, freeform_tags, defined_tags, system_tags, is_restricted, retry_intervals, work_request_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



554
555
556
557
558
559
560
561
562
563
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 554

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

Returns:

  • (String) —

    String presentation of the object



548
549
550
 
# File 'lib/oci/os_management_hub/models/scheduled_job.rb', line 548

def to_s
  to_hash.to_s
end