Class: OCI::Database::Models::DbNode

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

Overview

A server where Oracle Database software is running.

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

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =

rubocop:disable Metrics/LineLength

[
  LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze,
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_STOPPING = 'STOPPING'.freeze,
  LIFECYCLE_STATE_STOPPED = 'STOPPED'.freeze,
  LIFECYCLE_STATE_STARTING = 'STARTING'.freeze,
  LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.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 = {}) ⇒ DbNode

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :backup_vnic_id (String) —

    The value to assign to the #backup_vnic_id property

  • :db_system_id (String) —

    The value to assign to the #db_system_id property

  • :hostname (String) —

    The value to assign to the #hostname property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :software_storage_size_in_gb (Integer) —

    The value to assign to the #software_storage_size_in_gb property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :vnic_id (String) —

    The value to assign to the #vnic_id property



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
149
150
151
152
 
# File 'lib/oci/database/models/db_node.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#backup_vnic_id ⇒ String

The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the backup VNIC.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database/models/db_node.rb', line 30

def backup_vnic_id
  @backup_vnic_id
end

#db_system_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the DB system.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database/models/db_node.rb', line 34

def db_system_id
  @db_system_id
end

#hostname ⇒ String

The host name for the database node.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database/models/db_node.rb', line 38

def hostname
  @hostname
end

#id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the database node.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database/models/db_node.rb', line 42

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the database node.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database/models/db_node.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#software_storage_size_in_gb ⇒ Integer

The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.

Returns:

  • (Integer) 


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

def software_storage_size_in_gb
  @software_storage_size_in_gb
end

#time_created ⇒ DateTime

[Required] The date and time that the database node was created.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#vnic_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the VNIC.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database/models/db_node.rb', line 59

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/database/models/db_node.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'backup_vnic_id': :'backupVnicId',
    'db_system_id': :'dbSystemId',
    'hostname': :'hostname',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'software_storage_size_in_gb': :'softwareStorageSizeInGB',
    'time_created': :'timeCreated',
    'vnic_id': :'vnicId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/database/models/db_node.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'backup_vnic_id': :'String',
    'db_system_id': :'String',
    'hostname': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'software_storage_size_in_gb': :'Integer',
    'time_created': :'DateTime',
    'vnic_id': :'String'
    # 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



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/database/models/db_node.rb', line 176

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

  self.class == other.class &&
    backup_vnic_id == other.backup_vnic_id &&
    db_system_id == other.db_system_id &&
    hostname == other.hostname &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    software_storage_size_in_gb == other.software_storage_size_in_gb &&
    time_created == other.time_created &&
    vnic_id == other.vnic_id
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/database/models/db_node.rb', line 213

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


193
194
195
 
# File 'lib/oci/database/models/db_node.rb', line 193

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/oci/database/models/db_node.rb', line 202

def hash
  [backup_vnic_id, db_system_id, hostname, id, lifecycle_state, software_storage_size_in_gb, time_created, vnic_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/database/models/db_node.rb', line 246

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



240
241
242
 
# File 'lib/oci/database/models/db_node.rb', line 240

def to_s
  to_hash.to_s
end