Class: OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/create_database_tools_connection_details.rb

Overview

Details for the new Database Tools connection. 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

TYPE_ENUM =
[
  TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze,
  TYPE_MYSQL = 'MYSQL'.freeze,
  TYPE_POSTGRESQL = 'POSTGRESQL'.freeze,
  TYPE_GENERIC_JDBC = 'GENERIC_JDBC'.freeze
].freeze
RUNTIME_SUPPORT_ENUM =
[
  RUNTIME_SUPPORT_SUPPORTED = 'SUPPORTED'.freeze,
  RUNTIME_SUPPORT_UNSUPPORTED = 'UNSUPPORTED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
153
154
155
156
157
158
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 117

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

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

  self.runtime_support = attributes[:'runtimeSupport'] if attributes[:'runtimeSupport']
  self.runtime_support = "SUPPORTED" if runtime_support.nil? && !attributes.key?(:'runtimeSupport') # rubocop:disable Style/StringLiterals

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

  self.runtime_support = attributes[:'runtime_support'] if attributes[:'runtime_support']
  self.runtime_support = "SUPPORTED" if runtime_support.nil? && !attributes.key?(:'runtimeSupport') && !attributes.key?(:'runtime_support') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#compartment_idString

[Required] The OCID of the compartment containing the Database Tools connection.

Returns:

  • (String)


30
31
32
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 30

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


36
37
38
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 36

def defined_tags
  @defined_tags
end

#display_nameString

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


26
27
28
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 26

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>)


42
43
44
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 42

def freeform_tags
  @freeform_tags
end

#locksArray<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.



46
47
48
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 46

def locks
  @locks
end

#runtime_supportString

Specifies whether this connection is supported by the Database Tools Runtime.

Returns:

  • (String)


54
55
56
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 54

def runtime_support
  @runtime_support
end

#typeString

[Required] The DatabaseToolsConnection type.

Returns:

  • (String)


50
51
52
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 50

def type
  @type
end

Class Method Details

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'locks': :'locks',
    'type': :'type',
    'runtime_support': :'runtimeSupport'
    # 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.



91
92
93
94
95
96
97
98
99
100
101
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 91

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

  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionGenericJdbcDetails' if type == 'GENERIC_JDBC'
  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionPostgresqlDetails' if type == 'POSTGRESQL'
  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionMySqlDetails' if type == 'MYSQL'
  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsConnectionOracleDatabaseDetails' if type == 'ORACLE_DATABASE'

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

.swagger_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'type': :'String',
    'runtime_support': :'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



183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 183

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    locks == other.locks &&
    type == other.type &&
    runtime_support == other.runtime_support
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 219

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


199
200
201
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 199

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



208
209
210
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 208

def hash
  [display_name, compartment_id, defined_tags, freeform_tags, locks, type, runtime_support].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 252

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



246
247
248
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 246

def to_s
  to_hash.to_s
end