Class: OCI::Iot::Models::IotDomain

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

Overview

An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group.

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_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ IotDomain

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/iot/models/iot_domain.rb', line 170

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_group_id = attributes[:'iotDomainGroupId'] if attributes[:'iotDomainGroupId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_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.device_host = attributes[:'deviceHost'] if attributes[:'deviceHost']

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

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

  self.db_allow_listed_identity_group_names = attributes[:'dbAllowListedIdentityGroupNames'] if attributes[:'dbAllowListedIdentityGroupNames']

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

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

  self.db_allowed_identity_domain_host = attributes[:'dbAllowedIdentityDomainHost'] if attributes[:'dbAllowedIdentityDomainHost']

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

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

  self.data_retention_periods_in_days = attributes[:'dataRetentionPeriodsInDays'] if attributes[:'dataRetentionPeriodsInDays']

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the compartment corresponding to the resource.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#data_retention_periods_in_days ⇒ OCI::Iot::Models::DataRetentionPeriodsInDays

Returns:



62
63
64
 
# File 'lib/oci/iot/models/iot_domain.rb', line 62

def data_retention_periods_in_days
  @data_retention_periods_in_days
end

#db_allow_listed_identity_group_names ⇒ Array<String>

List of IAM groups of form described in here that are allowed to directly connect to the data host.

Returns:

  • (Array<String>) 


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

def db_allow_listed_identity_group_names
  @db_allow_listed_identity_group_names
end

#db_allowed_identity_domain_host ⇒ String

Host name of identity domain that is used for authenticating connect to data host via ORDS.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/iot/models/iot_domain.rb', line 59

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


82
83
84
 
# File 'lib/oci/iot/models/iot_domain.rb', line 82

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


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

def description
  @description
end

#device_host ⇒ String

Host name of an IoT domain, where IoT devices can connect to.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/iot/models/iot_domain.rb', line 51

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


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

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


74
75
76
 
# File 'lib/oci/iot/models/iot_domain.rb', line 74

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


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

def id
  @id
end

#iot_domain_group_id ⇒ String

[Required] The OCID of the IoT domain group.

Returns:

  • (String) 


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

def iot_domain_group_id
  @iot_domain_group_id
end

#lifecycle_state ⇒ String

[Required] The current state of the IoT domain.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/iot/models/iot_domain.rb', line 66

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


89
90
91
 
# File 'lib/oci/iot/models/iot_domain.rb', line 89

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


95
96
97
 
# File 'lib/oci/iot/models/iot_domain.rb', line 95

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) 


101
102
103
 
# File 'lib/oci/iot/models/iot_domain.rb', line 101

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/iot/models/iot_domain.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'iot_domain_group_id': :'iotDomainGroupId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'device_host': :'deviceHost',
    'db_allow_listed_identity_group_names': :'dbAllowListedIdentityGroupNames',
    'db_allowed_identity_domain_host': :'dbAllowedIdentityDomainHost',
    'data_retention_periods_in_days': :'dataRetentionPeriodsInDays',
    '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.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/iot/models/iot_domain.rb', line 127

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'iot_domain_group_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'device_host': :'String',
    'db_allow_listed_identity_group_names': :'Array<String>',
    'db_allowed_identity_domain_host': :'String',
    'data_retention_periods_in_days': :'OCI::Iot::Models::DataRetentionPeriodsInDays',
    '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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/iot/models/iot_domain.rb', line 279

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

  self.class == other.class &&
    id == other.id &&
    iot_domain_group_id == other.iot_domain_group_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    device_host == other.device_host &&
    db_allow_listed_identity_group_names == other.db_allow_listed_identity_group_names &&
    db_allowed_identity_domain_host == other.db_allowed_identity_domain_host &&
    data_retention_periods_in_days == other.data_retention_periods_in_days &&
    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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/oci/iot/models/iot_domain.rb', line 323

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


303
304
305
 
# File 'lib/oci/iot/models/iot_domain.rb', line 303

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



312
313
314
 
# File 'lib/oci/iot/models/iot_domain.rb', line 312

def hash
  [id, iot_domain_group_id, compartment_id, display_name, description, device_host, db_allow_listed_identity_group_names, db_allowed_identity_domain_host, data_retention_periods_in_days, 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



356
357
358
359
360
361
362
363
364
365
 
# File 'lib/oci/iot/models/iot_domain.rb', line 356

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



350
351
352
 
# File 'lib/oci/iot/models/iot_domain.rb', line 350

def to_s
  to_hash.to_s
end