Class: OCI::FleetAppsManagement::Models::SchedulerDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/scheduler_definition.rb

Overview

Definition of a Schedule.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ SchedulerDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 203

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

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

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

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

  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_of_next_run = attributes[:'timeOfNextRun'] if attributes[:'timeOfNextRun']

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

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

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

  self.count_of_affected_action_groups = attributes[:'countOfAffectedActionGroups'] if attributes[:'countOfAffectedActionGroups']

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

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

  self.count_of_affected_resources = attributes[:'countOfAffectedResources'] if attributes[:'countOfAffectedResources']

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

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

  self.count_of_affected_targets = attributes[:'countOfAffectedTargets'] if attributes[:'countOfAffectedTargets']

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

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

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

  self.lifecycle_operations = attributes[:'lifecycleOperations'] if attributes[:'lifecycleOperations']

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

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

  self.action_groups = attributes[:'actionGroups'] if attributes[:'actionGroups']

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

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

  self.run_books = attributes[:'runBooks'] if attributes[:'runBooks']

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

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

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

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

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

  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']
end

Instance Attribute Details

#action_groups ⇒ Array<OCI::FleetAppsManagement::Models::ActionGroup>

Action Groups associated with the Schedule.

Returns:



86
87
88
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 86

def action_groups
  @action_groups
end

#compartment_id ⇒ String

[Required] Compartment OCID

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 43

def compartment_id
  @compartment_id
end

#count_of_affected_action_groups ⇒ Integer

Count of Action Groups affected by the Schedule.

Returns:

  • (Integer) 


66
67
68
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 66

def count_of_affected_action_groups
  @count_of_affected_action_groups
end

#count_of_affected_resources ⇒ Integer

Count of Resources affected by the Schedule.

Returns:

  • (Integer) 


70
71
72
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 70

def count_of_affected_resources
  @count_of_affected_resources
end

#count_of_affected_targets ⇒ Integer

Count of Targets affected by the Schedule.

Returns:

  • (Integer) 


74
75
76
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 74

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


110
111
112
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 110

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 39

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: My new resource

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 33

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


104
105
106
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 104

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 25

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 98

def lifecycle_details
  @lifecycle_details
end

#lifecycle_operations ⇒ Array<String>

All LifeCycle Operations that are part of the schedule.

Returns:

  • (Array<String>) 


82
83
84
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 82

def lifecycle_operations
  @lifecycle_operations
end

#lifecycle_state ⇒ String

[Required] The current state of the SchedulerDefinition.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 94

def lifecycle_state
  @lifecycle_state
end

#products ⇒ Array<String>

All products that are part of the schedule for PRODUCT ActionGroup Type.

Returns:

  • (Array<String>) 


78
79
80
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 78

def products
  @products
end

#resource_region ⇒ String

Associated region

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 47

def resource_region
  @resource_region
end

#run_books ⇒ Array<OCI::FleetAppsManagement::Models::OperationRunbook>

Runbooks.

Returns:



90
91
92
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 90

def run_books
  @run_books
end

#schedule ⇒ OCI::FleetAppsManagement::Models::Schedule

Returns:



62
63
64
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 62

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


116
117
118
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 116

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time this resource was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 51

def time_created
  @time_created
end

#time_of_next_run ⇒ DateTime

The scheduled date for the next run of the Job.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 59

def time_of_next_run
  @time_of_next_run
end

#time_updated ⇒ DateTime

The time this resource was last updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 55

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 119

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'resource_region': :'resourceRegion',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_of_next_run': :'timeOfNextRun',
    'schedule': :'schedule',
    'count_of_affected_action_groups': :'countOfAffectedActionGroups',
    'count_of_affected_resources': :'countOfAffectedResources',
    'count_of_affected_targets': :'countOfAffectedTargets',
    'products': :'products',
    'lifecycle_operations': :'lifecycleOperations',
    'action_groups': :'actionGroups',
    'run_books': :'runBooks',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 148

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'resource_region': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_of_next_run': :'DateTime',
    'schedule': :'OCI::FleetAppsManagement::Models::Schedule',
    'count_of_affected_action_groups': :'Integer',
    'count_of_affected_resources': :'Integer',
    'count_of_affected_targets': :'Integer',
    'products': :'Array<String>',
    'lifecycle_operations': :'Array<String>',
    'action_groups': :'Array<OCI::FleetAppsManagement::Models::ActionGroup>',
    'run_books': :'Array<OCI::FleetAppsManagement::Models::OperationRunbook>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



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
 
# File 'lib/oci/fleet_apps_management/models/scheduler_definition.rb', line 340

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    resource_region == other.resource_region &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_of_next_run == other.time_of_next_run &&
    schedule == other.schedule &&
    count_of_affected_action_groups == other.count_of_affected_action_groups &&
    count_of_affected_resources == other.count_of_affected_resources &&
    count_of_affected_targets == other.count_of_affected_targets &&
    products == other.products &&
    lifecycle_operations == other.lifecycle_operations &&
    action_groups == other.action_groups &&
    run_books == other.run_books &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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/fleet_apps_management/models/scheduler_definition.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/fleet_apps_management/models/scheduler_definition.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/fleet_apps_management/models/scheduler_definition.rb', line 379

def hash
  [id, display_name, description, compartment_id, resource_region, time_created, time_updated, time_of_next_run, schedule, count_of_affected_action_groups, count_of_affected_resources, count_of_affected_targets, products, lifecycle_operations, action_groups, run_books, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].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/fleet_apps_management/models/scheduler_definition.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/fleet_apps_management/models/scheduler_definition.rb', line 417

def to_s
  to_hash.to_s
end