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.

Instance Attribute 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):



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 40

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}

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

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

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

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

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

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

  unless attributes[:'verifyPeerCertificate'].nil?
    self.verify_peer_certificate = attributes[:'verifyPeerCertificate']
  else
    self.verify_peer_certificate = false
  end

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

  unless attributes[:'verify_peer_certificate'].nil?
    self.verify_peer_certificate = attributes[:'verify_peer_certificate']
  else
    self.verify_peer_certificate = false
  end

end

Instance Attribute Details

#certificate_name ⇒ String

[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: ‘My_certificate_bundle`

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 18

def certificate_name
  @certificate_name
end

#verify_depth ⇒ Integer

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

Example: ‘3`

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 25

def verify_depth
  @verify_depth
end

#verify_peer_certificate ⇒ BOOLEAN

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

Example: ‘true`

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 32

def verify_peer_certificate
  @verify_peer_certificate
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



84
85
86
87
88
89
90
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 84

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      certificate_name == other_object.certificate_name &&
      verify_depth == other_object.verify_depth &&
      verify_peer_certificate == other_object.verify_peer_certificate
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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 107

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


94
95
96
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 94

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



100
101
102
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 100

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 132

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



126
127
128
 
# File 'lib/oci/load_balancer/models/ssl_configuration.rb', line 126

def to_s
  to_hash.to_s
end