Class: OCI::Email::Models::Sender

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email/models/sender.rb

Overview

The full information representing an approved sender.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =

rubocop:disable Metrics/LineLength

[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Sender

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :email_address (String) —

    The value to assign to the #email_address property

  • :id (String) —

    The value to assign to the #id property

  • :is_spf (BOOLEAN) —

    The value to assign to the #is_spf property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/email/models/sender.rb', line 79

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

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

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

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

  self.is_spf = attributes[:'isSpf'] unless attributes[:'isSpf'].nil?
  self.is_spf = false if is_spf.nil? && !attributes.key?(:'isSpf') # rubocop:disable Style/StringLiterals

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

  self.is_spf = attributes[:'is_spf'] unless attributes[:'is_spf'].nil?
  self.is_spf = false if is_spf.nil? && !attributes.key?(:'isSpf') && !attributes.key?(:'is_spf') # rubocop:disable Style/StringLiterals

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

Instance Attribute Details

#email_address ⇒ String

Email address of the sender.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/email/models/sender.rb', line 20

def email_address
  @email_address
end

#id ⇒ String

The unique OCID of the sender.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/email/models/sender.rb', line 24

def id
  @id
end

#is_spf ⇒ BOOLEAN

Value of the SPF field. For more information about SPF, please see [SPF Authentication](docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/emaildeliveryoverview.htm#spf).

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/email/models/sender.rb', line 30

def is_spf
  @is_spf
end

#lifecycle_state ⇒ String

The sender’s current lifecycle state.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/email/models/sender.rb', line 34

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/email/models/sender.rb', line 40

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/email/models/sender.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'email_address': :'emailAddress',
    'id': :'id',
    'is_spf': :'isSpf',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/email/models/sender.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'email_address': :'String',
    'id': :'String',
    'is_spf': :'BOOLEAN',
    'lifecycle_state': :'String',
    'time_created': :'DateTime'
    # 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



136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/email/models/sender.rb', line 136

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    email_address == other.email_address &&
    id == other.id &&
    is_spf == other.is_spf &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/email/models/sender.rb', line 169

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


149
150
151
 
# File 'lib/oci/email/models/sender.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/email/models/sender.rb', line 158

def hash
  [email_address, id, is_spf, lifecycle_state, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/email/models/sender.rb', line 201

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



195
196
197
 
# File 'lib/oci/email/models/sender.rb', line 195

def to_s
  to_hash.to_s
end