software.amazon.awssdk.services.customerprofiles.model

Class CreateDomainRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest

software.amazon.awssdk.services.customerprofiles.model.CreateDomainRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDomainRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDomainRequest.Builder	builder()
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.
MatchingRequest	matching() The process of matching duplicate profiles.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDomainRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags used to organize, track, or control access for this resource.
CreateDomainRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

Returns:

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

matching

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

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 CreateDomainRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDomainRequest.Builder,CreateDomainRequest>

Specified by:

toBuilder in class CustomerProfilesRequest

builder

public static CreateDomainRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo