Class: OCI::Iot::Models::DigitalTwinAdapterInboundEnvelope

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

Overview

Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ expressions to extract or reshape the data as needed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DigitalTwinAdapterInboundEnvelope

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
79
80
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 57

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

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

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

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

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

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

Instance Attribute Details

#envelope_mapping ⇒ OCI::Iot::Models::DigitalTwinAdapterEnvelopeMapping

Returns:



24
25
26
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 24

def envelope_mapping
  @envelope_mapping
end

#reference_endpoint ⇒ String

[Required] The device endpoint.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 18

def reference_endpoint
  @reference_endpoint
end

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

Returns:



21
22
23
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 21

def reference_payload
  @reference_payload
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'reference_endpoint': :'referenceEndpoint',
    'reference_payload': :'referencePayload',
    'envelope_mapping': :'envelopeMapping'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 38

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



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

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

  self.class == other.class &&
    reference_endpoint == other.reference_endpoint &&
    reference_payload == other.reference_payload &&
    envelope_mapping == other.envelope_mapping
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



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

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


101
102
103
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 110

def hash
  [reference_endpoint, reference_payload, envelope_mapping].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



148
149
150
 
# File 'lib/oci/iot/models/digital_twin_adapter_inbound_envelope.rb', line 148

def to_s
  to_hash.to_s
end