Class: OCI::AccessGovernanceCp::Models::SenderConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/access_governance_cp/models/sender_config.rb

Overview

The sender information for email notifications sent by GovernanceInstance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SenderConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :email (String) —

    The value to assign to the #email property

  • :is_verified (BOOLEAN) —

    The value to assign to the #is_verified property

  • :time_verify_response_expiry (DateTime) —

    The value to assign to the #time_verify_response_expiry property

  • :is_inbox_configured (BOOLEAN) —

    The value to assign to the #is_inbox_configured property

[View source]

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 68

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_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']

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

  self.is_verified = attributes[:'isVerified'] unless attributes[:'isVerified'].nil?

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

  self.is_verified = attributes[:'is_verified'] unless attributes[:'is_verified'].nil?

  self.time_verify_response_expiry = attributes[:'timeVerifyResponseExpiry'] if attributes[:'timeVerifyResponseExpiry']

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

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

  self.is_inbox_configured = attributes[:'isInboxConfigured'] unless attributes[:'isInboxConfigured'].nil?

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

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

Instance Attribute Details

#display_name ⇒ String

The sender's displayName.

Returns:

  • (String) 

13
14
15
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 13

def display_name
  @display_name
end

#email ⇒ String

The sender's email.

Returns:

  • (String) 

17
18
19
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 17

def email
  @email
end

#is_inbox_configured ⇒ BOOLEAN

Whether the sender email has inbox configured to receive emails.

Returns:

  • (BOOLEAN) 

29
30
31
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 29

def is_inbox_configured
  @is_inbox_configured
end

#is_verified ⇒ BOOLEAN

Whether or not the sender's email has been verified.

Returns:

  • (BOOLEAN) 

21
22
23
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 21

def is_verified
  @is_verified
end

#time_verify_response_expiry ⇒ DateTime

The time when the verify response needs to be received by.

Returns:

  • (DateTime) 

25
26
27
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 25

def time_verify_response_expiry
  @time_verify_response_expiry
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'email': :'email',
    'is_verified': :'isVerified',
    'time_verify_response_expiry': :'timeVerifyResponseExpiry',
    'is_inbox_configured': :'isInboxConfigured'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'email': :'String',
    'is_verified': :'BOOLEAN',
    'time_verify_response_expiry': :'DateTime',
    'is_inbox_configured': :'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

[View source]

108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 108

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

  self.class == other.class &&
    display_name == other.display_name &&
    email == other.email &&
    is_verified == other.is_verified &&
    time_verify_response_expiry == other.time_verify_response_expiry &&
    is_inbox_configured == other.is_inbox_configured
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

[View source]

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

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
[View source]

122
123
124
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

131
132
133
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 131

def hash
  [display_name, email, is_verified, time_verify_response_expiry, is_inbox_configured].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

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

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

[View source]

169
170
171
 
# File 'lib/oci/access_governance_cp/models/sender_config.rb', line 169

def to_s
  to_hash.to_s
end