Class: OCI::Iot::Models::CreateDigitalTwinModelDetails

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

Overview

The information about new digital twin model to be created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDigitalTwinModelDetails

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

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

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
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/create_digital_twin_model_details.rb', line 85

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

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


43
44
45
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 43

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource. If left blank, the description will be derived from the spec.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 23

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If left blank, the display name will be derived from the spec.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 19

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


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

def freeform_tags
  @freeform_tags
end

#iot_domain_id ⇒ String

[Required] The OCID of the IoT domain.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 13

def iot_domain_id
  @iot_domain_id
end

#spec ⇒ Hash<String, Object>

[Required] The specification of the digital twin model (DTDL).

Returns:

  • (Hash<String, Object>) 


27
28
29
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 27

def spec
  @spec
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'iot_domain_id': :'iotDomainId',
    'display_name': :'displayName',
    'description': :'description',
    'spec': :'spec',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 127

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

  self.class == other.class &&
    iot_domain_id == other.iot_domain_id &&
    display_name == other.display_name &&
    description == other.description &&
    spec == other.spec &&
    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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 162

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


142
143
144
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 151

def hash
  [iot_domain_id, display_name, description, spec, 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



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 195

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



189
190
191
 
# File 'lib/oci/iot/models/create_digital_twin_model_details.rb', line 189

def to_s
  to_hash.to_s
end