Class: OCI::IdentityDomains::Models::SecurityQuestionSettingsSearchRequest

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

Overview

Clients MAY execute queries without passing parameters on the URL by using the HTTP POST verb combined with the .search path extension. The inclusion of .search on the end of a valid SCIM endpoint SHALL be used to indicate the HTTP POST verb is intended to be a query operation. To create a new query result set, a SCIM client sends an HTTP POST request to the desired SCIM resource endpoint (ending in .search). The body of the POST request MAY include any of the parameters.

Constant Summary collapse

ATTRIBUTE_SETS_ENUM = 
[
  ATTRIBUTE_SETS_ALL = 'all'.freeze,
  ATTRIBUTE_SETS_ALWAYS = 'always'.freeze,
  ATTRIBUTE_SETS_NEVER = 'never'.freeze,
  ATTRIBUTE_SETS_REQUEST = 'request'.freeze,
  ATTRIBUTE_SETS_DEFAULT = 'default'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityQuestionSettingsSearchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :schemas (Array<String>) —

    The value to assign to the #schemas property

  • :attributes (Array<String>) —

    The value to assign to the #attributes property

  • :attribute_sets (Array<String>) —

    The value to assign to the #attribute_sets property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 62

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

  self.attribute_sets = attributes[:'attributeSets'] if attributes[:'attributeSets']

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

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

Instance Attribute Details

#attribute_sets ⇒ Array<String>

A multi-valued list of strings indicating the return type of attribute definition. The specified set of attributes can be fetched by the return type of the attribute. One or more values can be given together to fetch more than one group of attributes. If "attributes" query parameter is also available, union of the two is fetched. Valid values : all, always, never, request, default. Values are case-insensitive. OPTIONAL.

Returns:

  • (Array<String>) 


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

def attribute_sets
  @attribute_sets
end

#attributes ⇒ Array<String>

A multi-valued list of strings indicating the names of resource attributes to return in the response overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (Section 3.10) form. See (additional retrieval query parameters). OPTIONAL.

Returns:

  • (Array<String>) 


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

def attributes
  @attributes
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. Query requests MUST be identified using the following URI: "urn:ietf:params:scim:api:messages:2.0:SearchRequest" REQUIRED.

Returns:

  • (Array<String>) 


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

def schemas
  @schemas
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
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'schemas': :'schemas',
    'attributes': :'attributes',
    'attribute_sets': :'attributeSets'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'schemas': :'Array<String>',
    'attributes': :'Array<String>',
    'attribute_sets': :'Array<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



101
102
103
104
105
106
107
108
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 101

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

  self.class == other.class &&
    schemas == other.schemas &&
    attributes == other.attributes &&
    attribute_sets == other.attribute_sets
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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 133

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


113
114
115
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 122

def hash
  [schemas, attributes, attribute_sets].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 166

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



160
161
162
 
# File 'lib/oci/identity_domains/models/security_question_settings_search_request.rb', line 160

def to_s
  to_hash.to_s
end