Class: OCI::Identity::Models::SmtpCredential

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/smtp_credential.rb

Overview

Simple Mail Transfer Protocol (SMTP) credentials are needed to send email through Email Delivery. The SMTP credentials are used for SMTP authentication with the service. The credentials never expire. A user can have up to 2 SMTP credentials at a time.

Note: The credential set is always an Oracle-generated SMTP user name and password pair; you cannot designate the SMTP user name or the SMTP password.

For more information, see Managing User Credentials.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ SmtpCredential

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :username (String)

    The value to assign to the #username property

  • :password (String)

    The value to assign to the #password property

  • :id (String)

    The value to assign to the #id property

  • :user_id (String)

    The value to assign to the #user_id property

  • :description (String)

    The value to assign to the #description property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_expires (DateTime)

    The value to assign to the #time_expires property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer)

    The value to assign to the #inactive_status property



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/oci/identity/models/smtp_credential.rb', line 128

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

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

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

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

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

  self.time_expires = attributes[:'timeExpires'] if attributes[:'timeExpires']

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

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

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

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

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

Instance Attribute Details

#descriptionString

The description you assign to the SMTP credential. Does not have to be unique, and it's changeable.

(For tenancies that support identity domains) You can have an empty description.

Returns:

  • (String)


52
53
54
# File 'lib/oci/identity/models/smtp_credential.rb', line 52

def description
  @description
end

#idString

The OCID of the SMTP credential.

Returns:

  • (String)


41
42
43
# File 'lib/oci/identity/models/smtp_credential.rb', line 41

def id
  @id
end

#inactive_statusInteger

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer)


77
78
79
# File 'lib/oci/identity/models/smtp_credential.rb', line 77

def inactive_status
  @inactive_status
end

#lifecycle_stateString

The credential's current state. After creating a SMTP credential, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

  • (String)


73
74
75
# File 'lib/oci/identity/models/smtp_credential.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#passwordString

The SMTP password.

Returns:

  • (String)


37
38
39
# File 'lib/oci/identity/models/smtp_credential.rb', line 37

def password
  @password
end

#time_createdDateTime

Date and time the SmtpCredential object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


59
60
61
# File 'lib/oci/identity/models/smtp_credential.rb', line 59

def time_created
  @time_created
end

#time_expiresDateTime

Date and time when this credential will expire, in the format defined by RFC3339. Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime)


67
68
69
# File 'lib/oci/identity/models/smtp_credential.rb', line 67

def time_expires
  @time_expires
end

#user_idString

The OCID of the user the SMTP credential belongs to.

Returns:

  • (String)


45
46
47
# File 'lib/oci/identity/models/smtp_credential.rb', line 45

def user_id
  @user_id
end

#usernameString

The SMTP user name.

Returns:

  • (String)


32
33
34
# File 'lib/oci/identity/models/smtp_credential.rb', line 32

def username
  @username
end

Class Method Details

.attribute_mapObject

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/oci/identity/models/smtp_credential.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'username': :'username',
    'password': :'password',
    'id': :'id',
    'user_id': :'userId',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_expires': :'timeExpires',
    'lifecycle_state': :'lifecycleState',
    'inactive_status': :'inactiveStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/oci/identity/models/smtp_credential.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'username': :'String',
    'password': :'String',
    'id': :'String',
    'user_id': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_expires': :'DateTime',
    'lifecycle_state': :'String',
    'inactive_status': :'Integer'
    # 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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/oci/identity/models/smtp_credential.rb', line 193

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

  self.class == other.class &&
    username == other.username &&
    password == other.password &&
    id == other.id &&
    user_id == other.user_id &&
    description == other.description &&
    time_created == other.time_created &&
    time_expires == other.time_expires &&
    lifecycle_state == other.lifecycle_state &&
    inactive_status == other.inactive_status
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/oci/identity/models/smtp_credential.rb', line 231

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


211
212
213
# File 'lib/oci/identity/models/smtp_credential.rb', line 211

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



220
221
222
# File 'lib/oci/identity/models/smtp_credential.rb', line 220

def hash
  [username, password, id, user_id, description, time_created, time_expires, lifecycle_state, inactive_status].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



264
265
266
267
268
269
270
271
272
273
# File 'lib/oci/identity/models/smtp_credential.rb', line 264

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



258
259
260
# File 'lib/oci/identity/models/smtp_credential.rb', line 258

def to_s
  to_hash.to_s
end