Class: OCI::Iot::Models::DigitalTwinInstance

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

Overview

A digital twin instance is a virtual representation of a physical IoT device 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

CONNECTIVITY_TYPE_ENUM = 
[
  CONNECTIVITY_TYPE_DIRECT = 'DIRECT'.freeze,
  CONNECTIVITY_TYPE_INDIRECT = 'INDIRECT'.freeze,
  CONNECTIVITY_TYPE_GATEWAY = 'GATEWAY'.freeze,
  CONNECTIVITY_TYPE_NONE = 'NONE'.freeze,
  CONNECTIVITY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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 = {}) ⇒ DigitalTwinInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :iot_domain_id (String) —

    The value to assign to the #iot_domain_id property

  • :connectivity_type (String) —

    The value to assign to the #connectivity_type property

  • :auth_id (String) —

    The value to assign to the #auth_id property

  • :external_key (String) —

    The value to assign to the #external_key property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :digital_twin_model_id (String) —

    The value to assign to the #digital_twin_model_id property

  • :digital_twin_model_spec_uri (String) —

    The value to assign to the #digital_twin_model_spec_uri property

  • :digital_twin_adapter_id (String) —

    The value to assign to the #digital_twin_adapter_id property

  • :gateways (Array<String>) —

    The value to assign to the #gateways property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 192

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.connectivity_type = attributes[:'connectivityType'] if attributes[:'connectivityType']
  self.connectivity_type = "DIRECT" if connectivity_type.nil? && !attributes.key?(:'connectivityType') # rubocop:disable Style/StringLiterals

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

  self.connectivity_type = attributes[:'connectivity_type'] if attributes[:'connectivity_type']
  self.connectivity_type = "DIRECT" if connectivity_type.nil? && !attributes.key?(:'connectivityType') && !attributes.key?(:'connectivity_type') # rubocop:disable Style/StringLiterals

  self.auth_id = attributes[:'authId'] if attributes[:'authId']

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

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

  self.external_key = attributes[:'externalKey'] if attributes[:'externalKey']

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

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

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

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

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

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

  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

#auth_id ⇒ String

The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 45

def auth_id
  @auth_id
end

#connectivity_type ⇒ String

[Required] Connectivity type of the digital twin instance

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 41

def connectivity_type
  @connectivity_type
end

#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>>) 


98
99
100
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 98

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 61

def description
  @description
end

#digital_twin_adapter_id ⇒ String

The OCID of the digital twin adapter.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 73

def digital_twin_adapter_id
  @digital_twin_adapter_id
end

#digital_twin_model_id ⇒ String

The OCID of the digital twin model.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 65

def digital_twin_model_id
  @digital_twin_model_id
end

#digital_twin_model_spec_uri ⇒ String

The URI of the digital twin model specification.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 69

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) 


56
57
58
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 56

def display_name
  @display_name
end

#external_key ⇒ String

A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance. This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.

Returns:

  • (String) 


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

def external_key
  @external_key
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>) 


90
91
92
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 90

def freeform_tags
  @freeform_tags
end

#gateways ⇒ Array<String>

An array of unique ids (OCIDs) of the IoT digital twin instances with connectivityType equals to GATEWAY.

Returns:

  • (Array<String>) 


78
79
80
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 78

def gateways
  @gateways
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 33

def id
  @id
end

#iot_domain_id ⇒ String

[Required] The OCID of the IoT domain.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 37

def iot_domain_id
  @iot_domain_id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 82

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


105
106
107
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 105

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) 


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

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) 


117
118
119
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 117

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'iot_domain_id': :'iotDomainId',
    'connectivity_type': :'connectivityType',
    'auth_id': :'authId',
    'external_key': :'externalKey',
    'display_name': :'displayName',
    'description': :'description',
    'digital_twin_model_id': :'digitalTwinModelId',
    'digital_twin_model_spec_uri': :'digitalTwinModelSpecUri',
    'digital_twin_adapter_id': :'digitalTwinAdapterId',
    'gateways': :'gateways',
    '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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 145

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'iot_domain_id': :'String',
    'connectivity_type': :'String',
    'auth_id': :'String',
    'external_key': :'String',
    'display_name': :'String',
    'description': :'String',
    'digital_twin_model_id': :'String',
    'digital_twin_model_spec_uri': :'String',
    'digital_twin_adapter_id': :'String',
    'gateways': :'Array<String>',
    '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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 324

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

  self.class == other.class &&
    id == other.id &&
    iot_domain_id == other.iot_domain_id &&
    connectivity_type == other.connectivity_type &&
    auth_id == other.auth_id &&
    external_key == other.external_key &&
    display_name == other.display_name &&
    description == other.description &&
    digital_twin_model_id == other.digital_twin_model_id &&
    digital_twin_model_spec_uri == other.digital_twin_model_spec_uri &&
    digital_twin_adapter_id == other.digital_twin_adapter_id &&
    gateways == other.gateways &&
    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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 370

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


350
351
352
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 350

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



359
360
361
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 359

def hash
  [id, iot_domain_id, connectivity_type, auth_id, external_key, display_name, description, digital_twin_model_id, digital_twin_model_spec_uri, digital_twin_adapter_id, gateways, 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



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 403

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



397
398
399
 
# File 'lib/oci/iot/models/digital_twin_instance.rb', line 397

def to_s
  to_hash.to_s
end