Class: OCI::Email::Models::DkimSummary

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

Overview

The properties that define a DKIM.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DkimSummary

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

  • :email_domain_id (String) —

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

  • :description (String) —

    The value to assign to the #description property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :is_imported (BOOLEAN) —

    The value to assign to the #is_imported property

  • :key_length (Integer) —

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



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
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
 
# File 'lib/oci/email/models/dkim_summary.rb', line 149

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

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

  self.email_domain_id = attributes[:'email_domain_id'] if attributes[:'email_domain_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.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_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

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

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

  self.key_length = attributes[:'keyLength'] if attributes[:'keyLength']

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

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

  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

#compartment_id ⇒ String

The OCID of the compartment that contains this DKIM.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/email/models/dkim_summary.rb', line 31

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


80
81
82
 
# File 'lib/oci/email/models/dkim_summary.rb', line 80

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of a DKIM. Avoid entering confidential information.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/email/models/dkim_summary.rb', line 39

def description
  @description
end

#email_domain_id ⇒ String

[Required] The OCID of the email domain that this DKIM belongs to.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/email/models/dkim_summary.rb', line 26

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the DKIM.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/email/models/dkim_summary.rb', line 20

def id
  @id
end

#is_imported ⇒ BOOLEAN

Indicates whether the DKIM was imported.

Returns:

  • (BOOLEAN) 


60
61
62
 
# File 'lib/oci/email/models/dkim_summary.rb', line 60

def is_imported
  @is_imported
end

#key_length ⇒ Integer

Length of the RSA key used in the DKIM.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/email/models/dkim_summary.rb', line 64

def key_length
  @key_length
end

#lifecycle_state ⇒ String

The current state of the DKIM.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/email/models/dkim_summary.rb', line 35

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The DKIM selector. This selector is required to be globally unique for this email domain.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/email/models/dkim_summary.rb', line 15

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


86
87
88
 
# File 'lib/oci/email/models/dkim_summary.rb', line 86

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/email/models/dkim_summary.rb', line 48

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/email/models/dkim_summary.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'id': :'id',
    'email_domain_id': :'emailDomainId',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_imported': :'isImported',
    'key_length': :'keyLength',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/email/models/dkim_summary.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'id': :'String',
    'email_domain_id': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_imported': :'BOOLEAN',
    'key_length': :'Integer',
    '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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/email/models/dkim_summary.rb', line 231

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

  self.class == other.class &&
    name == other.name &&
    id == other.id &&
    email_domain_id == other.email_domain_id &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    description == other.description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_imported == other.is_imported &&
    key_length == other.key_length &&
    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



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

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


253
254
255
 
# File 'lib/oci/email/models/dkim_summary.rb', line 253

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



262
263
264
 
# File 'lib/oci/email/models/dkim_summary.rb', line 262

def hash
  [name, id, email_domain_id, compartment_id, lifecycle_state, description, time_created, time_updated, is_imported, key_length, 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



306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/email/models/dkim_summary.rb', line 306

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



300
301
302
 
# File 'lib/oci/email/models/dkim_summary.rb', line 300

def to_s
  to_hash.to_s
end