class OCI::Mysql::Models::DbSystemEndpoint
A particular functional endpoint for access to a DB System, and the properties that apply to it.
Constants
- MODES_ENUM
- STATUS_ENUM
Attributes
The network address of the DB System. @return [String]
[Required] The IP address the DB System is configured to listen on. @return [String]
The access modes from the client that this endpoint supports. @return [Array<String>]
[Required] The port the MySQL instance listens on. @return [Integer]
[Required] The network port where to connect to use this endpoint using the X protocol. @return [Integer]
The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.
@return [String]
Additional information about the current endpoint status. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/mysql/models/db_system_endpoint.rb, line 56 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'hostname': :'hostname', 'ip_address': :'ipAddress', 'port': :'port', 'port_x': :'portX', 'modes': :'modes', 'status': :'status', 'status_details': :'statusDetails' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :hostname The value to assign to the {#hostname} property @option attributes [String] :ip_address The value to assign to the {#ip_address} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [Integer] :port_x The value to assign to the {#port_x} property @option attributes [Array<String>] :modes The value to assign to the {#modes} property @option attributes [String] :status The value to assign to the {#status} property @option attributes [String] :status_details The value to assign to the {#status_details} property
# File lib/oci/mysql/models/db_system_endpoint.rb, line 98 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.hostname = attributes[:'hostname'] if attributes[:'hostname'] self.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress'] raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address'] self.port = attributes[:'port'] if attributes[:'port'] self.port_x = attributes[:'portX'] if attributes[:'portX'] raise 'You cannot provide both :portX and :port_x' if attributes.key?(:'portX') && attributes.key?(:'port_x') self.port_x = attributes[:'port_x'] if attributes[:'port_x'] self.modes = attributes[:'modes'] if attributes[:'modes'] self.status = attributes[:'status'] if attributes[:'status'] self.status_details = attributes[:'statusDetails'] if attributes[:'statusDetails'] raise 'You cannot provide both :statusDetails and :status_details' if attributes.key?(:'statusDetails') && attributes.key?(:'status_details') self.status_details = attributes[:'status_details'] if attributes[:'status_details'] end
Attribute type mapping.
# File lib/oci/mysql/models/db_system_endpoint.rb, line 71 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'hostname': :'String', 'ip_address': :'String', 'port': :'Integer', 'port_x': :'Integer', 'modes': :'Array<String>', 'status': :'String', 'status_details': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/mysql/models/db_system_endpoint.rb, line 171 def ==(other) return true if equal?(other) self.class == other.class && hostname == other.hostname && ip_address == other.ip_address && port == other.port && port_x == other.port_x && modes == other.modes && status == other.status && status_details == other.status_details end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/mysql/models/db_system_endpoint.rb, line 207 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/mysql/models/db_system_endpoint.rb, line 187 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/mysql/models/db_system_endpoint.rb, line 196 def hash [hostname, ip_address, port, port_x, modes, status, status_details].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] modes Object
to be assigned
# File lib/oci/mysql/models/db_system_endpoint.rb, line 135 def modes=(modes) # rubocop:disable Style/ConditionalAssignment if modes.nil? @modes = nil else @modes = modes.collect do |item| if MODES_ENUM.include?(item) item else OCI.logger.debug("Unknown value for 'modes' [#{item}]. Mapping to 'MODES_UNKNOWN_ENUM_VALUE'") if OCI.logger MODES_UNKNOWN_ENUM_VALUE end end end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object
to be assigned
# File lib/oci/mysql/models/db_system_endpoint.rb, line 155 def status=(status) # rubocop:disable Style/ConditionalAssignment if status && !STATUS_ENUM.include?(status) OCI.logger.debug("Unknown value for 'status' [" + status + "]. Mapping to 'STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger @status = STATUS_UNKNOWN_ENUM_VALUE else @status = status end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/mysql/models/db_system_endpoint.rb, line 240 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/mysql/models/db_system_endpoint.rb, line 234 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/mysql/models/db_system_endpoint.rb, line 257 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end