Class: OCI::IdentityDomains::Models::AuthenticationFactorSettingsCompliancePolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb

Overview

Compliance Policy that defines actions to be taken when a condition is violated

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_ALLOW = 'Allow'.freeze,
  ACTION_BLOCK = 'Block'.freeze,
  ACTION_NOTIFY = 'Notify'.freeze,
  ACTION_NONE = 'None'.freeze,
  ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationFactorSettingsCompliancePolicy

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

  • :action (String) —

    The value to assign to the #action property

  • :value (String) —

    The value to assign to the #value property



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 90

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

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

Instance Attribute Details

#action ⇒ String

[Required] The action to be taken if the value of the attribute is not as expected

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 44

def action
  @action
end

#name ⇒ String

[Required] The name of the attribute being evaluated

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 31

def name
  @name
end

#value ⇒ String

[Required] The value of the attribute to be evaluated

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 57

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'action': :'action',
    'value': :'value'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 71

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



123
124
125
126
127
128
129
130
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 123

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

  self.class == other.class &&
    name == other.name &&
    action == other.action &&
    value == other.value
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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 155

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


135
136
137
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 144

def hash
  [name, action, value].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 188

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



182
183
184
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings_compliance_policy.rb', line 182

def to_s
  to_hash.to_s
end