Class: OCI::Email::Models::EmailIpPool

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

Overview

A collection of IP addresses used by the Email Delivery service to submit an email.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailIpPool

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
241
242
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 169

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

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

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

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

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

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

  self.outbound_ips = attributes[:'outboundIps'] if attributes[:'outboundIps']

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

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

  self.last_ip_drain_period_in_hours = attributes[:'lastIpDrainPeriodInHours'] if attributes[:'lastIpDrainPeriodInHours']

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

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

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

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the IpPool.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 37

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


93
94
95
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 93

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the IpPool. Avoid entering confidential information.

Returns:

  • (String) 


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

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


85
86
87
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 85

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The unique OCID of the IpPool resource that is immutable on creation.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 25

def id
  @id
end

#last_ip_drain_period_in_hours ⇒ Integer

Last IP will be unassigned from the IP Pool after the period of time (in hours) specified by this parameter. Default is 24 hours.

Returns:

  • (Integer) 


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

def last_ip_drain_period_in_hours
  @last_ip_drain_period_in_hours
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'INACTIVE' state.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 51

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the IpPool.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 45

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



103
104
105
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 103

def locks
  @locks
end

#name ⇒ String

[Required] The name of the IpPool. The name must be unique within a region. The name is case sensitive and supported characters include alphanumeric, hyphens ("-") and underscore ("_") characters.

Example: green_pool-1

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 33

def name
  @name
end

#outbound_ips ⇒ Array<OCI::Email::Models::EmailOutboundIpSummary>

Summary of outbound IPs assigned to the IpPool.

Returns:



55
56
57
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 55

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


99
100
101
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 99

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 69

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 77

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



106
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_ip_pool.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'outbound_ips': :'outboundIps',
    'last_ip_drain_period_in_hours': :'lastIpDrainPeriodInHours',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'locks': :'locks'
    # 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
147
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 128

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'outbound_ips': :'Array<OCI::Email::Models::EmailOutboundIpSummary>',
    'last_ip_drain_period_in_hours': :'Integer',
    'time_created': :'DateTime',
    'time_updated': :'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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 264

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    outbound_ips == other.outbound_ips &&
    last_ip_drain_period_in_hours == other.last_ip_drain_period_in_hours &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 307

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


287
288
289
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 287

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



296
297
298
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 296

def hash
  [id, name, compartment_id, description, lifecycle_state, lifecycle_details, outbound_ips, last_ip_drain_period_in_hours, time_created, time_updated, 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



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 340

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



334
335
336
 
# File 'lib/oci/email/models/email_ip_pool.rb', line 334

def to_s
  to_hash.to_s
end