Class: OCI::Iot::Models::DigitalTwinAdapterEnvelopeMapping

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

Overview

Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DigitalTwinAdapterEnvelopeMapping

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_observed (String) —

    The value to assign to the #time_observed property

  • :target (String) —

    The value to assign to the #target property

  • :content_root (String) —

    The value to assign to the #content_root property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 62

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

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

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

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

  self.content_root = attributes[:'contentRoot'] if attributes[:'contentRoot']

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

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

Instance Attribute Details

#content_root ⇒ String

JSON Path string to override the context root before delegating to the adapter of the target digital twin instance.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 29

def content_root
  @content_root
end

#target ⇒ String

Optional. JQ expression to map the target resource, which is externalKey of digital twin instance, the incoming data belongs to.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 25

def target
  @target
end

#time_observed ⇒ String

JQ expression to extract the observation timestamp from the payload. If not specified, the system will default to using timeReceived as the timestamp.

Example: For payload {\"time\": \"\",\"temp\": 65,\"hum\": 55} 'timeObserved' can be mapped as {JQ Expression}[https://jqplay.org/] $.time.

Returns:

  • (String) 


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

def time_observed
  @time_observed
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_observed': :'timeObserved',
    'target': :'target',
    'content_root': :'contentRoot'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_observed': :'String',
    'target': :'String',
    'content_root': :'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



90
91
92
93
94
95
96
97
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 90

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

  self.class == other.class &&
    time_observed == other.time_observed &&
    target == other.target &&
    content_root == other.content_root
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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 122

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


102
103
104
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 102

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 111

def hash
  [time_observed, target, content_root].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 155

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



149
150
151
 
# File 'lib/oci/iot/models/digital_twin_adapter_envelope_mapping.rb', line 149

def to_s
  to_hash.to_s
end