Class: OCI::DatabaseManagement::Models::DbmResource

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

Overview

The base Exadata resource. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze
].freeze
RESOURCE_TYPE_ENUM = 
[
  RESOURCE_TYPE_INFRASTRUCTURE_SUMMARY = 'INFRASTRUCTURE_SUMMARY'.freeze,
  RESOURCE_TYPE_INFRASTRUCTURE = 'INFRASTRUCTURE'.freeze,
  RESOURCE_TYPE_STORAGE_SERVER_SUMMARY = 'STORAGE_SERVER_SUMMARY'.freeze,
  RESOURCE_TYPE_STORAGE_SERVER = 'STORAGE_SERVER'.freeze,
  RESOURCE_TYPE_STORAGE_GRID_SUMMARY = 'STORAGE_GRID_SUMMARY'.freeze,
  RESOURCE_TYPE_STORAGE_GRID = 'STORAGE_GRID'.freeze,
  RESOURCE_TYPE_STORAGE_CONNECTOR_SUMMARY = 'STORAGE_CONNECTOR_SUMMARY'.freeze,
  RESOURCE_TYPE_STORAGE_CONNECTOR = 'STORAGE_CONNECTOR'.freeze,
  RESOURCE_TYPE_DATABASE_SYSTEM_SUMMARY = 'DATABASE_SYSTEM_SUMMARY'.freeze,
  RESOURCE_TYPE_DATABASE_SUMMARY = 'DATABASE_SUMMARY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DbmResource

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :version (String) —

    The value to assign to the #version property

  • :internal_id (String) —

    The value to assign to the #internal_id property

  • :status (String) —

    The value to assign to the #status 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

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :additional_details (Hash<String, String>) —

    The value to assign to the #additional_details property

  • :resource_type (String) —

    The value to assign to the #resource_type property



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 159

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

  self.internal_id = attributes[:'internalId'] if attributes[:'internalId']

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

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

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

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

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

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

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

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

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

  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']

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

Instance Attribute Details

#additional_details ⇒ Hash<String, String>

The additional details of the resource defined in {\"key\": \"value\"} format. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


75
76
77
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 75

def additional_details
  @additional_details
end

#display_name ⇒ String

[Required] The name of the Exadata resource. English letters, numbers, "-", "_" and "." only.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 41

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the Exadata resource.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 37

def id
  @id
end

#internal_id ⇒ String

The internal ID of the Exadata resource.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 49

def internal_id
  @internal_id
end

#lifecycle_details ⇒ String

The details of the lifecycle state of the Exadata resource.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 69

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current lifecycle state of the database resource.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#resource_type ⇒ String

[Required] The type of Exadata resource.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 79

def resource_type
  @resource_type
end

#status ⇒ String

The status of the Exadata resource.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 53

def status
  @status
end

#time_created ⇒ DateTime

The timestamp of the creation of the Exadata resource.

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 61

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The timestamp of the last update of the Exadata resource.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 65

def time_updated
  @time_updated
end

#version ⇒ String

The version of the Exadata resource.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 45

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'version': :'version',
    'internal_id': :'internalId',
    'status': :'status',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_details': :'lifecycleDetails',
    'additional_details': :'additionalDetails',
    'resource_type': :'resourceType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 124

def self.get_subtype(object_hash)
  type = object_hash[:'resourceType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseManagement::Models::ExternalExadataStorageConnector' if type == 'STORAGE_CONNECTOR'
  return 'OCI::DatabaseManagement::Models::ExternalExadataStorageGridSummary' if type == 'STORAGE_GRID_SUMMARY'
  return 'OCI::DatabaseManagement::Models::ExternalExadataStorageServer' if type == 'STORAGE_SERVER'
  return 'OCI::DatabaseManagement::Models::ExternalExadataInfrastructure' if type == 'INFRASTRUCTURE'
  return 'OCI::DatabaseManagement::Models::ExternalExadataStorageGrid' if type == 'STORAGE_GRID'
  return 'OCI::DatabaseManagement::Models::ExternalExadataInfrastructureSummary' if type == 'INFRASTRUCTURE_SUMMARY'
  return 'OCI::DatabaseManagement::Models::ExternalExadataDatabaseSystemSummary' if type == 'DATABASE_SYSTEM_SUMMARY'
  return 'OCI::DatabaseManagement::Models::ExternalExadataStorageConnectorSummary' if type == 'STORAGE_CONNECTOR_SUMMARY'
  return 'OCI::DatabaseManagement::Models::ExternalExadataStorageServerSummary' if type == 'STORAGE_SERVER_SUMMARY'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseManagement::Models::DbmResource'
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'version': :'String',
    'internal_id': :'String',
    'status': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_details': :'String',
    'additional_details': :'Hash<String, String>',
    'resource_type': :'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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 243

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    version == other.version &&
    internal_id == other.internal_id &&
    status == other.status &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_details == other.lifecycle_details &&
    additional_details == other.additional_details &&
    resource_type == other.resource_type
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 283

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


263
264
265
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 263

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



272
273
274
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 272

def hash
  [id, display_name, version, internal_id, status, lifecycle_state, time_created, time_updated, lifecycle_details, additional_details, resource_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



316
317
318
319
320
321
322
323
324
325
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 316

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



310
311
312
 
# File 'lib/oci/database_management/models/dbm_resource.rb', line 310

def to_s
  to_hash.to_s
end