software.amazon.awssdk.services.workmail.model

Class GetMailDomainResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.workmail.model.WorkMailResponse

software.amazon.awssdk.services.workmail.model.GetMailDomainResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMailDomainResponse.Builder,GetMailDomainResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMailDomainResponse
extends WorkMailResponse
implements ToCopyableBuilder<GetMailDomainResponse.Builder,GetMailDomainResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMailDomainResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetMailDomainResponse.Builder	builder()
DnsRecordVerificationStatus	dkimVerificationStatus() Indicates the status of a DKIM verification.
String	dkimVerificationStatusAsString() Indicates the status of a DKIM verification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecords() For responses, this returns true if the service returned a value for the Records property.
Boolean	isDefault() Specifies whether the domain is the default domain for your organization.
Boolean	isTestDomain() Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
DnsRecordVerificationStatus	ownershipVerificationStatus() Indicates the status of the domain ownership verification.
String	ownershipVerificationStatusAsString() Indicates the status of the domain ownership verification.
List<DnsRecord>	records() A list of the DNS records that Amazon WorkMail recommends adding in your DNS provider for the best user experience.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMailDomainResponse.Builder>	serializableBuilderClass()
GetMailDomainResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.workmail.model.WorkMailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasRecords

public final boolean hasRecords()

For responses, this returns true if the service returned a value for the Records property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

records

public final List<DnsRecord> records()

A list of the DNS records that Amazon WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.

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 hasRecords() method.

Returns:

A list of the DNS records that Amazon WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.

isTestDomain

public final Boolean isTestDomain()

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

Returns:

Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

isDefault

public final Boolean isDefault()

Specifies whether the domain is the default domain for your organization.

Returns:

Specifies whether the domain is the default domain for your organization.

ownershipVerificationStatus

public final DnsRecordVerificationStatus ownershipVerificationStatus()

Indicates the status of the domain ownership verification.

If the service returns an enum value that is not available in the current SDK version, ownershipVerificationStatus will return DnsRecordVerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownershipVerificationStatusAsString().

Returns:

Indicates the status of the domain ownership verification.

See Also:

DnsRecordVerificationStatus

ownershipVerificationStatusAsString

public final String ownershipVerificationStatusAsString()

Indicates the status of the domain ownership verification.

If the service returns an enum value that is not available in the current SDK version, ownershipVerificationStatus will return DnsRecordVerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownershipVerificationStatusAsString().

Returns:

Indicates the status of the domain ownership verification.

See Also:

DnsRecordVerificationStatus

dkimVerificationStatus

public final DnsRecordVerificationStatus dkimVerificationStatus()

Indicates the status of a DKIM verification.

If the service returns an enum value that is not available in the current SDK version, dkimVerificationStatus will return DnsRecordVerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dkimVerificationStatusAsString().

Returns:

Indicates the status of a DKIM verification.

See Also:

DnsRecordVerificationStatus

dkimVerificationStatusAsString

public final String dkimVerificationStatusAsString()

Indicates the status of a DKIM verification.

If the service returns an enum value that is not available in the current SDK version, dkimVerificationStatus will return DnsRecordVerificationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dkimVerificationStatusAsString().

Returns:

Indicates the status of a DKIM verification.

See Also:

DnsRecordVerificationStatus

toBuilder

public GetMailDomainResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMailDomainResponse.Builder,GetMailDomainResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetMailDomainResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetMailDomainResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo