Class: OCI::Monitoring::Models::Recurrence

Inherits:
SuppressionCondition show all
Defined in:
lib/oci/monitoring/models/recurrence.rb

Overview

Alarm suppression recurring schedule. Only one recurrence condition is supported within the list of preconditions for a suppression (suppressionConditions).

Constant Summary

Constants inherited from SuppressionCondition

SuppressionCondition::CONDITION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from SuppressionCondition

#condition_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SuppressionCondition

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ Recurrence

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 58

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['conditionType'] = 'RECURRENCE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.suppression_recurrence = attributes[:'suppressionRecurrence'] if attributes[:'suppressionRecurrence']

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

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

  self.suppression_duration = attributes[:'suppressionDuration'] if attributes[:'suppressionDuration']

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

  self.suppression_duration = attributes[:'suppression_duration'] if attributes[:'suppression_duration']
end

Instance Attribute Details

#suppression_duration ⇒ String

[Required] Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: PT1M (1 minute). Maximum: PT24H (24 hours).

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 26

def suppression_duration
  @suppression_duration
end

#suppression_recurrence ⇒ String

[Required] Frequency and start time of the recurring suppression. The format follows the iCalendar specification (RFC 5545, section 3.3.10). Supported rule parts: * FREQ: Frequency of the recurring suppression: WEEKLY or DAILY only. * BYDAY: Comma separated days. Use with weekly suppressions only. Supported values: MO, TU, WE, TH, FR, SA ,SU. * BYHOUR, BYMINUTE, BYSECOND: Start time in UTC, after timeSuppressFrom value. Default is 00:00:00 UTC after timeSuppressFrom.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 21

def suppression_recurrence
  @suppression_recurrence
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'condition_type': :'conditionType',
    'suppression_recurrence': :'suppressionRecurrence',
    'suppression_duration': :'suppressionDuration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'condition_type': :'String',
    'suppression_recurrence': :'String',
    'suppression_duration': :'String'
    # 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



88
89
90
91
92
93
94
95
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 88

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

  self.class == other.class &&
    condition_type == other.condition_type &&
    suppression_recurrence == other.suppression_recurrence &&
    suppression_duration == other.suppression_duration
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



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

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


100
101
102
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 109

def hash
  [condition_type, suppression_recurrence, suppression_duration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 153

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



147
148
149
 
# File 'lib/oci/monitoring/models/recurrence.rb', line 147

def to_s
  to_hash.to_s
end