Class: OCI::Iot::Models::UpdateDigitalTwinInstanceDetails

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

Overview

The information to be updated for the given digital twin instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDigitalTwinInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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_adapter_id (String) —

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

  • :gateways (Array<String>) —

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 117

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

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


14
15
16
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 14

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


63
64
65
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 63

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


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

def description
  @description
end

#digital_twin_adapter_id ⇒ String

The OCID of the digital twin adapter.

Returns:

  • (String) 


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

def digital_twin_adapter_id
  @digital_twin_adapter_id
end

#digital_twin_model_id ⇒ String

The OCID of the digital twin model.

Returns:

  • (String) 


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

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) 


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

def digital_twin_model_spec_uri
  @digital_twin_model_spec_uri
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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


55
56
57
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 55

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


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

def gateways
  @gateways
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'auth_id': :'authId',
    'external_key': :'externalKey',
    'display_name': :'displayName',
    'description': :'description',
    'digital_twin_adapter_id': :'digitalTwinAdapterId',
    'digital_twin_model_id': :'digitalTwinModelId',
    'digital_twin_model_spec_uri': :'digitalTwinModelSpecUri',
    'gateways': :'gateways',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 84

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 183

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

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 222

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


202
203
204
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 211

def hash
  [auth_id, external_key, display_name, description, digital_twin_adapter_id, digital_twin_model_id, digital_twin_model_spec_uri, gateways, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 255

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



249
250
251
 
# File 'lib/oci/iot/models/update_digital_twin_instance_details.rb', line 249

def to_s
  to_hash.to_s
end