Class: OCI::NetworkFirewall::Models::CreateMappedSecretDetails

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

Overview

The Request for creating the Mapped Secret

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

CreateVaultMappedSecretDetails

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_SSL_INBOUND_INSPECTION = 'SSL_INBOUND_INSPECTION'.freeze,
  TYPE_SSL_FORWARD_PROXY = 'SSL_FORWARD_PROXY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMappedSecretDetails

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

  • :description (String) —

    The value to assign to the #description property



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 87

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

Instance Attribute Details

#description ⇒ String

The description of the mapped secret. This field can be used to add additional info.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 36

def description
  @description
end

#name ⇒ String

[Required] Unique name to identify the group of urls to be used in the policy rules.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 20

def name
  @name
end

#source ⇒ String

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 24

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) 


32
33
34
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 32

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 39

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



67
68
69
70
71
72
73
74
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 67

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 118

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

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 151

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


131
132
133
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 140

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 184

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



178
179
180
 
# File 'lib/oci/network_firewall/models/create_mapped_secret_details.rb', line 178

def to_s
  to_hash.to_s
end