Class: OCI::Sch::Models::NotificationsTargetDetails

Inherits:
TargetDetails
  • Object
show all
Defined in:
lib/oci/sch/models/notifications_target_details.rb

Overview

The topic used for the Notifications target. For configuration instructions, see To create a service connector.

Constant Summary

Constants inherited from TargetDetails

TargetDetails::KIND_ENUM

Instance Attribute Summary collapse

Attributes inherited from TargetDetails

#kind

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TargetDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ NotificationsTargetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

Instance Attribute Details

#enable_formatted_messaging ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


25
26
27
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 25

def enable_formatted_messaging
  @enable_formatted_messaging
end

#topic_id ⇒ String

[Required] The OCID of the topic.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 18

def topic_id
  @topic_id
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'topic_id': :'topicId',
    'enable_formatted_messaging': :'enableFormattedMessaging'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'topic_id': :'String',
    'enable_formatted_messaging': :'BOOLEAN'
    # 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



87
88
89
90
91
92
93
94
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 87

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



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

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


99
100
101
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 108

def hash
  [kind, topic_id, enable_formatted_messaging].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/sch/models/notifications_target_details.rb', line 146

def to_s
  to_hash.to_s
end