Class: OCI::Iot::Models::DigitalTwinAdapterInboundRoute

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/iot/models/digital_twin_adapter_inbound_route.rb

Overview

Defines how inbound device payloads should be routed and mapped within a digital twin context. Routes are evaluated in the order they are defined, and only the first matching condition is processed. A final default route (with a condition that always evaluates to true) is recommended for fallback handling.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DigitalTwinAdapterInboundRoute

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 93

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

  self.reference_payload = attributes[:'referencePayload'] if attributes[:'referencePayload']

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

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

  self.payload_mapping = attributes[:'payloadMapping'] if attributes[:'payloadMapping']

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

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

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

Instance Attribute Details

#condition ⇒ String

[Required] A boolean expression used to determine whether the following transformation should be processed for the incoming payload. This expression is typically based on fields defined at the inbound Envelope and is evaluated before applying the payloadMapping.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 20

def condition
  @condition
end

#description ⇒ String

Meaningful write up about the inbound route.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 57

def description
  @description
end

#payload_mapping ⇒ Hash<String, String>

A set of key-value JQ expressions used to transform the incoming payload into a shape compatible with the digital twin model's context or schema.

The keys are target fields (in the digital twin model), and values are JQ expressions pointing to data in the reference payload.

Example: Given payload: { "time": "<timestamp>", "temp": 65, "hum": 55 } And mapping: { "temperature": "$.temp", "humidity": "$.hum", "timeObserved": "$.time" } The output will be: { "temperature": 65, "humidity": 55, "timeObserved": "<timestamp>" }

Returns:

  • (Hash<String, String>) 


52
53
54
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 52

def payload_mapping
  @payload_mapping
end

#reference_payload ⇒ OCI::Iot::Models::DigitalTwinAdapterPayload

Returns:



23
24
25
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 23

def reference_payload
  @reference_payload
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'condition': :'condition',
    'reference_payload': :'referencePayload',
    'payload_mapping': :'payloadMapping',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'condition': :'String',
    'reference_payload': :'OCI::Iot::Models::DigitalTwinAdapterPayload',
    'payload_mapping': :'Hash<String, String>',
    'description': :'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



123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 123

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

  self.class == other.class &&
    condition == other.condition &&
    reference_payload == other.reference_payload &&
    payload_mapping == other.payload_mapping &&
    description == other.description
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 156

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


136
137
138
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 145

def hash
  [condition, reference_payload, payload_mapping, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 189

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



183
184
185
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_route.rb', line 183

def to_s
  to_hash.to_s
end