Class: OCI::OsManagement::Models::CreateScheduledJobDetails

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

Overview

Information for creating a Scheduled Job

Constant Summary collapse

SCHEDULE_TYPE_ENUM = 
[
  SCHEDULE_TYPE_ONETIME = 'ONETIME'.freeze,
  SCHEDULE_TYPE_RECURRING = 'RECURRING'.freeze
].freeze
INTERVAL_TYPE_ENUM = 
[
  INTERVAL_TYPE_HOUR = 'HOUR'.freeze,
  INTERVAL_TYPE_DAY = 'DAY'.freeze,
  INTERVAL_TYPE_WEEK = 'WEEK'.freeze,
  INTERVAL_TYPE_MONTH = 'MONTH'.freeze
].freeze
OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_INSTALL = 'INSTALL'.freeze,
  OPERATION_TYPE_UPDATE = 'UPDATE'.freeze,
  OPERATION_TYPE_REMOVE = 'REMOVE'.freeze,
  OPERATION_TYPE_UPDATEALL = 'UPDATEALL'.freeze,
  OPERATION_TYPE_ENABLEMODULESTREAM = 'ENABLEMODULESTREAM'.freeze,
  OPERATION_TYPE_DISABLEMODULESTREAM = 'DISABLEMODULESTREAM'.freeze,
  OPERATION_TYPE_SWITCHMODULESTREAM = 'SWITCHMODULESTREAM'.freeze,
  OPERATION_TYPE_INSTALLMODULESTREAMPROFILE = 'INSTALLMODULESTREAMPROFILE'.freeze,
  OPERATION_TYPE_REMOVEMODULESTREAMPROFILE = 'REMOVEMODULESTREAMPROFILE'.freeze,
  OPERATION_TYPE_COMPOUND = 'COMPOUND'.freeze
].freeze
UPDATE_TYPE_ENUM = 
[
  UPDATE_TYPE_SECURITY = 'SECURITY'.freeze,
  UPDATE_TYPE_BUGFIX = 'BUGFIX'.freeze,
  UPDATE_TYPE_ENHANCEMENT = 'ENHANCEMENT'.freeze,
  UPDATE_TYPE_OTHER = 'OTHER'.freeze,
  UPDATE_TYPE_KSPLICE = 'KSPLICE'.freeze,
  UPDATE_TYPE_ALL = 'ALL'.freeze
].freeze
OS_FAMILY_ENUM = 
[
  OS_FAMILY_LINUX = 'LINUX'.freeze,
  OS_FAMILY_WINDOWS = 'WINDOWS'.freeze,
  OS_FAMILY_ALL = 'ALL'.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):



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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 199

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

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

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

  self.interval_value = attributes[:'intervalValue'] if attributes[:'intervalValue']

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

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

  self.managed_instances = attributes[:'managedInstances'] if attributes[:'managedInstances']

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

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

  self.managed_instance_groups = attributes[:'managedInstanceGroups'] if attributes[:'managedInstanceGroups']

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

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

  self.operation_type = attributes[:'operationType'] if attributes[:'operationType']

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

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

  self.update_type = attributes[:'updateType'] if attributes[:'updateType']

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

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

  self.package_names = attributes[:'packageNames'] if attributes[:'packageNames']

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

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

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

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

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

  self.os_family = attributes[:'osFamily'] if attributes[:'osFamily']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID for the Compartment

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 53

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

Details describing the Scheduled Job.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 61

def description
  @description
end

#display_name ⇒ String

[Required] Scheduled Job name

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 57

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


109
110
111
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 109

def freeform_tags
  @freeform_tags
end

#interval_type ⇒ String

the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 73

def interval_type
  @interval_type
end

#interval_value ⇒ String

the value for the interval period for a recurring Scheduled Job (only if schedule type is RECURRING)

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 77

def interval_value
  @interval_value
end

#managed_instance_groups ⇒ Array<OCI::OsManagement::Models::Id>

The list of managed instance groups this scheduled job operates on (mutually exclusive with managedInstances). Either this or managedInstances must be supplied.

Returns:



91
92
93
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 91

def managed_instance_groups
  @managed_instance_groups
end

#managed_instances ⇒ Array<OCI::OsManagement::Models::Id>

The list of managed instances this scheduled job operates on (mutually exclusive with managedInstanceGroups). Either this or the managedInstanceGroups must be supplied.

Returns:



84
85
86
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 84

def managed_instances
  @managed_instances
end

#operation_type ⇒ String

[Required] the type of operation this Scheduled Job performs

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 95

def operation_type
  @operation_type
end

#os_family ⇒ String

The Operating System type of the managed instance(s) on which this scheduled job will operate. If not specified, this defaults to Linux.

Returns:

  • (String) 


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

def os_family
  @os_family
end

#package_names ⇒ Array<OCI::OsManagement::Models::PackageName>

the id of the package (only if operation type is INSTALL/UPDATE/REMOVE)

Returns:



103
104
105
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 103

def package_names
  @package_names
end

#schedule_type ⇒ String

[Required] the type of scheduling this Scheduled Job follows

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 65

def schedule_type
  @schedule_type
end

#time_next_execution ⇒ DateTime

[Required] the desired time for the next execution of this Scheduled Job

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 69

def time_next_execution
  @time_next_execution
end

#update_names ⇒ Array<String>

The unique names of the Windows Updates (only if operation type is INSTALL). This is only applicable when the osFamily is for Windows managed instances.

Returns:

  • (Array<String>) 


121
122
123
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 121

def update_names
  @update_names
end

#update_type ⇒ String

Type of the update (only if operation type is UPDATEALL)

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 99

def update_type
  @update_type
end

Class Method Details

.attribute_map ⇒ Object

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 130

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'schedule_type': :'scheduleType',
    'time_next_execution': :'timeNextExecution',
    'interval_type': :'intervalType',
    'interval_value': :'intervalValue',
    'managed_instances': :'managedInstances',
    'managed_instance_groups': :'managedInstanceGroups',
    'operation_type': :'operationType',
    'update_type': :'updateType',
    'package_names': :'packageNames',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'update_names': :'updateNames',
    'os_family': :'osFamily'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 154

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'schedule_type': :'String',
    'time_next_execution': :'DateTime',
    'interval_type': :'String',
    'interval_value': :'String',
    'managed_instances': :'Array<OCI::OsManagement::Models::Id>',
    'managed_instance_groups': :'Array<OCI::OsManagement::Models::Id>',
    'operation_type': :'String',
    'update_type': :'String',
    'package_names': :'Array<OCI::OsManagement::Models::PackageName>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'update_names': :'Array<String>',
    'os_family': :'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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 345

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 &&
    time_next_execution == other.time_next_execution &&
    interval_type == other.interval_type &&
    interval_value == other.interval_value &&
    managed_instances == other.managed_instances &&
    managed_instance_groups == other.managed_instance_groups &&
    operation_type == other.operation_type &&
    update_type == other.update_type &&
    package_names == other.package_names &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    update_names == other.update_names &&
    os_family == other.os_family
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



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 390

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


370
371
372
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 370

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



379
380
381
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 379

def hash
  [compartment_id, display_name, description, schedule_type, time_next_execution, interval_type, interval_value, managed_instances, managed_instance_groups, operation_type, update_type, package_names, freeform_tags, defined_tags, update_names, os_family].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 423

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



417
418
419
 
# File 'lib/oci/os_management/models/create_scheduled_job_details.rb', line 417

def to_s
  to_hash.to_s
end