Class: OCI::LoadBalancer::Models::SSLConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/load_balancer/models/ssl_configuration.rb

Overview

A listener's SSL handling configuration.

To use SSL, a listener must be associated with a Certificate.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SSLConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.verify_peer_certificate = attributes[:'verifyPeerCertificate'] unless attributes[:'verifyPeerCertificate'].nil?
  self.verify_peer_certificate = false if verify_peer_certificate.nil? && !attributes.key?(:'verifyPeerCertificate') # rubocop:disable Style/StringLiterals

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

  self.verify_peer_certificate = attributes[:'verify_peer_certificate'] unless attributes[:'verify_peer_certificate'].nil?
  self.verify_peer_certificate = false if verify_peer_certificate.nil? && !attributes.key?(:'verifyPeerCertificate') && !attributes.key?(:'verify_peer_certificate') # rubocop:disable Style/StringLiterals

  self.verify_depth = attributes[:'verifyDepth'] if attributes[:'verifyDepth']

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

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

Instance Attribute Details

#certificate_nameString

[Required] A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information.

Example: example_certificate_bundle

Returns:

  • (String)


22
23
24
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 22

def certificate_name
  @certificate_name
end

#verify_depthInteger

[Required] The maximum depth for peer certificate chain verification.

Example: 3

Returns:

  • (Integer)


36
37
38
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 36

def verify_depth
  @verify_depth
end

#verify_peer_certificateBOOLEAN

[Required] Whether the load balancer listener should verify peer certificates.

Example: true

Returns:

  • (BOOLEAN)


29
30
31
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 29

def verify_peer_certificate
  @verify_peer_certificate
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_name': :'certificateName',
    'verify_peer_certificate': :'verifyPeerCertificate',
    'verify_depth': :'verifyDepth'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_name': :'String',
    'verify_peer_certificate': :'BOOLEAN',
    'verify_depth': :'Integer'
    # 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



103
104
105
106
107
108
109
110
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 103

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

  self.class == other.class &&
    certificate_name == other.certificate_name &&
    verify_peer_certificate == other.verify_peer_certificate &&
    verify_depth == other.verify_depth
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



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

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


115
116
117
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 115

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



124
125
126
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 124

def hash
  [certificate_name, verify_peer_certificate, verify_depth].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 168

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



162
163
164
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 162

def to_s
  to_hash.to_s
end