Package com.oracle.bmc.email.model

Class Dkim

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public final class Dkim
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The properties that define a DKIM.
    Note: Objects should always be created or deserialized using the Dkim.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 Dkim.Builder, which maintain a set of all explicitly set fields called Dkim.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

      • builder

        public static Dkim.Builder builder()
        Create a new builder.

      • getName

        public String getName()
        The DKIM selector.

        If the same domain is managed in more than one region, each region must use different selectors.

        Returns:
        the value

      • getId

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

      • getEmailDomainId

        public String getEmailDomainId()
        The OCID of the email domain that this DKIM belongs to.
        Returns:
        the value

      • getCompartmentId

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

      • getLifecycleState

        public Dkim.LifecycleState getLifecycleState()
        The current state of the DKIM.
        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.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the DKIM.

        Avoid entering confidential information.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the DKIM 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 DKIM 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

      • getDnsSubdomainName

        public String getDnsSubdomainName()
        The name of the DNS subdomain that must be provisioned to enable email recipients to verify DKIM signatures.

        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 DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
        Returns:
        the value

      • getTxtRecordValue

        public String getTxtRecordValue()
        The DNS TXT record value to provision to the DKIM DNS subdomain in place of using a CNAME record.

        This is used in cases where a CNAME cannot be used, such as when the cnameRecordValue would exceed the maximum length for a DNS entry. You can also use this if you have an existing procedure to directly provision TXT records for DKIM. Many DNS APIs require you to break this string into segments of fewer than 255 characters.

        Returns:
        the value

      • getIsImported

        public Boolean getIsImported()
        Indicates whether the DKIM was imported.
        Returns:
        the value

      • getKeyLength

        public Integer getKeyLength()
        Length of the RSA key used in the DKIM.
        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