Class: OCI::Iot::Models::IotDomainGroup

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

Overview

An IoT domain group is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing IoT domains, within a compartment.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_PRODUCTION = 'PRODUCTION'.freeze,
  TYPE_DEVELOPMENT = 'DEVELOPMENT'.freeze,
  TYPE_STANDARD = 'STANDARD'.freeze,
  TYPE_LIGHTWEIGHT = 'LIGHTWEIGHT'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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 = {}) ⇒ IotDomainGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :type (String) —

    The value to assign to the #type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :data_host (String) —

    The value to assign to the #data_host property

  • :db_allow_listed_vcn_ids (Array<String>) —

    The value to assign to the #db_allow_listed_vcn_ids property

  • :db_connection_string (String) —

    The value to assign to the #db_connection_string property

  • :db_token_scope (String) —

    The value to assign to the #db_token_scope property

  • :lifecycle_state (String) —

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

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

    The value to assign to the #system_tags property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



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
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 183

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.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.type = attributes[:'type'] if attributes[:'type']
  self.type = "DEVELOPMENT" if type.nil? && !attributes.key?(:'type') # rubocop:disable Style/StringLiterals

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

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

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

  self.db_allow_listed_vcn_ids = attributes[:'dbAllowListedVcnIds'] if attributes[:'dbAllowListedVcnIds']

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

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

  self.db_connection_string = attributes[:'dbConnectionString'] if attributes[:'dbConnectionString']

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

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

  self.db_token_scope = attributes[:'dbTokenScope'] if attributes[:'dbTokenScope']

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

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

  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) 


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

def compartment_id
  @compartment_id
end

#data_host ⇒ String

The host name of the database corresponding to the IoT Domain group.

Returns:

  • (String) 


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

def data_host
  @data_host
end

#db_allow_listed_vcn_ids ⇒ Array<String>

This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host.

Returns:

  • (Array<String>) 


67
68
69
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 67

def db_allow_listed_vcn_ids
  @db_allow_listed_vcn_ids
end

#db_connection_string ⇒ String

The connection string used to connect to the data host associated with the IoT domain group.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 71

def db_connection_string
  @db_connection_string
end

#db_token_scope ⇒ String

The token scope used to connect to the data host associated with the IoT domain group.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 75

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the resource.

Returns:

  • (String) 


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

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


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

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


87
88
89
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 87

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of an IoT Domain Group.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 79

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


102
103
104
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 102

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) 


108
109
110
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 108

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) 


114
115
116
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 114

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Type of domain group. DEVELOPMENT uses fewer resources and has a higher Recovery Time Objective (RTO), making it suitable for development and testing. PRODUCTION is recommended for production workloads. LIGHTWEIGHT and STANDARD are deprecated aliases for DEVELOPMENT and PRODUCTION respectively and will be removed in a future release.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 50

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'display_name': :'displayName',
    'description': :'description',
    'data_host': :'dataHost',
    'db_allow_listed_vcn_ids': :'dbAllowListedVcnIds',
    'db_connection_string': :'dbConnectionString',
    'db_token_scope': :'dbTokenScope',
    '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.



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/iot_domain_group.rb', line 140

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'type': :'String',
    'display_name': :'String',
    'description': :'String',
    'data_host': :'String',
    'db_allow_listed_vcn_ids': :'Array<String>',
    'db_connection_string': :'String',
    'db_token_scope': :'String',
    '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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 302

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    display_name == other.display_name &&
    description == other.description &&
    data_host == other.data_host &&
    db_allow_listed_vcn_ids == other.db_allow_listed_vcn_ids &&
    db_connection_string == other.db_connection_string &&
    db_token_scope == other.db_token_scope &&
    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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 346

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


326
327
328
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 335

def hash
  [id, compartment_id, type, display_name, description, data_host, db_allow_listed_vcn_ids, db_connection_string, db_token_scope, 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



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 379

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



373
374
375
 
# File 'lib/oci/iot/models/iot_domain_group.rb', line 373

def to_s
  to_hash.to_s
end