Class: OCI::Database::Models::EnableDatabaseManagementDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/enable_database_management_details.rb

Overview

Data to enable the Database Management service for the database.

Constant Summary collapse

MANAGEMENT_TYPE_ENUM = 
[
  MANAGEMENT_TYPE_BASIC = 'BASIC'.freeze,
  MANAGEMENT_TYPE_ADVANCED = 'ADVANCED'.freeze
].freeze
PROTOCOL_ENUM = 
[
  PROTOCOL_TCP = 'TCP'.freeze,
  PROTOCOL_TCPS = 'TCPS'.freeze
].freeze
ROLE_ENUM = 
[
  ROLE_SYSDBA = 'SYSDBA'.freeze,
  ROLE_NORMAL = 'NORMAL'.freeze,
  ROLE_SYSDG = 'SYSDG'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnableDatabaseManagementDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
111
112
113
114
115
116
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
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 107

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

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

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

  self.private_end_point_id = attributes[:'privateEndPointId'] if attributes[:'privateEndPointId']

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

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

  self.management_type = attributes[:'managementType'] if attributes[:'managementType']
  self.management_type = "BASIC" if management_type.nil? && !attributes.key?(:'managementType') # rubocop:disable Style/StringLiterals

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

  self.management_type = attributes[:'management_type'] if attributes[:'management_type']
  self.management_type = "BASIC" if management_type.nil? && !attributes.key?(:'managementType') && !attributes.key?(:'management_type') # rubocop:disable Style/StringLiterals

  self.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

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

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

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

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

  self.ssl_secret_id = attributes[:'sslSecretId'] if attributes[:'sslSecretId']

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

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

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

Instance Attribute Details

#credential_details ⇒ OCI::Database::Models::DatabaseCredentialDetails

This attribute is required.

Returns:



30
31
32
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 30

def credential_details
  @credential_details
end

#management_type ⇒ String

The Database Management type.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 39

def management_type
  @management_type
end

#port ⇒ Integer

The port used to connect to the database.

Returns:

  • (Integer) 


51
52
53
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 51

def port
  @port
end

#private_end_point_id ⇒ String

[Required] The OCID of the private endpoint.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 35

def private_end_point_id
  @private_end_point_id
end

#protocol ⇒ String

Protocol used by the database connection.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 47

def protocol
  @protocol
end

#role ⇒ String

The role of the user that will be connecting to the database.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 59

def role
  @role
end

#service_name ⇒ String

[Required] The name of the Oracle Database service that will be used to connect to the database.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 43

def service_name
  @service_name
end

#ssl_secret_id ⇒ String

The OCID of the Oracle Cloud Infrastructure secret.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 55

def ssl_secret_id
  @ssl_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_details': :'credentialDetails',
    'private_end_point_id': :'privateEndPointId',
    'management_type': :'managementType',
    'service_name': :'serviceName',
    'protocol': :'protocol',
    'port': :'port',
    'ssl_secret_id': :'sslSecretId',
    'role': :'role'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_details': :'OCI::Database::Models::DatabaseCredentialDetails',
    'private_end_point_id': :'String',
    'management_type': :'String',
    'service_name': :'String',
    'protocol': :'String',
    'port': :'Integer',
    'ssl_secret_id': :'String',
    'role': :'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



185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 185

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

  self.class == other.class &&
    credential_details == other.credential_details &&
    private_end_point_id == other.private_end_point_id &&
    management_type == other.management_type &&
    service_name == other.service_name &&
    protocol == other.protocol &&
    port == other.port &&
    ssl_secret_id == other.ssl_secret_id &&
    role == other.role
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 222

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


202
203
204
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 202

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 211

def hash
  [credential_details, private_end_point_id, management_type, service_name, protocol, port, ssl_secret_id, role].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 255

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



249
250
251
 
# File 'lib/oci/database/models/enable_database_management_details.rb', line 249

def to_s
  to_hash.to_s
end