Package com.oracle.bmc.email.model

Class EmailReturnPath

  • @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).

    • Method Detail

      • getName

        public String getName()
        The email return path domain in the Internet Domain Name System (DNS).

        Example: iad1.rp.example.com

        Returns:
        the value

      • getId

        public String getId()
        The OCID of the email return path.
        Returns:
        the value

      • getParentResourceId

        public String getParentResourceId()
        The OCID of the EmailDomain that this email return path belongs to.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains this email return path.
        Returns:
        the value

      • getLifecycleDetails

        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.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the email return path.

        Avoid entering confidential information.

        Returns:
        the value

      • getDnsSubdomainName

        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.

        Returns:
        the value

      • getCnameRecordValue

        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).
        Returns:
        the value

      • getTimeCreated

        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

        Returns:
        the value

      • getTimeUpdated

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

        Returns:
        the value

      • getFreeformTags

        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"}

        Returns:
        the value

      • getDefinedTags

        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"}}

        Returns:
        the value

      • getSystemTags

        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”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel