Class: OCI::DatabaseMigration::Models::CreateConnectDescriptor

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/create_connect_descriptor.rb

Overview

Connect Descriptor details. Required for Manual and UserManagerOci connection types. If a Private Endpoint was specified for the Connection, the host should contain a valid IP address.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateConnectDescriptor

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :host (String) —

    The value to assign to the #host property

  • :port (Integer) —

    The value to assign to the #port property

  • :database_service_name (String) —

    The value to assign to the #database_service_name property

  • :connect_string (String) —

    The value to assign to the #connect_string property



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 71

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

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

  self.database_service_name = attributes[:'databaseServiceName'] if attributes[:'databaseServiceName']

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

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

  self.connect_string = attributes[:'connectString'] if attributes[:'connectString']

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

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

Instance Attribute Details

#connect_string ⇒ String

Connect String. Required if no host, port nor databaseServiceName were specified. If a Private Endpoint was specified in the Connection, the host entry should be a valid IP address. Supported formats: Easy connect: <host>:<port>/<db_service_name> Long format: (description= (address=(port=<port>)(host=<host>))(connect_data=(service_name=<db_service_name>)))

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 35

def connect_string
  @connect_string
end

#database_service_name ⇒ String

Database service name. Required if no connectString was specified.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 26

def database_service_name
  @database_service_name
end

#host ⇒ String

Host or IP address of the connect descriptor. Required if no connectString was specified.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 16

def host
  @host
end

#port ⇒ Integer

Port of the connect descriptor. Required if no connectString was specified.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 21

def port
  @port
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'host': :'host',
    'port': :'port',
    'database_service_name': :'databaseServiceName',
    'connect_string': :'connectString'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'host': :'String',
    'port': :'Integer',
    'database_service_name': :'String',
    'connect_string': :'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



101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 101

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

  self.class == other.class &&
    host == other.host &&
    port == other.port &&
    database_service_name == other.database_service_name &&
    connect_string == other.connect_string
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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 134

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


114
115
116
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 123

def hash
  [host, port, database_service_name, connect_string].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 167

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



161
162
163
 
# File 'lib/oci/database_migration/models/create_connect_descriptor.rb', line 161

def to_s
  to_hash.to_s
end