class OCI::DataSafe::Models::TlsConfig

The details required to establish a TLS enabled connection.

Constants

CERTIFICATE_STORE_TYPE_ENUM
STATUS_ENUM

Attributes

certificate_store_type[R]

The format of the certificate store. @return [String]

key_store_content[RW]

Base64 encoded string of key store file content. @return [String]

status[R]

[Required] Status to represent whether the database connection is TLS enabled or not. @return [String]

store_password[RW]

The password to read the trust store and key store files, if they are password protected. @return [String]

trust_store_content[RW]

Base64 encoded string of trust store file content. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_safe/models/tls_config.rb, line 43
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'certificate_store_type': :'certificateStoreType',
    'store_password': :'storePassword',
    'trust_store_content': :'trustStoreContent',
    'key_store_content': :'keyStoreContent'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :status The value to assign to the {#status} property @option attributes [String] :certificate_store_type The value to assign to the {#certificate_store_type} property @option attributes [String] :store_password The value to assign to the {#store_password} property @option attributes [String] :trust_store_content The value to assign to the {#trust_store_content} property @option attributes [String] :key_store_content The value to assign to the {#key_store_content} property

# File lib/oci/data_safe/models/tls_config.rb, line 79
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.status = attributes[:'status'] if attributes[:'status']

  self.certificate_store_type = attributes[:'certificateStoreType'] if attributes[:'certificateStoreType']

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

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

  self.store_password = attributes[:'storePassword'] if attributes[:'storePassword']

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

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

  self.trust_store_content = attributes[:'trustStoreContent'] if attributes[:'trustStoreContent']

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

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

  self.key_store_content = attributes[:'keyStoreContent'] if attributes[:'keyStoreContent']

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

  self.key_store_content = attributes[:'key_store_content'] if attributes[:'key_store_content']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_safe/models/tls_config.rb, line 56
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'certificate_store_type': :'String',
    'store_password': :'String',
    'trust_store_content': :'String',
    'key_store_content': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_safe/models/tls_config.rb, line 145
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    status == other.status &&
    certificate_store_type == other.certificate_store_type &&
    store_password == other.store_password &&
    trust_store_content == other.trust_store_content &&
    key_store_content == other.key_store_content
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_safe/models/tls_config.rb, line 179
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
certificate_store_type=(certificate_store_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] certificate_store_type Object to be assigned

# File lib/oci/data_safe/models/tls_config.rb, line 129
def certificate_store_type=(certificate_store_type)
  # rubocop:disable Style/ConditionalAssignment
  if certificate_store_type && !CERTIFICATE_STORE_TYPE_ENUM.include?(certificate_store_type)
    OCI.logger.debug("Unknown value for 'certificate_store_type' [" + certificate_store_type + "]. Mapping to 'CERTIFICATE_STORE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @certificate_store_type = CERTIFICATE_STORE_TYPE_UNKNOWN_ENUM_VALUE
  else
    @certificate_store_type = certificate_store_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_safe/models/tls_config.rb, line 159
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_safe/models/tls_config.rb, line 168
def hash
  [status, certificate_store_type, store_password, trust_store_content, key_store_content].hash
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/oci/data_safe/models/tls_config.rb, line 116
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
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_safe/models/tls_config.rb, line 212
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_safe/models/tls_config.rb, line 206
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/data_safe/models/tls_config.rb, line 229
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