Class: OCI::ResourceScheduler::Models::UpdateScheduleDetails

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

Overview

This is the data to update a schedule.

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_START_RESOURCE = 'START_RESOURCE'.freeze,
  ACTION_STOP_RESOURCE = 'STOP_RESOURCE'.freeze
].freeze
RECURRENCE_TYPE_ENUM = 
[
  RECURRENCE_TYPE_CRON = 'CRON'.freeze,
  RECURRENCE_TYPE_ICAL = 'ICAL'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateScheduleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



136
137
138
139
140
141
142
143
144
145
146
147
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 136

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

Instance Attribute Details

#action ⇒ String

This is the action that will be executed by the schedule.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 31

def action
  @action
end

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

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


79
80
81
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 79

def defined_tags
  @defined_tags
end

#description ⇒ String

This is the description of the schedule.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 23

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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


71
72
73
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 71

def freeform_tags
  @freeform_tags
end

#recurrence_details ⇒ String

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) 


37
38
39
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 37

def recurrence_details
  @recurrence_details
end

#recurrence_type ⇒ String

Type of recurrence of a schedule

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 41

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:



45
46
47
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 45

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:



49
50
51
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 49

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


63
64
65
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 63

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


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

def time_starts
  @time_starts
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 82

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'action': :'action',
    'recurrence_details': :'recurrenceDetails',
    'recurrence_type': :'recurrenceType',
    'resource_filters': :'resourceFilters',
    'resources': :'resources',
    'time_starts': :'timeStarts',
    'time_ends': :'timeEnds',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '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',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 220

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

  self.class == other.class &&
    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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 260

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


240
241
242
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 240

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



249
250
251
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 249

def hash
  [display_name, description, action, recurrence_details, recurrence_type, resource_filters, resources, time_starts, time_ends, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 293

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



287
288
289
 
# File 'lib/oci/resource_scheduler/models/update_schedule_details.rb', line 287

def to_s
  to_hash.to_s
end