Class DkimAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DkimAttributes.Builder,
DkimAttributes>
An object that contains information about the DKIM configuration for an email identity.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DkimAttributes.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Tokens property.static Class
<? extends DkimAttributes.Builder> final Boolean
If the value istrue
, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed.final DkimStatus
status()
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain.final String
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain.Take this object and create a builder that contains all of the current property values of this object.tokens()
A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
signingEnabled
If the value is
true
, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value isfalse
, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.- Returns:
- If the value is
true
, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value isfalse
, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.
-
status
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
-
PENDING
– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them. -
SUCCESS
– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity. -
FAILED
– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain. -
NOT_STARTED
– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDkimStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for
the domain. The status can be one of the following:
-
PENDING
– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them. -
SUCCESS
– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity. -
FAILED
– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain. -
NOT_STARTED
– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
-
- See Also:
-
-
statusAsString
Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
-
PENDING
– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them. -
SUCCESS
– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity. -
FAILED
– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain. -
NOT_STARTED
– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDkimStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for
the domain. The status can be one of the following:
-
PENDING
– Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them. -
SUCCESS
– Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity. -
FAILED
– Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain. -
NOT_STARTED
– Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.
-
- See Also:
-
-
hasTokens
public final boolean hasTokens()For responses, this returns true if the service returned a value for the Tokens property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tokens
A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTokens()
method.- Returns:
- A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DkimAttributes.Builder,
DkimAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-