Class: OCI::ResourceScheduler::Models::Schedule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_scheduler/models/schedule.rb

Overview

A Schedule describes the date and time when an operation will be or has been applied to a set of resources. You must specify either the resources directly or provide a set of resource filters to select the resources.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, contact your administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_START_RESOURCE = 'START_RESOURCE'.freeze,
  ACTION_STOP_RESOURCE = 'STOP_RESOURCE'.freeze,
  ACTION_BACKUP_RESOURCE = 'BACKUP_RESOURCE'.freeze,
  ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RECURRENCE_TYPE_ENUM = 
[
  RECURRENCE_TYPE_CRON = 'CRON'.freeze,
  RECURRENCE_TYPE_ICAL = 'ICAL'.freeze,
  RECURRENCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LAST_RUN_STATUS_ENUM = 
[
  LAST_RUN_STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  LAST_RUN_STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LAST_RUN_STATUS_WAITING = 'WAITING'.freeze,
  LAST_RUN_STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LAST_RUN_STATUS_FAILED = 'FAILED'.freeze,
  LAST_RUN_STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  LAST_RUN_STATUS_CANCELING = 'CANCELING'.freeze,
  LAST_RUN_STATUS_CANCELED = 'CANCELED'.freeze,
  LAST_RUN_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ Schedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 247

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

  self.recurrence_details = attributes[:'recurrenceDetails'] if attributes[:'recurrenceDetails']

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

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

  self.recurrence_type = attributes[:'recurrenceType'] if attributes[:'recurrenceType']

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

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

  self.resource_filters = attributes[:'resourceFilters'] if attributes[:'resourceFilters']

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

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

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

  self.time_starts = attributes[:'timeStarts'] if attributes[:'timeStarts']

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

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

  self.time_ends = attributes[:'timeEnds'] if attributes[:'timeEnds']

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

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

  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_last_run = attributes[:'timeLastRun'] if attributes[:'timeLastRun']

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

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

  self.time_next_run = attributes[:'timeNextRun'] if attributes[:'timeNextRun']

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

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

  self.last_run_status = attributes[:'lastRunStatus'] if attributes[:'lastRunStatus']

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

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

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

[Required] This is the action that will be executed by the schedule.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 72

def action
  @action
end

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the schedule is created

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 60

def compartment_id
  @compartment_id
end

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

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


156
157
158
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 156

def defined_tags
  @defined_tags
end

#description ⇒ String

This is the description of the schedule.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 68

def description
  @description
end

#display_name ⇒ String

[Required] This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 64

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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


148
149
150
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 148

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the schedule

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 56

def id
  @id
end

#last_run_status ⇒ String

This is the status of the last work request.

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 136

def last_run_status
  @last_run_status
end

#lifecycle_state ⇒ String

[Required] This is the current state of a schedule.

Returns:

  • (String) 


140
141
142
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 140

def lifecycle_state
  @lifecycle_state
end

#recurrence_details ⇒ String

[Required] This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 78

def recurrence_details
  @recurrence_details
end

#recurrence_type ⇒ String

[Required] Type of recurrence of a schedule

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 82

def recurrence_type
  @recurrence_type
end

#resource_filters ⇒ Array<OCI::ResourceScheduler::Models::ResourceFilter>

This is a list of resources filters. The schedule will be applied to resources matching all of them.

Returns:



86
87
88
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 86

def resource_filters
  @resource_filters
end

#resources ⇒ Array<OCI::ResourceScheduler::Models::Resource>

This is the list of resources to which the scheduled operation is applied.

Returns:



90
91
92
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 90

def resources
  @resources
end

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

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


163
164
165
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 163

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] This is the date and time the schedule was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


111
112
113
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 111

def time_created
  @time_created
end

#time_ends ⇒ DateTime

This is the date and time the schedule ends, in the format defined by RFC 3339

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


104
105
106
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 104

def time_ends
  @time_ends
end

#time_last_run ⇒ DateTime

This is the date and time the schedule runs last time, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


125
126
127
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 125

def time_last_run
  @time_last_run
end

#time_next_run ⇒ DateTime

This is the date and time the schedule run the next time, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


132
133
134
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 132

def time_next_run
  @time_next_run
end

#time_starts ⇒ DateTime

This is the date and time the schedule starts, in the format defined by RFC 3339

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


97
98
99
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 97

def time_starts
  @time_starts
end

#time_updated ⇒ DateTime

This is the date and time the schedule was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


118
119
120
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 118

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 166

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'action': :'action',
    'recurrence_details': :'recurrenceDetails',
    'recurrence_type': :'recurrenceType',
    'resource_filters': :'resourceFilters',
    'resources': :'resources',
    'time_starts': :'timeStarts',
    'time_ends': :'timeEnds',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_last_run': :'timeLastRun',
    'time_next_run': :'timeNextRun',
    'last_run_status': :'lastRunStatus',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 194

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'action': :'String',
    'recurrence_details': :'String',
    'recurrence_type': :'String',
    'resource_filters': :'Array<OCI::ResourceScheduler::Models::ResourceFilter>',
    'resources': :'Array<OCI::ResourceScheduler::Models::Resource>',
    'time_starts': :'DateTime',
    'time_ends': :'DateTime',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_last_run': :'DateTime',
    'time_next_run': :'DateTime',
    'last_run_status': :'String',
    'lifecycle_state': :'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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 417

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    action == other.action &&
    recurrence_details == other.recurrence_details &&
    recurrence_type == other.recurrence_type &&
    resource_filters == other.resource_filters &&
    resources == other.resources &&
    time_starts == other.time_starts &&
    time_ends == other.time_ends &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_last_run == other.time_last_run &&
    time_next_run == other.time_next_run &&
    last_run_status == other.last_run_status &&
    lifecycle_state == other.lifecycle_state &&
    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



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 466

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


446
447
448
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 446

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



455
456
457
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 455

def hash
  [id, compartment_id, display_name, description, action, recurrence_details, recurrence_type, resource_filters, resources, time_starts, time_ends, time_created, time_updated, time_last_run, time_next_run, last_run_status, lifecycle_state, 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



499
500
501
502
503
504
505
506
507
508
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 499

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



493
494
495
 
# File 'lib/oci/resource_scheduler/models/schedule.rb', line 493

def to_s
  to_hash.to_s
end