Class: OCI::Iot::Models::DigitalTwinRelationship

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

Overview

A digital twin relationship represents an association between two digital twin instances. It can include properties to describe the nature and context of the association 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 = {}) ⇒ DigitalTwinRelationship

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :content_path (String) —

    The value to assign to the #content_path property

  • :source_digital_twin_instance_id (String) —

    The value to assign to the #source_digital_twin_instance_id property

  • :target_digital_twin_instance_id (String) —

    The value to assign to the #target_digital_twin_instance_id property

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

    The value to assign to the #content 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



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
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 162

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

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

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

  self.source_digital_twin_instance_id = attributes[:'sourceDigitalTwinInstanceId'] if attributes[:'sourceDigitalTwinInstanceId']

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

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

  self.target_digital_twin_instance_id = attributes[:'targetDigitalTwinInstanceId'] if attributes[:'targetDigitalTwinInstanceId']

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

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

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

  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

#content ⇒ Hash<String, Object>

The value(s) of the relationship properties defined in the source digital twin model.

Returns:

  • (Hash<String, Object>) 


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

def content
  @content
end

#content_path ⇒ String

[Required] Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 44

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


77
78
79
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 77

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 39

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


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

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


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

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_relationship.rb', line 26

def id
  @id
end

#iot_domain_id ⇒ String

[Required] The OCID of the IoT domain.

Returns:

  • (String) 


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

def iot_domain_id
  @iot_domain_id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#source_digital_twin_instance_id ⇒ String

[Required] The OCID of source digital twin instance.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 49

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


84
85
86
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 84

def system_tags
  @system_tags
end

#target_digital_twin_instance_id ⇒ String

[Required] The OCID of target digital twin instance.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 53

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


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

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) 


96
97
98
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 96

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'iot_domain_id': :'iotDomainId',
    'display_name': :'displayName',
    'description': :'description',
    'content_path': :'contentPath',
    'source_digital_twin_instance_id': :'sourceDigitalTwinInstanceId',
    'target_digital_twin_instance_id': :'targetDigitalTwinInstanceId',
    'content': :'content',
    '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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'iot_domain_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'content_path': :'String',
    'source_digital_twin_instance_id': :'String',
    'target_digital_twin_instance_id': :'String',
    'content': :'Hash<String, Object>',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    iot_domain_id == other.iot_domain_id &&
    display_name == other.display_name &&
    description == other.description &&
    content_path == other.content_path &&
    source_digital_twin_instance_id == other.source_digital_twin_instance_id &&
    target_digital_twin_instance_id == other.target_digital_twin_instance_id &&
    content == other.content &&
    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



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

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


284
285
286
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 284

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



293
294
295
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 293

def hash
  [id, iot_domain_id, display_name, description, content_path, source_digital_twin_instance_id, target_digital_twin_instance_id, content, 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



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

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



331
332
333
 
# File 'lib/oci/iot/models/digital_twin_relationship.rb', line 331

def to_s
  to_hash.to_s
end