Class: OCI::IdentityDomains::Models::AuthenticationFactorSettings

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

Overview

The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response. Queries MAY be made against a single resource or a resource type endpoint (e.g., /Users), or the service provider Base URI.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationFactorSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 68

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

  self.total_results = attributes[:'totalResults'] if attributes[:'totalResults']

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

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

  self.resources = attributes[:'Resources'] if attributes[:'Resources']

  self.start_index = attributes[:'startIndex'] if attributes[:'startIndex']

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

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

  self.items_per_page = attributes[:'itemsPerPage'] if attributes[:'itemsPerPage']

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

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

Instance Attribute Details

#items_per_page ⇒ Integer

[Required] The number of resources returned in a list response page. REQUIRED when partial results returned due to pagination.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 29

def items_per_page
  @items_per_page
end

#resources ⇒ Array<OCI::IdentityDomains::Models::AuthenticationFactorSetting>

[Required] A multi-valued list of complex objects containing the requested resources. This MAY be a subset of the full set of resources if pagination is requested. REQUIRED if "totalResults" is non-zero.

Returns:



21
22
23
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 21

def resources
  @resources
end

#schemas ⇒ Array<String>

[Required] The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior. REQUIRED.

Returns:

  • (Array<String>) 


13
14
15
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 13

def schemas
  @schemas
end

#start_index ⇒ Integer

[Required] The 1-based index of the first result in the current set of list results. REQUIRED when partial results returned due to pagination.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 25

def start_index
  @start_index
end

#total_results ⇒ Integer

[Required] The total number of results returned by the list or query operation. The value may be larger than the number of resources returned such as when returning a single page of results where multiple pages are available. REQUIRED.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 17

def total_results
  @total_results
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'schemas': :'schemas',
    'total_results': :'totalResults',
    'resources': :'Resources',
    'start_index': :'startIndex',
    'items_per_page': :'itemsPerPage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'schemas': :'Array<String>',
    'total_results': :'Integer',
    'resources': :'Array<OCI::IdentityDomains::Models::AuthenticationFactorSetting>',
    'start_index': :'Integer',
    'items_per_page': :'Integer'
    # 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



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 104

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

  self.class == other.class &&
    schemas == other.schemas &&
    total_results == other.total_results &&
    resources == other.resources &&
    start_index == other.start_index &&
    items_per_page == other.items_per_page
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 138

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


118
119
120
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 127

def hash
  [schemas, total_results, resources, start_index, items_per_page].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 171

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



165
166
167
 
# File 'lib/oci/identity_domains/models/authentication_factor_settings.rb', line 165

def to_s
  to_hash.to_s
end