Package com.oracle.bmc.email.model

Class CreateEmailReturnPathDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public final class CreateEmailReturnPathDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Properties to create a new email return path.

    The new object will be created in the same compartment as the parent resource.
    Note: Objects should always be created or deserialized using the CreateEmailReturnPathDetails.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 CreateEmailReturnPathDetails.Builder, which maintain a set of all explicitly set fields called CreateEmailReturnPathDetails.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 name of the email return path domain in the Internet Domain Name System (DNS).

        The name must be a subdomain of the email domain used to send emails. The email return path name must be globally unique for this tenancy. If you do not provide the email return path name, we will generate one for you. If you do provide the email return path name, we suggest adding a short region indicator to allow using the same parent domain in other regions you might be subscribed to. Domain names limited to ASCII characters use alphanumeric, dash (“-”), and dot (“.”) characters. The dash and dot are only allowed between alphanumeric characters. Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

        Returns:
        the value

      • getParentResourceId

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

      • getDescription

        public String getDescription()
        A string that describes the details about the email return path.

        It does not have to be unique, and you can change it. Avoid entering confidential information.

        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

      • 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