class OCI::Ons::Models::BackoffRetryPolicy
The backoff retry portion of the subscription delivery policy. For information about retry durations for subscriptions, see [How Notifications Works](docs.cloud.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#how).
Constants
- POLICY_TYPE_ENUM
Attributes
[Required] The maximum retry duration in milliseconds. Default value is `7200000` (2 hours). @return [Integer]
[Required] The type of delivery policy.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/ons/models/backoff_retry_policy.rb, line 28 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'max_retry_duration': :'maxRetryDuration', 'policy_type': :'policyType' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Integer] :max_retry_duration The value to assign to the {#max_retry_duration} property @option attributes [String] :policy_type The value to assign to the {#policy_type} property
# File lib/oci/ons/models/backoff_retry_policy.rb, line 55 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
Attribute type mapping.
# File lib/oci/ons/models/backoff_retry_policy.rb, line 38 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'max_retry_duration': :'Integer', 'policy_type': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/ons/models/backoff_retry_policy.rb, line 96 def ==(other) return true if equal?(other) self.class == other.class && max_retry_duration == other.max_retry_duration && policy_type == other.policy_type end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/ons/models/backoff_retry_policy.rb, line 127 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/ons/models/backoff_retry_policy.rb, line 107 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/ons/models/backoff_retry_policy.rb, line 116 def hash [max_retry_duration, policy_type].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] policy_type
Object
to be assigned
# File lib/oci/ons/models/backoff_retry_policy.rb, line 80 def policy_type=(policy_type) # rubocop:disable Style/ConditionalAssignment if policy_type && !POLICY_TYPE_ENUM.include?(policy_type) OCI.logger.debug("Unknown value for 'policy_type' [" + policy_type + "]. Mapping to 'POLICY_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @policy_type = POLICY_TYPE_UNKNOWN_ENUM_VALUE else @policy_type = policy_type end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/ons/models/backoff_retry_policy.rb, line 160 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/ons/models/backoff_retry_policy.rb, line 154 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/ons/models/backoff_retry_policy.rb, line 177 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end