Class: OCI::Email::Models::EmailDomain

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

Overview

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

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DOMAIN_VERIFICATION_STATUS_ENUM = 
[
  DOMAIN_VERIFICATION_STATUS_NONE = 'NONE'.freeze,
  DOMAIN_VERIFICATION_STATUS_DOMAINID = 'DOMAINID'.freeze,
  DOMAIN_VERIFICATION_STATUS_OTHER = 'OTHER'.freeze,
  DOMAIN_VERIFICATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailDomain

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

  • :is_spf (BOOLEAN) —

    The value to assign to the #is_spf property

  • :domain_verification_status (String) —

    The value to assign to the #domain_verification_status property

  • :domain_verification_id (String) —

    The value to assign to the #domain_verification_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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/email/models/email_domain.rb', line 167

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.is_spf = attributes[:'isSpf'] unless attributes[:'isSpf'].nil?
  self.is_spf = false if is_spf.nil? && !attributes.key?(:'isSpf') # rubocop:disable Style/StringLiterals

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

  self.is_spf = attributes[:'is_spf'] unless attributes[:'is_spf'].nil?
  self.is_spf = false if is_spf.nil? && !attributes.key?(:'isSpf') && !attributes.key?(:'is_spf') # rubocop:disable Style/StringLiterals

  self.domain_verification_status = attributes[:'domainVerificationStatus'] if attributes[:'domainVerificationStatus']

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

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

  self.domain_verification_id = attributes[:'domainVerificationId'] if attributes[:'domainVerificationId']

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

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

Instance Attribute Details

#active_dkim_id ⇒ String

The OCID of the DKIM key that will be used to sign mail sent from this email domain.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/email/models/email_domain.rb', line 56

def active_dkim_id
  @active_dkim_id
end

#compartment_id ⇒ String

The OCID of the compartment that contains this email domain.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/email/models/email_domain.rb', line 46

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>>) 


98
99
100
 
# File 'lib/oci/email/models/email_domain.rb', line 98

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of an email domain.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/email/models/email_domain.rb', line 74

def description
  @description
end

#domain_verification_id ⇒ String

Id for Domain in Domain Management (under governance) if DOMAINID verification method used.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/email/models/email_domain.rb', line 70

def domain_verification_id
  @domain_verification_id
end

#domain_verification_status ⇒ String

The current domain verification status.

Returns:

  • (String) 


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

def domain_verification_status
  @domain_verification_status
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>) 


90
91
92
 
# File 'lib/oci/email/models/email_domain.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the email domain.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/email/models/email_domain.rb', line 41

def id
  @id
end

#is_spf ⇒ BOOLEAN

Value of the SPF field. For more information about SPF, please see SPF Authentication.

Returns:

  • (BOOLEAN) 


62
63
64
 
# File 'lib/oci/email/models/email_domain.rb', line 62

def is_spf
  @is_spf
end

#lifecycle_state ⇒ String

The current state of the email domain.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

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

Example: mydomain.example.com

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/email/models/email_domain.rb', line 36

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>>) 


104
105
106
 
# File 'lib/oci/email/models/email_domain.rb', line 104

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) 


82
83
84
 
# File 'lib/oci/email/models/email_domain.rb', line 82

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/email/models/email_domain.rb', line 107

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

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/email/models/email_domain.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'active_dkim_id': :'String',
    'is_spf': :'BOOLEAN',
    'domain_verification_status': :'String',
    'domain_verification_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>>'
    # 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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/email/models/email_domain.rb', line 275

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 &&
    is_spf == other.is_spf &&
    domain_verification_status == other.domain_verification_status &&
    domain_verification_id == other.domain_verification_id &&
    description == other.description &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/email/models/email_domain.rb', line 317

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


297
298
299
 
# File 'lib/oci/email/models/email_domain.rb', line 297

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



306
307
308
 
# File 'lib/oci/email/models/email_domain.rb', line 306

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/email/models/email_domain.rb', line 350

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



344
345
346
 
# File 'lib/oci/email/models/email_domain.rb', line 344

def to_s
  to_hash.to_s
end