Class: OCI::ServiceMesh::Models::IngressListenerTlsConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/service_mesh/models/ingress_listener_tls_config.rb

Overview

TLS enforcement config for the ingress listener.

Constant Summary collapse

MODE_ENUM = 
[
  MODE_DISABLED = 'DISABLED'.freeze,
  MODE_PERMISSIVE = 'PERMISSIVE'.freeze,
  MODE_TLS = 'TLS'.freeze,
  MODE_MUTUAL_TLS = 'MUTUAL_TLS'.freeze,
  MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IngressListenerTlsConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 65

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

  self.server_certificate = attributes[:'serverCertificate'] if attributes[:'serverCertificate']

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

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

  self.client_validation = attributes[:'clientValidation'] if attributes[:'clientValidation']

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

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

Instance Attribute Details

#client_validation ⇒ OCI::ServiceMesh::Models::IngressListenerClientValidationConfig

Returns:



32
33
34
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 32

def client_validation
  @client_validation
end

#mode ⇒ String

[Required] DISABLED: Connection can only be plaintext. PERMISSIVE: Connection can be either plaintext or TLS/mTLS. If the clientValidation.trustedCaBundle property is configured for the listener, mTLS is performed and the client's certificates are validated by the gateway. TLS: Connection can only be TLS. MUTUAL_TLS: Connection can only be MTLS.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 26

def mode
  @mode
end

#server_certificate ⇒ OCI::ServiceMesh::Models::TlsCertificate

Returns:



29
30
31
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 29

def server_certificate
  @server_certificate
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'mode': :'mode',
    'server_certificate': :'serverCertificate',
    'client_validation': :'clientValidation'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'mode': :'String',
    'server_certificate': :'OCI::ServiceMesh::Models::TlsCertificate',
    'client_validation': :'OCI::ServiceMesh::Models::IngressListenerClientValidationConfig'
    # 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



106
107
108
109
110
111
112
113
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 106

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

  self.class == other.class &&
    mode == other.mode &&
    server_certificate == other.server_certificate &&
    client_validation == other.client_validation
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 138

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


118
119
120
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 127

def hash
  [mode, server_certificate, client_validation].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 171

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



165
166
167
 
# File 'lib/oci/service_mesh/models/ingress_listener_tls_config.rb', line 165

def to_s
  to_hash.to_s
end