Class: OCI::DataSafe::Models::TargetDatabase

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

Overview

The details of the Data Safe target database.

Constant Summary collapse

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 = {}) ⇒ TargetDatabase

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/data_safe/models/target_database.rb', line 170

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

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

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

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

  self.tls_config = attributes[:'tlsConfig'] if attributes[:'tlsConfig']

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

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

  self.connection_option = attributes[:'connectionOption'] if attributes[:'connectionOption']

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

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

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

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

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

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


55
56
57
 
# File 'lib/oci/data_safe/models/target_database.rb', line 55

def associated_resource_ids
  @associated_resource_ids
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_safe/models/target_database.rb', line 26

def compartment_id
  @compartment_id
end

#connection_option ⇒ OCI::DataSafe::Models::ConnectionOption

Returns:



51
52
53
 
# File 'lib/oci/data_safe/models/target_database.rb', line 51

def connection_option
  @connection_option
end

#credentials ⇒ OCI::DataSafe::Models::Credentials

Returns:



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

def credentials
  @credentials
end

#database_details ⇒ OCI::DataSafe::Models::DatabaseDetails

This attribute is required.

Returns:



42
43
44
 
# File 'lib/oci/data_safe/models/target_database.rb', line 42

def database_details
  @database_details
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>>) 


89
90
91
 
# File 'lib/oci/data_safe/models/target_database.rb', line 89

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the target database in Data Safe.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_safe/models/target_database.rb', line 38

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_safe/models/target_database.rb', line 34

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


82
83
84
 
# File 'lib/oci/data_safe/models/target_database.rb', line 82

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_safe/models/target_database.rb', line 30

def id
  @id
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/data_safe/models/target_database.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/data_safe/models/target_database.rb', line 59

def lifecycle_state
  @lifecycle_state
end

#peer_target_databases ⇒ Array<OCI::DataSafe::Models::PeerTargetDatabase>

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

Returns:



75
76
77
 
# File 'lib/oci/data_safe/models/target_database.rb', line 75

def peer_target_databases
  @peer_target_databases
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>>) 


95
96
97
 
# File 'lib/oci/data_safe/models/target_database.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time of the target database registration and creation in Data Safe.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/data_safe/models/target_database.rb', line 67

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time of the target database update in Data Safe.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/data_safe/models/target_database.rb', line 71

def time_updated
  @time_updated
end

#tls_config ⇒ OCI::DataSafe::Models::TlsConfig

Returns:



48
49
50
 
# File 'lib/oci/data_safe/models/target_database.rb', line 48

def tls_config
  @tls_config
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'database_details': :'databaseDetails',
    'credentials': :'credentials',
    'tls_config': :'tlsConfig',
    'connection_option': :'connectionOption',
    'associated_resource_ids': :'associatedResourceIds',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'peer_target_databases': :'peerTargetDatabases',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/data_safe/models/target_database.rb', line 123

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'database_details': :'OCI::DataSafe::Models::DatabaseDetails',
    'credentials': :'OCI::DataSafe::Models::Credentials',
    'tls_config': :'OCI::DataSafe::Models::TlsConfig',
    'connection_option': :'OCI::DataSafe::Models::ConnectionOption',
    'associated_resource_ids': :'Array<String>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'peer_target_databases': :'Array<OCI::DataSafe::Models::PeerTargetDatabase>',
    '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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/data_safe/models/target_database.rb', line 287

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 &&
    database_details == other.database_details &&
    credentials == other.credentials &&
    tls_config == other.tls_config &&
    connection_option == other.connection_option &&
    associated_resource_ids == other.associated_resource_ids &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    peer_target_databases == other.peer_target_databases &&
    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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/data_safe/models/target_database.rb', line 333

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



322
323
324
 
# File 'lib/oci/data_safe/models/target_database.rb', line 322

def hash
  [compartment_id, id, display_name, description, database_details, credentials, tls_config, connection_option, associated_resource_ids, lifecycle_state, lifecycle_details, time_created, time_updated, peer_target_databases, 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



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/data_safe/models/target_database.rb', line 366

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



360
361
362
 
# File 'lib/oci/data_safe/models/target_database.rb', line 360

def to_s
  to_hash.to_s
end