Class: OCI::OsManagementHub::Models::CreateScheduledJobDetails

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

Overview

Provides the information used to create a scheduled job.

Constant Summary collapse

SCHEDULE_TYPE_ENUM = 
[
  SCHEDULE_TYPE_ONETIME = 'ONETIME'.freeze,
  SCHEDULE_TYPE_RECURRING = 'RECURRING'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateScheduledJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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


18
19
20
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 18

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

Returns:

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


115
116
117
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 115

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description of the scheduled job. Avoid entering confidential information.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 26

def description
  @description
end

#display_name ⇒ String

User-friendly name for the scheduled job. Does not have to be unique and you can change the name later. Avoid entering confidential information.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 22

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, lifecycleStageIds, managedCompartmentIds.

Returns:

  • (Array<String>) 


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

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

Returns:

  • (Hash<String, String>) 


108
109
110
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 108

def freeform_tags
  @freeform_tags
end

#is_managed_by_autonomous_linux ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


127
128
129
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 127

def is_managed_by_autonomous_linux
  @is_managed_by_autonomous_linux
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) 


87
88
89
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 87

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 you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or managedCompartmentIds, or dynamicSetIds.

Returns:

  • (Array<String>) 


74
75
76
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 74

def lifecycle_stage_ids
  @lifecycle_stage_ids
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>) 


34
35
36
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 34

def locations
  @locations
end

#managed_compartment_ids ⇒ Array<String>

The compartment OCIDs that this scheduled job operates on. To apply the job to all compartments in the tenancy, set this to the tenancy OCID (root compartment) and set isSubcompartmentIncluded to true. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or lifecycleStageIds, or dynamicSetIds.

Returns:

  • (Array<String>) 


67
68
69
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 67

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 you must supply either this or managedInstanceIds, or managedCompartmentIds, or lifecycleStageIds, or dynamicSetIds.

Returns:

  • (Array<String>) 


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

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 you must supply either this or managedInstanceGroupIds, or managedCompartmentIds, or lifecycleStageIds, or dynamicSetIds.

Returns:

  • (Array<String>) 


52
53
54
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 52

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:



101
102
103
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 101

def operations
  @operations
end

#recurring_rule ⇒ String

The frequency schedule for a recurring scheduled job in the RFC5535 format. Note: 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) 


45
46
47
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 45

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


123
124
125
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 123

def retry_intervals
  @retry_intervals
end

#schedule_type ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 30

def schedule_type
  @schedule_type
end

#time_next_execution ⇒ DateTime

[Required] The desired time of the next execution of this scheduled job (in RFC 3339 format).

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 38

def time_next_execution
  @time_next_execution
end

#work_request_id ⇒ String

The OCID for the work request that will be rerun.

Returns:

  • (String) 


131
132
133
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 131

def work_request_id
  @work_request_id
end

Class Method Details

.attribute_map ⇒ Object

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



134
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/os_management_hub/models/create_scheduled_job_details.rb', line 134

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'schedule_type': :'scheduleType',
    'locations': :'locations',
    'time_next_execution': :'timeNextExecution',
    '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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'retry_intervals': :'retryIntervals',
    'is_managed_by_autonomous_linux': :'isManagedByAutonomousLinux',
    'work_request_id': :'workRequestId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'schedule_type': :'String',
    'locations': :'Array<OCI::OsManagementHub::Models::ManagedInstanceLocation>',
    'time_next_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>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'retry_intervals': :'Array<Integer>',
    'is_managed_by_autonomous_linux': :'BOOLEAN',
    '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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 338

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    schedule_type == other.schedule_type &&
    locations == other.locations &&
    time_next_execution == other.time_next_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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    retry_intervals == other.retry_intervals &&
    is_managed_by_autonomous_linux == other.is_managed_by_autonomous_linux &&
    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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 386

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


366
367
368
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 366

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



375
376
377
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 375

def hash
  [compartment_id, display_name, description, schedule_type, locations, time_next_execution, recurring_rule, managed_instance_ids, managed_instance_group_ids, managed_compartment_ids, lifecycle_stage_ids, dynamic_set_ids, is_subcompartment_included, operations, freeform_tags, defined_tags, retry_intervals, is_managed_by_autonomous_linux, 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



419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 419

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



413
414
415
 
# File 'lib/oci/os_management_hub/models/create_scheduled_job_details.rb', line 413

def to_s
  to_hash.to_s
end