@Generated(value="OracleSDKGenerator",
comments="API Version: 20170907")
public final class EmailReturnPath
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The properties that define a Email Return Path
Note: Objects should always be created or deserialized using the EmailReturnPath.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the EmailReturnPath.Builder, which maintain a
set of all explicitly set fields called EmailReturnPath.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
EmailReturnPath.Builder |
static class |
EmailReturnPath.LifecycleState
The current state of the email return path.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
EmailReturnPath(String name,
String id,
String parentResourceId,
String compartmentId,
EmailReturnPath.LifecycleState lifecycleState,
String lifecycleDetails,
String description,
String dnsSubdomainName,
String cnameRecordValue,
Date timeCreated,
Date timeUpdated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static EmailReturnPath.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCnameRecordValue()
The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the
CNAME method for Email Return Path setup (preferred).
|
String |
getCompartmentId()
The OCID of
the compartment that contains this email return path.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description of the email return path.
|
String |
getDnsSubdomainName()
The name of the DNS subdomain that must be provisioned to enable email recipients to verify
Email Return Path.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of
the email return path.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
EmailReturnPath.LifecycleState |
getLifecycleState()
The current state of the email return path.
|
String |
getName()
The email return path domain in the Internet Domain Name System (DNS).
|
String |
getParentResourceId()
The OCID of
the EmailDomain that this email return path belongs to.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The time the email return path was created.
|
Date |
getTimeUpdated()
The time of the last change to the Email Return Path configuration, due to a state change or
an update operation.
|
int |
hashCode() |
EmailReturnPath.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"name","id","parentResourceId","compartmentId","lifecycleState","lifecycleDetails","description","dnsSubdomainName","cnameRecordValue","timeCreated","timeUpdated","freeformTags","definedTags","systemTags"}) public EmailReturnPath(String name, String id, String parentResourceId, String compartmentId, EmailReturnPath.LifecycleState lifecycleState, String lifecycleDetails, String description, String dnsSubdomainName, String cnameRecordValue, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static EmailReturnPath.Builder builder()
Create a new builder.
public EmailReturnPath.Builder toBuilder()
public String getName()
The email return path domain in the Internet Domain Name System (DNS).
Example: iad1.rp.example.com
public String getParentResourceId()
The OCID of the EmailDomain that this email return path belongs to.
public String getCompartmentId()
The OCID of the compartment that contains this email return path.
public EmailReturnPath.LifecycleState getLifecycleState()
The current state of the email return path.
public String getLifecycleDetails()
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in ‘Failed’ state.
public String getDescription()
The description of the email return path. Avoid entering confidential information.
public String getDnsSubdomainName()
The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
public String getCnameRecordValue()
The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
public Date getTimeCreated()
The time the email return path was created. Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
Example: 2021-02-12T22:47:12.613Z
public Date getTimeUpdated()
The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.