Class: OCI::Iot::Models::DigitalTwinAdapter

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

Overview

The digital twin adapter maps incoming data from IoT device into the corresponding digital twin instance. It defines the envelope structure, reference payload, routing and transformation rules using JSON Path and JQ to normalize the raw device data within the IoT domain.

To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DigitalTwinAdapter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 159

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

  self.iot_domain_id = attributes[:'iotDomainId'] if attributes[:'iotDomainId']

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

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

  self.digital_twin_model_id = attributes[:'digitalTwinModelId'] if attributes[:'digitalTwinModelId']

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

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

  self.digital_twin_model_spec_uri = attributes[:'digitalTwinModelSpecUri'] if attributes[:'digitalTwinModelSpecUri']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.inbound_envelope = attributes[:'inboundEnvelope'] if attributes[:'inboundEnvelope']

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

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

  self.inbound_routes = attributes[:'inboundRoutes'] if attributes[:'inboundRoutes']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


74
75
76
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 74

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 47

def description
  @description
end

#digital_twin_model_id ⇒ String

[Required] The OCID of the digital twin model.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 34

def digital_twin_model_id
  @digital_twin_model_id
end

#digital_twin_model_spec_uri ⇒ String

[Required] The URI of the digital twin model specification.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 38

def digital_twin_model_spec_uri
  @digital_twin_model_spec_uri
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 42

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 66

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 26

def id
  @id
end

#inbound_envelope ⇒ OCI::Iot::Models::DigitalTwinAdapterInboundEnvelope

Returns:



50
51
52
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 50

def inbound_envelope
  @inbound_envelope
end

#inbound_routes ⇒ Array<OCI::Iot::Models::DigitalTwinAdapterInboundRoute>

list of routes

Returns:



54
55
56
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 54

def inbound_routes
  @inbound_routes
end

#iot_domain_id ⇒ String

[Required] The OCID of the IoT domain.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 30

def iot_domain_id
  @iot_domain_id
end

#lifecycle_state ⇒ String

[Required] The current state of the digital twin adapter.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


81
82
83
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 81

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


87
88
89
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 87

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


93
94
95
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 93

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'iot_domain_id': :'iotDomainId',
    'digital_twin_model_id': :'digitalTwinModelId',
    'digital_twin_model_spec_uri': :'digitalTwinModelSpecUri',
    'display_name': :'displayName',
    'description': :'description',
    'inbound_envelope': :'inboundEnvelope',
    'inbound_routes': :'inboundRoutes',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 118

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'iot_domain_id': :'String',
    'digital_twin_model_id': :'String',
    'digital_twin_model_spec_uri': :'String',
    'display_name': :'String',
    'description': :'String',
    'inbound_envelope': :'OCI::Iot::Models::DigitalTwinAdapterInboundEnvelope',
    'inbound_routes': :'Array<OCI::Iot::Models::DigitalTwinAdapterInboundRoute>',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 262

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

  self.class == other.class &&
    id == other.id &&
    iot_domain_id == other.iot_domain_id &&
    digital_twin_model_id == other.digital_twin_model_id &&
    digital_twin_model_spec_uri == other.digital_twin_model_spec_uri &&
    display_name == other.display_name &&
    description == other.description &&
    inbound_envelope == other.inbound_envelope &&
    inbound_routes == other.inbound_routes &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 305

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


285
286
287
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 285

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



294
295
296
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 294

def hash
  [id, iot_domain_id, digital_twin_model_id, digital_twin_model_spec_uri, display_name, description, inbound_envelope, inbound_routes, lifecycle_state, freeform_tags, defined_tags, system_tags, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 338

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



332
333
334
 
# File 'lib/oci/iot/models/digital_twin_adapter.rb', line 332

def to_s
  to_hash.to_s
end