Class: OCI::IdentityDomains::Models::NotificationSettingsFromEmailAddress

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

Overview

From email address to be used in the notification emails

SCIM++ Properties: - caseExact: false - multiValued: false - mutability: readWrite - required: true - returned: always - type: complex - uniqueness: none

Constant Summary collapse

VALIDATION_STATUS_ENUM = 
[
  VALIDATION_STATUS_VERIFIED = 'VERIFIED'.freeze,
  VALIDATION_STATUS_PENDING = 'PENDING'.freeze,
  VALIDATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VALIDATE_ENUM = 
[
  VALIDATE_EMAIL = 'email'.freeze,
  VALIDATE_DOMAIN = 'domain'.freeze,
  VALIDATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NotificationSettingsFromEmailAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :value (String) —

    The value to assign to the #value property

  • :validation_status (String) —

    The value to assign to the #validation_status property

  • :validate (String) —

    The value to assign to the #validate property

  • :display_name (String) —

    The value to assign to the #display_name property



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 119

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

  self.validation_status = attributes[:'validationStatus'] if attributes[:'validationStatus']

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

Instance Attribute Details

#display_name ⇒ String

Display name for the From email address

Added In: 19.2.1

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

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 83

def display_name
  @display_name
end

#validate ⇒ String

[Required] From address verification mode. If postmaster account is available then 'domain' mode is used or entire valid email can be verified using 'email' mode

Added In: 18.2.6

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

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 69

def validate
  @validate
end

#validation_status ⇒ String

Validation status for the From email address

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 53

def validation_status
  @validation_status
end

#value ⇒ String

[Required] Value of the From email address

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 42

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'value': :'value',
    'validation_status': :'validationStatus',
    'validate': :'validate',
    'display_name': :'displayName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 98

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



175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 175

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

  self.class == other.class &&
    value == other.value &&
    validation_status == other.validation_status &&
    validate == other.validate &&
    display_name == other.display_name
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 208

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


188
189
190
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 197

def hash
  [value, validation_status, validate, display_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 241

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



235
236
237
 
# File 'lib/oci/identity_domains/models/notification_settings_from_email_address.rb', line 235

def to_s
  to_hash.to_s
end