Package software.amazon.awssdk.services.customerprofiles.model

Class GetDomainResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

software.amazon.awssdk.services.customerprofiles.model.GetDomainResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDomainResponse.Builder,GetDomainResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetDomainResponse
extends CustomerProfilesResponse
implements ToCopyableBuilder<GetDomainResponse.Builder,GetDomainResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDomainResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetDomainResponse.Builder	builder()
Instant	createdAt()	The timestamp of when the domain was created.
String	deadLetterQueueUrl()	The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
String	defaultEncryptionKey()	The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
Integer	defaultExpirationDays()	The default number of days until the data within the domain expires.
String	domainName()	The unique name of the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Instant	lastUpdatedAt()	The timestamp of when the domain was most recently edited.
MatchingResponse	matching()	The process of matching duplicate profiles.
RuleBasedMatchingResponse	ruleBasedMatching()	The process of matching duplicate profiles using the Rule-Based matching.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDomainResponse.Builder>	serializableBuilderClass()
DomainStats	stats()	Usage-specific statistics about the domain.
Map<String,String>	tags()	The tags used to organize, track, or control access for this resource.
GetDomainResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

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

domainName

public final String domainName()

The unique name of the domain.

Returns:

The unique name of the domain.

defaultExpirationDays

public final Integer defaultExpirationDays()

The default number of days until the data within the domain expires.

Returns:

The default number of days until the data within the domain expires.

defaultEncryptionKey

public final String defaultEncryptionKey()

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

Returns:

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

deadLetterQueueUrl

public final String deadLetterQueueUrl()

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

Returns:

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

stats

public final DomainStats stats()

Usage-specific statistics about the domain.

Returns:

Usage-specific statistics about the domain.

matching

public final MatchingResponse matching()

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

Returns:

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

ruleBasedMatching

public final RuleBasedMatchingResponse ruleBasedMatching()

The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

Returns:

The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

createdAt

public final Instant createdAt()

The timestamp of when the domain was created.

Returns:

The timestamp of when the domain was created.

lastUpdatedAt

public final Instant lastUpdatedAt()

The timestamp of when the domain was most recently edited.

Returns:

The timestamp of when the domain was most recently edited.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

The tags used to organize, track, or control access for this resource.

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

Returns:

The tags used to organize, track, or control access for this resource.

toBuilder

public GetDomainResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDomainResponse.Builder,GetDomainResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetDomainResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetDomainResponse.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