class OCI::DatabaseManagement::Models::ManagedDatabase

The details of a Managed Database.

Constants

DATABASE_STATUS_ENUM
DATABASE_SUB_TYPE_ENUM
DATABASE_TYPE_ENUM

Attributes

additional_details[RW]

The additional details specific to a type of database defined in `{"key": "value"}` format. Example: `{"bar-key": "value"}`

@return [Hash<String, String>]

compartment_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. @return [String]

database_status[R]

The status of the Oracle Database. Indicates whether the status of the database is UP, DOWN, or UNKNOWN at the current time.

@return [String]

database_sub_type[R]

[Required] The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. @return [String]

database_type[R]

[Required] The type of Oracle Database installation. @return [String]

id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database. @return [String]

instance_count[RW]

The number of Oracle Real Application Clusters (Oracle RAC) database instances. @return [Integer]

instance_details[RW]

The details of the Oracle Real Application Clusters (Oracle RAC) database instances. @return [Array<OCI::DatabaseManagement::Models::InstanceDetails>]

is_cluster[RW]

[Required] Indicates whether the Oracle Database is part of a cluster. @return [BOOLEAN]

managed_database_groups[RW]

A list of Managed Database Groups that the Managed Database belongs to. @return [Array<OCI::DatabaseManagement::Models::ParentGroup>]

name[RW]

[Required] The name of the Managed Database. @return [String]

parent_container_compartment_id[RW]

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the parent Container Database resides, if the Managed Database is a Pluggable Database (PDB).

@return [String]

parent_container_id[RW]

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the parent Container Database if Managed Database is a Pluggable Database.

@return [String]

parent_container_name[RW]

The name of the parent Container Database. @return [String]

pdb_count[RW]

The number of PDBs in the Container Database. @return [Integer]

pdb_status[RW]

The status of the PDB in the Container Database. @return [Array<OCI::DatabaseManagement::Models::PdbStatusDetails>]

time_created[RW]

[Required] The date and time the Managed Database was created. @return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/database_management/models/managed_database.rb, line 109
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'database_type': :'databaseType',
    'database_sub_type': :'databaseSubType',
    'is_cluster': :'isCluster',
    'parent_container_id': :'parentContainerId',
    'managed_database_groups': :'managedDatabaseGroups',
    'time_created': :'timeCreated',
    'database_status': :'databaseStatus',
    'parent_container_name': :'parentContainerName',
    'parent_container_compartment_id': :'parentContainerCompartmentId',
    'instance_count': :'instanceCount',
    'instance_details': :'instanceDetails',
    'pdb_count': :'pdbCount',
    'pdb_status': :'pdbStatus',
    'additional_details': :'additionalDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :database_type The value to assign to the {#database_type} property @option attributes [String] :database_sub_type The value to assign to the {#database_sub_type} property @option attributes [BOOLEAN] :is_cluster The value to assign to the {#is_cluster} property @option attributes [String] :parent_container_id The value to assign to the {#parent_container_id} property @option attributes [Array<OCI::DatabaseManagement::Models::ParentGroup>] :managed_database_groups The value to assign to the {#managed_database_groups} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :database_status The value to assign to the {#database_status} property @option attributes [String] :parent_container_name The value to assign to the {#parent_container_name} property @option attributes [String] :parent_container_compartment_id The value to assign to the {#parent_container_compartment_id} property @option attributes [Integer] :instance_count The value to assign to the {#instance_count} property @option attributes [Array<OCI::DatabaseManagement::Models::InstanceDetails>] :instance_details The value to assign to the {#instance_details} property @option attributes [Integer] :pdb_count The value to assign to the {#pdb_count} property @option attributes [Array<OCI::DatabaseManagement::Models::PdbStatusDetails>] :pdb_status The value to assign to the {#pdb_status} property @option attributes [Hash<String, String>] :additional_details The value to assign to the {#additional_details} property

# File lib/oci/database_management/models/managed_database.rb, line 181
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.name = attributes[:'name'] if attributes[:'name']

  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_cluster = attributes[:'isCluster'] unless attributes[:'isCluster'].nil?

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

  self.is_cluster = attributes[:'is_cluster'] unless attributes[:'is_cluster'].nil?

  self.parent_container_id = attributes[:'parentContainerId'] if attributes[:'parentContainerId']

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

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

  self.managed_database_groups = attributes[:'managedDatabaseGroups'] if attributes[:'managedDatabaseGroups']

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

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

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

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

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

  self.parent_container_name = attributes[:'parentContainerName'] if attributes[:'parentContainerName']

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

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

  self.parent_container_compartment_id = attributes[:'parentContainerCompartmentId'] if attributes[:'parentContainerCompartmentId']

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

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

  self.instance_count = attributes[:'instanceCount'] if attributes[:'instanceCount']

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

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

  self.instance_details = attributes[:'instanceDetails'] if attributes[:'instanceDetails']

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

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

  self.pdb_count = attributes[:'pdbCount'] if attributes[:'pdbCount']

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

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

  self.pdb_status = attributes[:'pdbStatus'] if attributes[:'pdbStatus']

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

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

  self.additional_details = attributes[:'additionalDetails'] if attributes[:'additionalDetails']

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

  self.additional_details = attributes[:'additional_details'] if attributes[:'additional_details']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/database_management/models/managed_database.rb, line 134
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'database_type': :'String',
    'database_sub_type': :'String',
    'is_cluster': :'BOOLEAN',
    'parent_container_id': :'String',
    'managed_database_groups': :'Array<OCI::DatabaseManagement::Models::ParentGroup>',
    'time_created': :'DateTime',
    'database_status': :'String',
    'parent_container_name': :'String',
    'parent_container_compartment_id': :'String',
    'instance_count': :'Integer',
    'instance_details': :'Array<OCI::DatabaseManagement::Models::InstanceDetails>',
    'pdb_count': :'Integer',
    'pdb_status': :'Array<OCI::DatabaseManagement::Models::PdbStatusDetails>',
    'additional_details': :'Hash<String, String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/database_management/models/managed_database.rb, line 328
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    database_type == other.database_type &&
    database_sub_type == other.database_sub_type &&
    is_cluster == other.is_cluster &&
    parent_container_id == other.parent_container_id &&
    managed_database_groups == other.managed_database_groups &&
    time_created == other.time_created &&
    database_status == other.database_status &&
    parent_container_name == other.parent_container_name &&
    parent_container_compartment_id == other.parent_container_compartment_id &&
    instance_count == other.instance_count &&
    instance_details == other.instance_details &&
    pdb_count == other.pdb_count &&
    pdb_status == other.pdb_status &&
    additional_details == other.additional_details
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/database_management/models/managed_database.rb, line 374
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
database_status=(database_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] database_status Object to be assigned

# File lib/oci/database_management/models/managed_database.rb, line 312
def database_status=(database_status)
  # rubocop:disable Style/ConditionalAssignment
  if database_status && !DATABASE_STATUS_ENUM.include?(database_status)
    OCI.logger.debug("Unknown value for 'database_status' [" + database_status + "]. Mapping to 'DATABASE_STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @database_status = DATABASE_STATUS_UNKNOWN_ENUM_VALUE
  else
    @database_status = database_status
  end
  # rubocop:enable Style/ConditionalAssignment
end
database_sub_type=(database_sub_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] database_sub_type Object to be assigned

# File lib/oci/database_management/models/managed_database.rb, line 299
def database_sub_type=(database_sub_type)
  # rubocop:disable Style/ConditionalAssignment
  if database_sub_type && !DATABASE_SUB_TYPE_ENUM.include?(database_sub_type)
    OCI.logger.debug("Unknown value for 'database_sub_type' [" + database_sub_type + "]. Mapping to 'DATABASE_SUB_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @database_sub_type = DATABASE_SUB_TYPE_UNKNOWN_ENUM_VALUE
  else
    @database_sub_type = database_sub_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
database_type=(database_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] database_type Object to be assigned

# File lib/oci/database_management/models/managed_database.rb, line 286
def database_type=(database_type)
  # rubocop:disable Style/ConditionalAssignment
  if database_type && !DATABASE_TYPE_ENUM.include?(database_type)
    OCI.logger.debug("Unknown value for 'database_type' [" + database_type + "]. Mapping to 'DATABASE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @database_type = DATABASE_TYPE_UNKNOWN_ENUM_VALUE
  else
    @database_type = database_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/database_management/models/managed_database.rb, line 354
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/database_management/models/managed_database.rb, line 363
def hash
  [id, compartment_id, name, database_type, database_sub_type, is_cluster, parent_container_id, managed_database_groups, time_created, database_status, parent_container_name, parent_container_compartment_id, instance_count, instance_details, pdb_count, pdb_status, additional_details].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/database_management/models/managed_database.rb, line 407
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/database_management/models/managed_database.rb, line 401
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/database_management/models/managed_database.rb, line 424
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end