Class: OCI::Email::Models::EmailDomainSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email/models/email_domain_summary.rb

Overview

The properties that define an email domain. An email domain contains configuration used to assert responsibility for emails sent from that domain.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailDomainSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :active_dkim_id (String) —

    The value to assign to the #active_dkim_id property

  • :description (String) —

    The value to assign to the #description property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :locks (Array<OCI::Email::Models::ResourceLock>) —

    The value to assign to the #locks property



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 133

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

  self.active_dkim_id = attributes[:'active_dkim_id'] if attributes[:'active_dkim_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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

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

Instance Attribute Details

#active_dkim_id ⇒ String

The OCID of the DKIM key that is adding the DKIM signature for this email domain.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 38

def active_dkim_id
  @active_dkim_id
end

#compartment_id ⇒ String

The OCID of the compartment that contains this email domain.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 28

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


66
67
68
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 66

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of an email domain.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 42

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 58

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the email domain.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 23

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the email domain.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 32

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::Email::Models::ResourceLock>

Locks associated with this resource.

Returns:



76
77
78
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 76

def locks
  @locks
end

#name ⇒ String

[Required] The name of the email domain in the Internet Domain Name System (DNS).

Example: mydomain.example.com

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 18

def name
  @name
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


72
73
74
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 72

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

Example: 2021-02-12T22:47:12.613Z

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 50

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'active_dkim_id': :'activeDkimId',
    'description': :'description',
    'time_created': :'timeCreated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'active_dkim_id': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::Email::Models::ResourceLock>'
    # 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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 197

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

  self.class == other.class &&
    name == other.name &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    active_dkim_id == other.active_dkim_id &&
    description == other.description &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    locks == other.locks
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 237

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


217
218
219
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 226

def hash
  [name, id, compartment_id, lifecycle_state, active_dkim_id, description, time_created, freeform_tags, defined_tags, system_tags, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 270

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



264
265
266
 
# File 'lib/oci/email/models/email_domain_summary.rb', line 264

def to_s
  to_hash.to_s
end