class OCI::Sch::Models::NotificationsTargetDetails

The topic used for the Notifications target.

Attributes

enable_formatted_messaging[RW]

Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the service connector source and the subscription protocol.

Example: `true`

@return [BOOLEAN]

topic_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/sch/models/notifications_target_details.rb, line 25
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'topic_id': :'topicId',
    'enable_formatted_messaging': :'enableFormattedMessaging'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :topic_id The value to assign to the {#topic_id} property @option attributes [BOOLEAN] :enable_formatted_messaging The value to assign to the {#enable_formatted_messaging} property

Calls superclass method OCI::Sch::Models::TargetDetails::new
# File lib/oci/sch/models/notifications_target_details.rb, line 54
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['kind'] = 'notifications'

  super(attributes)

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

  self.topic_id = attributes[:'topicId'] if attributes[:'topicId']

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

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

  self.enable_formatted_messaging = attributes[:'enableFormattedMessaging'] unless attributes[:'enableFormattedMessaging'].nil?

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

  self.enable_formatted_messaging = attributes[:'enable_formatted_messaging'] unless attributes[:'enable_formatted_messaging'].nil?
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/sch/models/notifications_target_details.rb, line 36
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'topic_id': :'String',
    'enable_formatted_messaging': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/sch/models/notifications_target_details.rb, line 84
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    kind == other.kind &&
    topic_id == other.topic_id &&
    enable_formatted_messaging == other.enable_formatted_messaging
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/sch/models/notifications_target_details.rb, line 116
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/sch/models/notifications_target_details.rb, line 96
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/sch/models/notifications_target_details.rb, line 105
def hash
  [kind, topic_id, enable_formatted_messaging].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/sch/models/notifications_target_details.rb, line 149
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/sch/models/notifications_target_details.rb, line 143
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/sch/models/notifications_target_details.rb, line 166
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