Class: OCI::Database::Models::DbHomeSummary

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

Overview

A directory where Oracle database software is installed. Each DB System can have multiple database homes, and each database home can have multiple databases within it. All the databases within a single database home must be the same database version, but different database homes can run different versions. For more information, see [Managing Oracle Databases](docs.us-phoenix-1.oraclecloud.com/Content/Database/Concepts/overview.htm).

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](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbHomeSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :db_system_id (String) —

    The value to assign to the #db_system_id property

  • :db_version (String) —

    The value to assign to the #db_version property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :last_patch_history_entry_id (String) —

    The value to assign to the #last_patch_history_entry_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



68
69
70
71
72
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/database/models/db_home_summary.rb', line 68

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[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'dbSystemId']
    self.db_system_id = attributes[:'dbSystemId']
  end

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

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

  if attributes[:'dbVersion']
    self.db_version = attributes[:'dbVersion']
  end

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

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

  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end

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

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

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

  if attributes[:'lastPatchHistoryEntryId']
    self.last_patch_history_entry_id = attributes[:'lastPatchHistoryEntryId']
  end

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#db_system_id ⇒ String

The OCID of the DB System.

Returns:

  • (String) 


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

def db_system_id
  @db_system_id
end

#db_version ⇒ String

[Required] The Oracle database version.

Returns:

  • (String) 


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

def db_version
  @db_version
end

#display_name ⇒ String

[Required] The user-provided name for the database home. It does not need to be unique.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/database/models/db_home_summary.rb', line 39

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the database home.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database/models/db_home_summary.rb', line 43

def id
  @id
end

#last_patch_history_entry_id ⇒ String

The OCID of the last patch history. This is updated as soon as a patch operation is started.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/database/models/db_home_summary.rb', line 47

def last_patch_history_entry_id
  @last_patch_history_entry_id
end

#lifecycle_state ⇒ String

[Required] The current state of the database home.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/database/models/db_home_summary.rb', line 51

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the database home was created.

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/database/models/db_home_summary.rb', line 55

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



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/database/models/db_home_summary.rb', line 162

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      db_system_id == other_object.db_system_id &&
      db_version == other_object.db_version &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      last_patch_history_entry_id == other_object.last_patch_history_entry_id &&
      lifecycle_state == other_object.lifecycle_state &&
      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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/database/models/db_home_summary.rb', line 190

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


177
178
179
 
# File 'lib/oci/database/models/db_home_summary.rb', line 177

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/oci/database/models/db_home_summary.rb', line 183

def hash
  [compartment_id, db_system_id, db_version, display_name, id, last_patch_history_entry_id, lifecycle_state, 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



215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/database/models/db_home_summary.rb', line 215

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



209
210
211
 
# File 'lib/oci/database/models/db_home_summary.rb', line 209

def to_s
  to_hash.to_s
end