EmailIpPool¶
- class oci.email.models.EmailIpPool(**kwargs)¶
Bases:
objectA collection of IP addresses used by the Email Delivery service to submit an email.
Attributes:
A constant which can be used with the lifecycle_state property of a EmailIpPool.
A constant which can be used with the lifecycle_state property of a EmailIpPool.
A constant which can be used with the lifecycle_state property of a EmailIpPool.
A constant which can be used with the lifecycle_state property of a EmailIpPool.
A constant which can be used with the lifecycle_state property of a EmailIpPool.
A constant which can be used with the lifecycle_state property of a EmailIpPool.
A constant which can be used with the lifecycle_state property of a EmailIpPool.
[Required] Gets the compartment_id of this EmailIpPool.
Gets the defined_tags of this EmailIpPool.
Gets the description of this EmailIpPool.
Gets the freeform_tags of this EmailIpPool.
[Required] Gets the id of this EmailIpPool.
Gets the last_ip_drain_period_in_hours of this EmailIpPool.
Gets the lifecycle_details of this EmailIpPool.
Gets the lifecycle_state of this EmailIpPool.
Gets the locks of this EmailIpPool.
[Required] Gets the name of this EmailIpPool.
Gets the outbound_ips of this EmailIpPool.
Gets the system_tags of this EmailIpPool.
Gets the time_created of this EmailIpPool.
Gets the time_updated of this EmailIpPool.
Methods:
__init__(**kwargs)Initializes a new EmailIpPool object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a EmailIpPool. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new EmailIpPool object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this EmailIpPool.
name (str) – The value to assign to the name property of this EmailIpPool.
compartment_id (str) – The value to assign to the compartment_id property of this EmailIpPool.
description (str) – The value to assign to the description property of this EmailIpPool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EmailIpPool. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this EmailIpPool.
outbound_ips (list[oci.email.models.EmailOutboundIpSummary]) – The value to assign to the outbound_ips property of this EmailIpPool.
last_ip_drain_period_in_hours (int) – The value to assign to the last_ip_drain_period_in_hours property of this EmailIpPool.
time_created (datetime) – The value to assign to the time_created property of this EmailIpPool.
time_updated (datetime) – The value to assign to the time_updated property of this EmailIpPool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EmailIpPool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EmailIpPool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this EmailIpPool.
locks (list[oci.email.models.ResourceLock]) – The value to assign to the locks property of this EmailIpPool.
- property compartment_id¶
[Required] Gets the compartment_id of this EmailIpPool. The OCID of the compartment containing the IpPool.
- Returns
The compartment_id of this EmailIpPool.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this EmailIpPool. 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
The defined_tags of this EmailIpPool.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this EmailIpPool. The description of the IpPool. Avoid entering confidential information.
- Returns
The description of this EmailIpPool.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this EmailIpPool. 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
The freeform_tags of this EmailIpPool.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this EmailIpPool. The unique OCID of the IpPool resource that is immutable on creation.
- Returns
The id of this EmailIpPool.
- Return type
str
- property last_ip_drain_period_in_hours¶
Gets the last_ip_drain_period_in_hours of this EmailIpPool. 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
The last_ip_drain_period_in_hours of this EmailIpPool.
- Return type
int
- property lifecycle_details¶
Gets the lifecycle_details of this EmailIpPool. 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
The lifecycle_details of this EmailIpPool.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this EmailIpPool. The current state of the IpPool.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this EmailIpPool.
- Return type
str
- property locks¶
Gets the locks of this EmailIpPool. Locks associated with this resource.
- Returns
The locks of this EmailIpPool.
- Return type
- property name¶
[Required] Gets the name of this EmailIpPool. 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
The name of this EmailIpPool.
- Return type
str
- property outbound_ips¶
Gets the outbound_ips of this EmailIpPool. Summary of outbound IPs assigned to the IpPool.
- Returns
The outbound_ips of this EmailIpPool.
- Return type
- property system_tags¶
Gets the system_tags of this EmailIpPool. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this EmailIpPool.
- Return type
dict(str, dict(str, object))