Class: OCI::Iot::Models::CreateDigitalTwinInstanceDetails

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

Overview

The information about new digital twin instance to be created.

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDigitalTwinInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :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_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



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

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


28
29
30
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 28

def auth_id
  @auth_id
end

#connectivity_type ⇒ String

Connectivity type of the digital twin instance

Returns:

  • (String) 


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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


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

def description
  @description
end

#digital_twin_adapter_id ⇒ String

The OCID of the digital twin adapter.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 48

def digital_twin_adapter_id
  @digital_twin_adapter_id
end

#digital_twin_model_id ⇒ String

The OCID of the digital twin model.

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


35
36
37
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 35

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


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

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


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

def gateways
  @gateways
end

#iot_domain_id ⇒ String

[Required] The OCID of the IoT domain.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 20

def iot_domain_id
  @iot_domain_id
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'iot_domain_id': :'iotDomainId',
    'connectivity_type': :'connectivityType',
    '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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'iot_domain_id': :'String',
    'connectivity_type': :'String',
    '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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 225

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

  self.class == other.class &&
    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_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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 266

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


246
247
248
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 255

def hash
  [iot_domain_id, connectivity_type, 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



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/iot/models/create_digital_twin_instance_details.rb', line 299

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



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

def to_s
  to_hash.to_s
end