Class: OCI::NetworkFirewall::Models::MappedSecret

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/network_firewall/models/mapped_secret.rb

Overview

Mapped secret used on the firewall policy rules. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

VaultMappedSecret

Constant Summary collapse

SOURCE_ENUM = 
[
  SOURCE_OCI_VAULT = 'OCI_VAULT'.freeze,
  SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_SSL_INBOUND_INSPECTION = 'SSL_INBOUND_INSPECTION'.freeze,
  TYPE_SSL_FORWARD_PROXY = 'SSL_FORWARD_PROXY'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MappedSecret

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :source (String) —

    The value to assign to the #source property

  • :type (String) —

    The value to assign to the #type property

  • :parent_resource_id (String) —

    The value to assign to the #parent_resource_id property



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 93

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

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

  self.type = attributes[:'type'] if attributes[:'type']
  self.type = "SSL_INBOUND_INSPECTION" if type.nil? && !attributes.key?(:'type') # rubocop:disable Style/StringLiterals

  self.parent_resource_id = attributes[:'parentResourceId'] if attributes[:'parentResourceId']

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

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

Instance Attribute Details

#name ⇒ String

[Required] Name of the secret.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 26

def name
  @name
end

#parent_resource_id ⇒ String

[Required] OCID of the Network Firewall Policy this Mapped Secret belongs to.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 42

def parent_resource_id
  @parent_resource_id
end

#source ⇒ String

[Required] Source of the secrets, where the secrets are stored.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 30

def source
  @source
end

#type ⇒ String

[Required] Type of the secrets mapped based on the policy.

  • SSL_INBOUND_INSPECTION: For Inbound inspection of SSL traffic.

  • SSL_FORWARD_PROXY: For forward proxy certificates for SSL inspection.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 38

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'source': :'source',
    'type': :'type',
    'parent_resource_id': :'parentResourceId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



73
74
75
76
77
78
79
80
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 73

def self.get_subtype(object_hash)
  type = object_hash[:'source'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::NetworkFirewall::Models::VaultMappedSecret' if type == 'OCI_VAULT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::NetworkFirewall::Models::MappedSecret'
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'source': :'String',
    'type': :'String',
    'parent_resource_id': :'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



146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 146

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

  self.class == other.class &&
    name == other.name &&
    source == other.source &&
    type == other.type &&
    parent_resource_id == other.parent_resource_id
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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 179

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


159
160
161
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 168

def hash
  [name, source, type, parent_resource_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 212

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



206
207
208
 
# File 'lib/oci/network_firewall/models/mapped_secret.rb', line 206

def to_s
  to_hash.to_s
end