Package com.oracle.bmc.email.model

Class EmailDomain

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public final class EmailDomain
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The properties that define an email domain.

    An email domain contains configuration used to assert responsibility for emails sent from that domain.
    Note: Objects should always be created or deserialized using the EmailDomain.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 EmailDomain.Builder, which maintain a set of all explicitly set fields called EmailDomain.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 domain in the Internet Domain Name System (DNS).

        Example: mydomain.example.com

        Returns:
        the value

      • getId

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

      • getCompartmentId

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

      • getLifecycleState

        public EmailDomain.LifecycleState getLifecycleState()
        The current state of the email domain.
        Returns:
        the value

      • getActiveDkimId

        public String getActiveDkimId()
        The OCID of the DKIM key that will be used to sign mail sent from this email domain.
        Returns:
        the value

      • getIsSpf

        public Boolean getIsSpf()
        Value of the SPF field.

        For more information about SPF, please see SPF Authentication.

        Returns:
        the value

      • getDomainVerificationStatus

        public DomainVerificationStatusType getDomainVerificationStatus()
        The current domain verification status.
        Returns:
        the value

      • getDomainVerificationId

        public String getDomainVerificationId()
        Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of an email domain.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the email domain was created, expressed in RFC 3339 timestamp format, “YYYY-MM-ddThh:mmZ”.

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

        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

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        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