Class: OCI::Database::Models::DatabaseSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/database_summary.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_UPDATING = 'UPDATING',
LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
LIFECYCLE_STATE_RESTORE_FAILED = 'RESTORE_FAILED',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
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
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/database/models/database_summary.rb', line 73

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}

  if attributes[:'characterSet']
    self.character_set = attributes[:'characterSet']
  end

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

  if attributes[:'dbBackupConfig']
    self.db_backup_config = attributes[:'dbBackupConfig']
  end

  if attributes[:'dbHomeId']
    self.db_home_id = attributes[:'dbHomeId']
  end

  if attributes[:'dbName']
    self.db_name = attributes[:'dbName']
  end

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

  if attributes[:'dbWorkload']
    self.db_workload = attributes[:'dbWorkload']
  end

  if attributes[:'id']
    self.id = attributes[:'id']
  end

  if attributes[:'lifecycleDetails']
    self.lifecycle_details = attributes[:'lifecycleDetails']
  end

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

  if attributes[:'ncharacterSet']
    self.ncharacter_set = attributes[:'ncharacterSet']
  end

  if attributes[:'pdbName']
    self.pdb_name = attributes[:'pdbName']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

end

Instance Attribute Details

#character_set ⇒ String

The character set for the database.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database/models/database_summary.rb', line 20

def character_set
  @character_set
end

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database/models/database_summary.rb', line 24

def compartment_id
  @compartment_id
end

#db_backup_config ⇒ OCI::Database::Models::DbBackupConfig

Returns:



27
28
29
 
# File 'lib/oci/database/models/database_summary.rb', line 27

def db_backup_config
  @db_backup_config
end

#db_home_id ⇒ String

The OCID of the database home.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database/models/database_summary.rb', line 31

def db_home_id
  @db_home_id
end

#db_name ⇒ String

The database name.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database/models/database_summary.rb', line 35

def db_name
  @db_name
end

#db_unique_name ⇒ String

A system-generated name for the database to ensure uniqueness within an Oracle Data Guard group (a primary database and its standby databases). The unique name cannot be changed.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/database_summary.rb', line 40

def db_unique_name
  @db_unique_name
end

#db_workload ⇒ String

Database workload type.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database/models/database_summary.rb', line 44

def db_workload
  @db_workload
end

#id ⇒ String

The OCID of the database.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database/models/database_summary.rb', line 48

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycleState.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database/models/database_summary.rb', line 52

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the database.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database/models/database_summary.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#ncharacter_set ⇒ String

The national character set for the database.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database/models/database_summary.rb', line 60

def ncharacter_set
  @ncharacter_set
end

#pdb_name ⇒ String

Pluggable database name. It must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database/models/database_summary.rb', line 64

def pdb_name
  @pdb_name
end

#time_created ⇒ DateTime

The date and time the database was created.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/database/models/database_summary.rb', line 68

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/database/models/database_summary.rb', line 145

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      character_set == other_object.character_set &&
      compartment_id == other_object.compartment_id &&
      db_backup_config == other_object.db_backup_config &&
      db_home_id == other_object.db_home_id &&
      db_name == other_object.db_name &&
      db_unique_name == other_object.db_unique_name &&
      db_workload == other_object.db_workload &&
      id == other_object.id &&
      lifecycle_details == other_object.lifecycle_details &&
      lifecycle_state == other_object.lifecycle_state &&
      ncharacter_set == other_object.ncharacter_set &&
      pdb_name == other_object.pdb_name &&
      time_created == other_object.time_created
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/database/models/database_summary.rb', line 178

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/oci/database/models/database_summary.rb', line 165

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/database/models/database_summary.rb', line 171

def hash
  [character_set, compartment_id, db_backup_config, db_home_id, db_name, db_unique_name, db_workload, id, lifecycle_details, lifecycle_state, ncharacter_set, pdb_name, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/database/models/database_summary.rb', line 203

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



197
198
199
 
# File 'lib/oci/database/models/database_summary.rb', line 197

def to_s
  to_hash.to_s
end