Class: OCI::Identity::Models::SmtpCredentialSummary
- Inherits:
-
Object
- Object
- OCI::Identity::Models::SmtpCredentialSummary
- Defined in:
- lib/oci/identity/models/smtp_credential_summary.rb
Overview
As the name suggests, an ‘SmtpCredentialSummary` object contains information about an `SmtpCredential`. The SMTP credential is used for SMTP authentication with the [Email Delivery Service](docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/overview.htm).
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[LIFECYCLE_STATE_CREATING = 'CREATING', LIFECYCLE_STATE_ACTIVE = 'ACTIVE', LIFECYCLE_STATE_INACTIVE = 'INACTIVE', LIFECYCLE_STATE_DELETING = 'DELETING', LIFECYCLE_STATE_DELETED = 'DELETED', LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
Instance Attribute Summary collapse
-
#description ⇒ String
The description you assign to the SMTP credential.
-
#id ⇒ String
The OCID of the SMTP credential.
-
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
-
#lifecycle_state ⇒ String
The credential’s current state.
-
#time_created ⇒ DateTime
Date and time the ‘SmtpCredential` object was created, in the format defined by RFC3339.
-
#time_expires ⇒ DateTime
Date and time when this credential will expire, in the format defined by RFC3339.
-
#user_id ⇒ String
The OCID of the user the SMTP credential belongs to.
-
#username ⇒ String
The SMTP user name.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SmtpCredentialSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SmtpCredentialSummary
Initializes the object
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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 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/models/smtp_credential_summary.rb', line 72 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} if attributes[:'username'] self.username = attributes[:'username'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'userId'] self.user_id = attributes[:'userId'] end raise 'You cannot provide both :userId and :user_id' if attributes.key?(:'userId') && attributes.key?(:'user_id') if attributes[:'user_id'] self.user_id = attributes[:'user_id'] end if attributes[:'description'] self.description = attributes[:'description'] end if attributes[:'timeCreated'] self.time_created = attributes[:'timeCreated'] end raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') if attributes[:'time_created'] self.time_created = attributes[:'time_created'] end if attributes[:'timeExpires'] self.time_expires = attributes[:'timeExpires'] end raise 'You cannot provide both :timeExpires and :time_expires' if attributes.key?(:'timeExpires') && attributes.key?(:'time_expires') if attributes[:'time_expires'] self.time_expires = attributes[:'time_expires'] end if attributes[:'lifecycleState'] self.lifecycle_state = attributes[:'lifecycleState'] end raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') if attributes[:'lifecycle_state'] self.lifecycle_state = attributes[:'lifecycle_state'] end if attributes[:'inactiveStatus'] self.inactive_status = attributes[:'inactiveStatus'] end raise 'You cannot provide both :inactiveStatus and :inactive_status' if attributes.key?(:'inactiveStatus') && attributes.key?(:'inactive_status') if attributes[:'inactive_status'] self.inactive_status = attributes[:'inactive_status'] end end |
Instance Attribute Details
#description ⇒ String
The description you assign to the SMTP credential. Does not have to be unique, and it’s changeable.
34 35 36 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 34 def description @description end |
#id ⇒ String
The OCID of the SMTP credential.
26 27 28 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 26 def id @id end |
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
59 60 61 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 59 def inactive_status @inactive_status end |
#lifecycle_state ⇒ String
The credential’s current state. After creating a SMTP credential, make sure its ‘lifecycleState` changes from CREATING to ACTIVE before using it.
55 56 57 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 55 def lifecycle_state @lifecycle_state end |
#time_created ⇒ DateTime
Date and time the ‘SmtpCredential` object was created, in the format defined by RFC3339.
Example: ‘2016-08-25T21:10:29.600Z`
41 42 43 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 41 def time_created @time_created end |
#time_expires ⇒ DateTime
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`
49 50 51 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 49 def time_expires @time_expires end |
#user_id ⇒ String
The OCID of the user the SMTP credential belongs to.
30 31 32 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 30 def user_id @user_id end |
#username ⇒ String
The SMTP user name.
22 23 24 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 22 def username @username end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 154 def ==(other_object) return true if self.equal?(other_object) self.class == other_object.class && username == other_object.username && id == other_object.id && user_id == other_object.user_id && description == other_object.description && time_created == other_object.time_created && time_expires == other_object.time_expires && lifecycle_state == other_object.lifecycle_state && inactive_status == other_object.inactive_status end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 182 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) self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.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_object) ⇒ Boolean
169 170 171 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 169 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
175 176 177 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 175 def hash [username, id, user_id, description, time_created, time_expires, lifecycle_state, inactive_status].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
207 208 209 210 211 212 213 214 215 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 207 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
201 202 203 |
# File 'lib/oci/identity/models/smtp_credential_summary.rb', line 201 def to_s to_hash.to_s end |