Class: OCI::FleetAppsManagement::Models::SchedulerDefinitionSummary

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

Overview

Summary of the SchedulerDefinition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SchedulerDefinitionSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
277
278
279
280
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 177

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

#compartment_idString

[Required] Compartment OCID

Returns:

  • (String)


31
32
33
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 31

def compartment_id
  @compartment_id
end

#count_of_affected_action_groupsInteger

Count of Action Groups affected by the Schedule.

Returns:

  • (Integer)


54
55
56
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 54

def count_of_affected_action_groups
  @count_of_affected_action_groups
end

#count_of_affected_resourcesInteger

Count of Resources affected by the Schedule

Returns:

  • (Integer)


58
59
60
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 58

def count_of_affected_resources
  @count_of_affected_resources
end

#count_of_affected_targetsInteger

Count of Targets affected by the Schedule

Returns:

  • (Integer)


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

def count_of_affected_targets
  @count_of_affected_targets
end

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


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

def defined_tags
  @defined_tags
end

#descriptionString

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

Returns:

  • (String)


27
28
29
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 27

def description
  @description
end

#display_nameString

[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_definition_summary.rb', line 21

def display_name
  @display_name
end

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


84
85
86
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 84

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the resource.

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_detailsString

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)


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_operationsArray<String>

All LifeCycle Operations part of the schedule

Returns:

  • (Array<String>)


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

def lifecycle_operations
  @lifecycle_operations
end

#lifecycle_stateString

The current state of the SchedulerDefinition.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#productsArray<String>

All products part of the schedule

Returns:

  • (Array<String>)


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

def products
  @products
end

#resource_regionString

Associated region

Returns:

  • (String)


35
36
37
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 35

def resource_region
  @resource_region
end

#scheduleOCI::FleetAppsManagement::Models::Schedule



50
51
52
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 50

def schedule
  @schedule
end

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


96
97
98
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 96

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_of_next_runDateTime

Scheduled date for the next run of the Job.

Returns:

  • (DateTime)


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

def time_of_next_run
  @time_of_next_run
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 99

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',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 126

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>',
    '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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 289

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



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

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


317
318
319
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 317

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



326
327
328
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 326

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, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 370

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



364
365
366
# File 'lib/oci/fleet_apps_management/models/scheduler_definition_summary.rb', line 364

def to_s
  to_hash.to_s
end