Class: OCI::IdentityDomains::Models::SelfRegistrationProfileFooterText

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

Overview

Footer text

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SelfRegistrationProfileFooterText

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :locale (String) —

    The value to assign to the #locale property

  • :value (String) —

    The value to assign to the #value property

  • :default (BOOLEAN) —

    The value to assign to the #default property



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 84

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

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

  self.default = attributes[:'default'] unless attributes[:'default'].nil?
end

Instance Attribute Details

#default ⇒ BOOLEAN

If true, specifies that the localized attribute instance value is the default and will be returned if no localized value found for requesting user's preferred locale. One and only one instance should have this attribute set to true.

SCIM++ Properties: - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 51

def default
  @default
end

#locale ⇒ String

[Required] Type of user's locale e.g. en-CA

SCIM++ Properties: - caseExact: false - idcsCanonicalValueSourceFilter: attrName eq "locales" and attrValues.value eq "$(type)" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


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

def locale
  @locale
end

#value ⇒ String

[Required] Localized value of footer text in corresponding locale

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 39

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 54

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

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'locale': :'String',
    'value': :'String',
    'default': :'BOOLEAN'
    # 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
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 104

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

  self.class == other.class &&
    locale == other.locale &&
    value == other.value &&
    default == other.default
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



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

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


116
117
118
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 116

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 125

def hash
  [locale, value, default].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 169

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



163
164
165
 
# File 'lib/oci/identity_domains/models/self_registration_profile_footer_text.rb', line 163

def to_s
  to_hash.to_s
end