Class: OCI::Apigateway::Models::MutualTlsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/mutual_tls_details.rb

Overview

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MutualTlsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 48

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.is_verified_certificate_required = attributes[:'isVerifiedCertificateRequired'] unless attributes[:'isVerifiedCertificateRequired'].nil?
  self.is_verified_certificate_required = false if is_verified_certificate_required.nil? && !attributes.key?(:'isVerifiedCertificateRequired') # rubocop:disable Style/StringLiterals

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

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

  self.allowed_sans = attributes[:'allowedSans'] if attributes[:'allowedSans']

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

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

Instance Attribute Details

#allowed_sans ⇒ Array<String>

Allowed list of CN or SAN which will be used for verification of certificate.

Returns:

  • (Array<String>) 


18
19
20
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 18

def allowed_sans
  @allowed_sans
end

#is_verified_certificate_required ⇒ BOOLEAN

Determines whether to enable client verification when API Consumer makes connection to the gateway.

Returns:

  • (BOOLEAN) 


14
15
16
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 14

def is_verified_certificate_required
  @is_verified_certificate_required
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_verified_certificate_required': :'isVerifiedCertificateRequired',
    'allowed_sans': :'allowedSans'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
37
38
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 31

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_verified_certificate_required': :'BOOLEAN',
    'allowed_sans': :'Array<String>'
    # 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



76
77
78
79
80
81
82
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 76

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

  self.class == other.class &&
    is_verified_certificate_required == other.is_verified_certificate_required &&
    allowed_sans == other.allowed_sans
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
123
124
125
126
127
128
129
 
# File 'lib/oci/apigateway/models/mutual_tls_details.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)
        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


87
88
89
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 87

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



96
97
98
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 96

def hash
  [is_verified_certificate_required, allowed_sans].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 140

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



134
135
136
 
# File 'lib/oci/apigateway/models/mutual_tls_details.rb', line 134

def to_s
  to_hash.to_s
end