Class: OCI::AccessGovernanceCp::Models::UpdateSenderConfig

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

Overview

Update to a sender information for email notifications sent by GovernanceInstance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSenderConfig

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_inbox_configured (BOOLEAN)

    The value to assign to the #is_inbox_configured property

  • :is_resend_notification_email (BOOLEAN)

    The value to assign to the #is_resend_notification_email property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 61

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_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?

  self.is_resend_notification_email = attributes[:'isResendNotificationEmail'] unless attributes[:'isResendNotificationEmail'].nil?

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

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

Instance Attribute Details

#display_nameString

The sender's displayName.

Returns:

  • (String)


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

def display_name
  @display_name
end

#emailString

[Required] The sender's email.

Returns:

  • (String)


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

def email
  @email
end

#is_inbox_configuredBOOLEAN

[Required] Whether the sender email has inbox configured to receive emails.

Returns:

  • (BOOLEAN)


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

def is_inbox_configured
  @is_inbox_configured
end

#is_resend_notification_emailBOOLEAN

Whether there is a need to resend the verification email.

Returns:

  • (BOOLEAN)


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

def is_resend_notification_email
  @is_resend_notification_email
end

Class Method Details

.attribute_mapObject

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



28
29
30
31
32
33
34
35
36
37
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'email': :'email',
    'is_inbox_configured': :'isInboxConfigured',
    'is_resend_notification_email': :'isResendNotificationEmail'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 40

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



95
96
97
98
99
100
101
102
103
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 95

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

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 128

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


108
109
110
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 108

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



117
118
119
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 117

def hash
  [display_name, email, is_inbox_configured, is_resend_notification_email].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 161

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



155
156
157
# File 'lib/oci/access_governance_cp/models/update_sender_config.rb', line 155

def to_s
  to_hash.to_s
end