Class: OCI::DataSafe::Models::TargetDatabaseSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/target_database_summary.rb

Overview

Summary of a Data Safe target database.

Constant Summary collapse

INFRASTRUCTURE_TYPE_ENUM = 
[
  INFRASTRUCTURE_TYPE_ORACLE_CLOUD = 'ORACLE_CLOUD'.freeze,
  INFRASTRUCTURE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'.freeze,
  INFRASTRUCTURE_TYPE_ON_PREMISES = 'ON_PREMISES'.freeze,
  INFRASTRUCTURE_TYPE_NON_ORACLE_CLOUD = 'NON_ORACLE_CLOUD'.freeze,
  INFRASTRUCTURE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_TYPE_ENUM = 
[
  DATABASE_TYPE_DATABASE_CLOUD_SERVICE = 'DATABASE_CLOUD_SERVICE'.freeze,
  DATABASE_TYPE_AUTONOMOUS_DATABASE = 'AUTONOMOUS_DATABASE'.freeze,
  DATABASE_TYPE_INSTALLED_DATABASE = 'INSTALLED_DATABASE'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ TargetDatabaseSummary

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

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :infrastructure_type (String) —

    The value to assign to the #infrastructure_type property

  • :database_type (String) —

    The value to assign to the #database_type property

  • :associated_resource_ids (Array<String>) —

    The value to assign to the #associated_resource_ids property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

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

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags 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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/data_safe/models/target_database_summary.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.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.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.description = attributes[:'description'] if attributes[:'description']

  self.infrastructure_type = attributes[:'infrastructureType'] if attributes[:'infrastructureType']

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

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

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

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

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

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#associated_resource_ids ⇒ Array<String>

The OCIDs of associated resources like database, Data Safe private endpoint etc.

Returns:

  • (Array<String>) 


65
66
67
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 65

def associated_resource_ids
  @associated_resource_ids
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the Data Safe target database.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 41

def compartment_id
  @compartment_id
end

#database_type ⇒ String

[Required] The database type.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 61

def database_type
  @database_type
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


90
91
92
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 90

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the target database in Data Safe.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 53

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the target database in Data Safe.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 49

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


84
85
86
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 84

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Data Safe target database.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 45

def id
  @id
end

#infrastructure_type ⇒ String

[Required] The infrastructure type the database is running on.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 57

def infrastructure_type
  @infrastructure_type
end

#lifecycle_details ⇒ String

Details about the current state of the target database in Data Safe.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 73

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the target database in Data Safe.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


96
97
98
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 96

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the database was registered in Data Safe and created as a target database in Data Safe.

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 77

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'infrastructure_type': :'infrastructureType',
    'database_type': :'databaseType',
    'associated_resource_ids': :'associatedResourceIds',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'infrastructure_type': :'String',
    'database_type': :'String',
    'associated_resource_ids': :'Array<String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 282

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    infrastructure_type == other.infrastructure_type &&
    database_type == other.database_type &&
    associated_resource_ids == other.associated_resource_ids &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 324

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


304
305
306
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 304

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



313
314
315
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 313

def hash
  [compartment_id, id, display_name, description, infrastructure_type, database_type, associated_resource_ids, lifecycle_state, lifecycle_details, time_created, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
360
361
362
363
364
365
366
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 357

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



351
352
353
 
# File 'lib/oci/data_safe/models/target_database_summary.rb', line 351

def to_s
  to_hash.to_s
end