Class: OCI::Ons::Models::BackoffRetryPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ons/models/backoff_retry_policy.rb

Overview

The backoff retry portion of the subscription delivery policy. For information about retry durations for subscriptions, see How Notifications Works.

Constant Summary collapse

POLICY_TYPE_ENUM = 
[
  POLICY_TYPE_EXPONENTIAL = 'EXPONENTIAL'.freeze,
  POLICY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackoffRetryPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :max_retry_duration (Integer) —

    The value to assign to the #max_retry_duration property

  • :policy_type (String) —

    The value to assign to the #policy_type property



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 56

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

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

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

  self.policy_type = attributes[:'policyType'] if attributes[:'policyType']
  self.policy_type = "EXPONENTIAL" if policy_type.nil? && !attributes.key?(:'policyType') # rubocop:disable Style/StringLiterals

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

  self.policy_type = attributes[:'policy_type'] if attributes[:'policy_type']
  self.policy_type = "EXPONENTIAL" if policy_type.nil? && !attributes.key?(:'policyType') && !attributes.key?(:'policy_type') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#max_retry_duration ⇒ Integer

[Required] The maximum retry duration in milliseconds. Default value is 7200000 (2 hours).

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 21

def max_retry_duration
  @max_retry_duration
end

#policy_type ⇒ String

[Required] The type of delivery policy.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 26

def policy_type
  @policy_type
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
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'max_retry_duration': :'maxRetryDuration',
    'policy_type': :'policyType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'max_retry_duration': :'Integer',
    'policy_type': :'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



97
98
99
100
101
102
103
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 97

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

  self.class == other.class &&
    max_retry_duration == other.max_retry_duration &&
    policy_type == other.policy_type
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



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/ons/models/backoff_retry_policy.rb', line 128

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


108
109
110
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 117

def hash
  [max_retry_duration, policy_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 161

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



155
156
157
 
# File 'lib/oci/ons/models/backoff_retry_policy.rb', line 155

def to_s
  to_hash.to_s
end