Class: OCI::IdentityDomains::Models::SelfRegistrationProfileEmailTemplate

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

Overview

Email template

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: request - type: complex

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SelfRegistrationProfileEmailTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display (String) —

    The value to assign to the #display property

  • :value (String) —

    The value to assign to the #value property

  • :ref (String) —

    The value to assign to the #ref property



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 92

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

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

  self.ref = attributes[:'$ref'] if attributes[:'$ref']
end

Instance Attribute Details

#display ⇒ String

A human readable name, primarily used for display purposes. READ-ONLY.

Added In: 19.2.1

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 32

def display
  @display
end

#ref ⇒ String

URI of the Email Template

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: reference - uniqueness: none

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 59

def ref
  @ref
end

#value ⇒ String

[Required] Identifier of the Email Template.

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 46

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display': :'display',
    'value': :'value',
    'ref': :'$ref'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 73

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



112
113
114
115
116
117
118
119
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 112

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

  self.class == other.class &&
    display == other.display &&
    value == other.value &&
    ref == other.ref
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 144

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


124
125
126
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 133

def hash
  [display, value, ref].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 177

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



171
172
173
 
# File 'lib/oci/identity_domains/models/self_registration_profile_email_template.rb', line 171

def to_s
  to_hash.to_s
end