Class: OCI::Iot::Models::CreateDigitalTwinAdapterDetails

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

Overview

The information about new digital twin adapter to be created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDigitalTwinAdapterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



105
106
107
108
109
110
111
112
113
114
115
116
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
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 105

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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 31

def description
  @description
end

#digital_twin_model_id ⇒ String

The OCID of the digital twin model.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 18

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) 


22
23
24
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 22

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) 


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

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


46
47
48
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 46

def freeform_tags
  @freeform_tags
end

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

Returns:



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

def inbound_envelope
  @inbound_envelope
end

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

list of inbound routes

Returns:



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

def inbound_routes
  @inbound_routes
end

#iot_domain_id ⇒ String

[Required] The OCID of the IoT domain.

Returns:

  • (String) 


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

def iot_domain_id
  @iot_domain_id
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 74

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 169

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

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 207

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


187
188
189
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 187

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 196

def hash
  [iot_domain_id, digital_twin_model_id, digital_twin_model_spec_uri, display_name, description, inbound_envelope, inbound_routes, 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



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 240

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



234
235
236
 
# File 'lib/oci/iot/models/create_digital_twin_adapter_details.rb', line 234

def to_s
  to_hash.to_s
end