Class: OCI::DatabaseManagement::Models::CloudServicedDatabase

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/cloud_serviced_database.rb

Overview

The details of a database serviced by a cloud DB system component such as a listener or ASM.

Constant Summary collapse

DATABASE_TYPE_ENUM = 
[
  DATABASE_TYPE_EXTERNAL_SIDB = 'EXTERNAL_SIDB'.freeze,
  DATABASE_TYPE_EXTERNAL_RAC = 'EXTERNAL_RAC'.freeze,
  DATABASE_TYPE_CLOUD_SIDB = 'CLOUD_SIDB'.freeze,
  DATABASE_TYPE_CLOUD_RAC = 'CLOUD_RAC'.freeze,
  DATABASE_TYPE_SHARED = 'SHARED'.freeze,
  DATABASE_TYPE_DEDICATED = 'DEDICATED'.freeze,
  DATABASE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_SUB_TYPE_ENUM = 
[
  DATABASE_SUB_TYPE_CDB = 'CDB'.freeze,
  DATABASE_SUB_TYPE_PDB = 'PDB'.freeze,
  DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'.freeze,
  DATABASE_SUB_TYPE_ACD = 'ACD'.freeze,
  DATABASE_SUB_TYPE_ADB = 'ADB'.freeze,
  DATABASE_SUB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudServicedDatabase

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

  • :dbaas_id (String) —

    The value to assign to the #dbaas_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :db_unique_name (String) —

    The value to assign to the #db_unique_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :database_type (String) —

    The value to assign to the #database_type property

  • :database_sub_type (String) —

    The value to assign to the #database_sub_type property

  • :is_managed (BOOLEAN) —

    The value to assign to the #is_managed property



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
161
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 112

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

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

  self.dbaas_id = attributes[:'dbaas_id'] if attributes[:'dbaas_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.db_unique_name = attributes[:'dbUniqueName'] if attributes[:'dbUniqueName']

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

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

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

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

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

  self.database_sub_type = attributes[:'databaseSubType'] if attributes[:'databaseSubType']

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

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

  self.is_managed = attributes[:'isManaged'] unless attributes[:'isManaged'].nil?

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

  self.is_managed = attributes[:'is_managed'] unless attributes[:'is_managed'].nil?
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment in which the cloud database resides.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 50

def compartment_id
  @compartment_id
end

#database_sub_type ⇒ String

The subtype of Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 60

def database_sub_type
  @database_sub_type
end

#database_type ⇒ String

The type of Oracle Database installation.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 54

def database_type
  @database_type
end

#db_unique_name ⇒ String

The unique name of the cloud database.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 46

def db_unique_name
  @db_unique_name
end

#dbaas_id ⇒ String

[Required] The OCID of the existing DBaas OCI resource matching the discovered DB system component.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 38

def dbaas_id
  @dbaas_id
end

#display_name ⇒ String

[Required] The user-friendly name for the database. The name does not have to be unique.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 42

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the cloud database.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 34

def id
  @id
end

#is_managed ⇒ BOOLEAN

Indicates whether the database is a Managed Database or not.

Returns:

  • (BOOLEAN) 


64
65
66
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 64

def is_managed
  @is_managed
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'dbaas_id': :'dbaasId',
    'display_name': :'displayName',
    'db_unique_name': :'dbUniqueName',
    'compartment_id': :'compartmentId',
    'database_type': :'databaseType',
    'database_sub_type': :'databaseSubType',
    'is_managed': :'isManaged'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'dbaas_id': :'String',
    'display_name': :'String',
    'db_unique_name': :'String',
    'compartment_id': :'String',
    'database_type': :'String',
    'database_sub_type': :'String',
    'is_managed': :'BOOLEAN'
    # 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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 196

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

  self.class == other.class &&
    id == other.id &&
    dbaas_id == other.dbaas_id &&
    display_name == other.display_name &&
    db_unique_name == other.db_unique_name &&
    compartment_id == other.compartment_id &&
    database_type == other.database_type &&
    database_sub_type == other.database_sub_type &&
    is_managed == other.is_managed
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 233

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


213
214
215
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 213

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 222

def hash
  [id, dbaas_id, display_name, db_unique_name, compartment_id, database_type, database_sub_type, is_managed].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 266

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



260
261
262
 
# File 'lib/oci/database_management/models/cloud_serviced_database.rb', line 260

def to_s
  to_hash.to_s
end