Class: OCI::FleetAppsManagement::Models::SchedulerJobSummary

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

Overview

Summary of the SchedulerJob.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SchedulerJobSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



171
172
173
174
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
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
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 171

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

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

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

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

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

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

  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::ActionGroupDetails>

Action Groups associated with the Schedule.

Returns:



64
65
66
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 64

def action_groups
  @action_groups
end

#compartment_id ⇒ String

[Required] Compartment OCID

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#count_of_affected_action_groups ⇒ Integer

Count of Action Groups affected by the Schedule. An action group is a group of entities grouped for a lifecycle activity. Example - A Fleet will be considered an Action Group for any lifecycle activity.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 44

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) 


48
49
50
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 48

def count_of_affected_resources
  @count_of_affected_resources
end

#count_of_affected_targets ⇒ Integer

Count of targets affected by the schedule.

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 52

def count_of_affected_targets
  @count_of_affected_targets
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] 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>>) 


87
88
89
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 87

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


21
22
23
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 21

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


81
82
83
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 81

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 13

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) 


75
76
77
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 75

def lifecycle_details
  @lifecycle_details
end

#lifecycle_operations ⇒ Array<String>

All LifeCycle Operations that are part of the schedule.

Returns:

  • (Array<String>) 


60
61
62
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 60

def lifecycle_operations
  @lifecycle_operations
end

#lifecycle_state ⇒ String

[Required] The current state of the SchedulerJob.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 71

def lifecycle_state
  @lifecycle_state
end

#products ⇒ Array<String>

All products that are part of the schedule for a PRODUCT action group type.

Returns:

  • (Array<String>) 


56
57
58
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 56

def products
  @products
end

#scheduler_definition ⇒ OCI::FleetAppsManagement::Models::AssociatedSchedulerDefinition

Returns:



67
68
69
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 67

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


93
94
95
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 93

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 29

def time_created
  @time_created
end

#time_scheduled ⇒ DateTime

The scheduled date and time for the Job.

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 37

def time_scheduled
  @time_scheduled
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 96

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_scheduled': :'timeScheduled',
    'count_of_affected_action_groups': :'countOfAffectedActionGroups',
    'count_of_affected_resources': :'countOfAffectedResources',
    'count_of_affected_targets': :'countOfAffectedTargets',
    'products': :'products',
    'lifecycle_operations': :'lifecycleOperations',
    'action_groups': :'actionGroups',
    'scheduler_definition': :'schedulerDefinition',
    '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.



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_job_summary.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_scheduled': :'DateTime',
    '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::ActionGroupDetails>',
    'scheduler_definition': :'OCI::FleetAppsManagement::Models::AssociatedSchedulerDefinition',
    '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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 285

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_scheduled == other.time_scheduled &&
    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 &&
    scheduler_definition == other.scheduler_definition &&
    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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 332

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


312
313
314
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 312

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



321
322
323
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 321

def hash
  [id, display_name, compartment_id, time_created, time_updated, time_scheduled, count_of_affected_action_groups, count_of_affected_resources, count_of_affected_targets, products, lifecycle_operations, action_groups, scheduler_definition, 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



365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 365

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



359
360
361
 
# File 'lib/oci/fleet_apps_management/models/scheduler_job_summary.rb', line 359

def to_s
  to_hash.to_s
end