Class: OCI::ServiceMesh::Models::MutualTransportLayerSecurity

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

Overview

Mutual TLS settings used when communicating with other virtual services or ingress gateways within the mesh.

Constant Summary collapse

MODE_ENUM = 
[
  MODE_DISABLED = 'DISABLED'.freeze,
  MODE_PERMISSIVE = 'PERMISSIVE'.freeze,
  MODE_STRICT = 'STRICT'.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 = {}) ⇒ MutualTransportLayerSecurity

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :certificate_id (String) —

    The value to assign to the #certificate_id property

  • :maximum_validity (Integer) —

    The value to assign to the #maximum_validity property

  • :mode (String) —

    The value to assign to the #mode property



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

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_id = attributes[:'certificateId'] if attributes[:'certificateId']

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

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

  self.maximum_validity = attributes[:'maximumValidity'] if attributes[:'maximumValidity']
  self.maximum_validity = 45 if maximum_validity.nil? && !attributes.key?(:'maximumValidity') # rubocop:disable Style/StringLiterals

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

  self.maximum_validity = attributes[:'maximum_validity'] if attributes[:'maximum_validity']
  self.maximum_validity = 45 if maximum_validity.nil? && !attributes.key?(:'maximumValidity') && !attributes.key?(:'maximum_validity') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#certificate_id ⇒ String

[Required] The OCID of the certificate resource that will be used for mTLS authentication with other virtual services in the mesh.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 23

def certificate_id
  @certificate_id
end

#maximum_validity ⇒ Integer

The number of days the mTLS certificate is valid. This value should be less than the Maximum Validity Duration for Certificates (Days) setting on the Certificate Authority associated with this Mesh. The certificate will be automatically renewed after 2/3 of the validity period, so a certificate with a maximum validity of 45 days will be renewed every 30 days.

Returns:

  • (Integer) 


31
32
33
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 31

def maximum_validity
  @maximum_validity
end

#mode ⇒ String

[Required] DISABLED: Connection is not tunneled. PERMISSIVE: Connection can be either plaintext or an mTLS tunnel. STRICT: Connection is an mTLS tunnel. Clients without a valid certificate will be rejected.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 38

def mode
  @mode
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_id': :'certificateId',
    'maximum_validity': :'maximumValidity',
    'mode': :'mode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_id': :'String',
    'maximum_validity': :'Integer',
    'mode': :'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



114
115
116
117
118
119
120
121
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 114

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

  self.class == other.class &&
    certificate_id == other.certificate_id &&
    maximum_validity == other.maximum_validity &&
    mode == other.mode
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 146

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


126
127
128
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 135

def hash
  [certificate_id, maximum_validity, mode].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 179

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



173
174
175
 
# File 'lib/oci/service_mesh/models/mutual_transport_layer_security.rb', line 173

def to_s
  to_hash.to_s
end