Class: OCI::Identity::Models::CreateSmtpCredentialDetails

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

Overview

CreateSmtpCredentialDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSmtpCredentialDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :description (String) —

    The value to assign to the #description property



43
44
45
46
47
48
49
50
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 43

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

Instance Attribute Details

#description ⇒ String

[Required] The description you assign to the SMTP credentials during creation. Does not have to be unique, and it's changeable.

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

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 16

def description
  @description
end

Class Method Details

.attribute_map ⇒ Object

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



19
20
21
22
23
24
25
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 19

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 28

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String'
    # 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



59
60
61
62
63
64
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 59

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

  self.class == other.class &&
    description == other.description
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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 89

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


69
70
71
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 69

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



78
79
80
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 78

def hash
  [description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 122

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



116
117
118
 
# File 'lib/oci/identity/models/create_smtp_credential_details.rb', line 116

def to_s
  to_hash.to_s
end