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
RUNTIME_IDENTITY_ENUM = 
[
  RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL = 'AUTHENTICATED_PRINCIPAL'.freeze,
  RUNTIME_IDENTITY_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'.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):



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 130

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

  self.runtime_identity = attributes[:'runtimeIdentity'] if attributes[:'runtimeIdentity']
  self.runtime_identity = "AUTHENTICATED_PRINCIPAL" if runtime_identity.nil? && !attributes.key?(:'runtimeIdentity') # rubocop:disable Style/StringLiterals

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<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>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<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>) 


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

def freeform_tags
  @freeform_tags
end

#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#runtime_identity ⇒ String

Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the calleru2019s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the connectionu2019s resource principal (RPST).

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 64

def runtime_identity
  @runtime_identity
end

#runtime_support ⇒ String

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

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 59

def runtime_support
  @runtime_support
end

#type ⇒ String

[Required] The Database Tools connection type.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 67

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',
    'runtime_identity': :'runtimeIdentity'
    # 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.



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 103

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_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 83

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',
    'runtime_identity': :'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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 212

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 &&
    runtime_identity == other.runtime_identity
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 249

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


229
230
231
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 229

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 238

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 282

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



276
277
278
 
# File 'lib/oci/database_tools/models/create_database_tools_connection_details.rb', line 276

def to_s
  to_hash.to_s
end