com.amazonaws.services.customerprofiles.model

Class UpdateDomainRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.customerprofiles.model.UpdateDomainRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDomainRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateDomainRequest()

Method Summary

Modifier and Type	Method and Description
UpdateDomainRequest	addTagsEntry(String key, String value) Add a single Tags entry
UpdateDomainRequest	clearTagsEntries() Removes all the entries added into Tags.
UpdateDomainRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDeadLetterQueueUrl() The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
String	getDefaultEncryptionKey() The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
Integer	getDefaultExpirationDays() The default number of days until the data within the domain expires.
String	getDomainName() The unique name of the domain.
MatchingRequest	getMatching() The process of matching duplicate profiles.
RuleBasedMatchingRequest	getRuleBasedMatching() The process of matching duplicate profiles using the rule-Based matching.
Map<String,String>	getTags() The tags used to organize, track, or control access for this resource.
int	hashCode()
void	setDeadLetterQueueUrl(String deadLetterQueueUrl) The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
void	setDefaultEncryptionKey(String defaultEncryptionKey) The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
void	setDefaultExpirationDays(Integer defaultExpirationDays) The default number of days until the data within the domain expires.
void	setDomainName(String domainName) The unique name of the domain.
void	setMatching(MatchingRequest matching) The process of matching duplicate profiles.
void	setRuleBasedMatching(RuleBasedMatchingRequest ruleBasedMatching) The process of matching duplicate profiles using the rule-Based matching.
void	setTags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.
String	toString() Returns a string representation of this object.
UpdateDomainRequest	withDeadLetterQueueUrl(String deadLetterQueueUrl) The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
UpdateDomainRequest	withDefaultEncryptionKey(String defaultEncryptionKey) The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
UpdateDomainRequest	withDefaultExpirationDays(Integer defaultExpirationDays) The default number of days until the data within the domain expires.
UpdateDomainRequest	withDomainName(String domainName) The unique name of the domain.
UpdateDomainRequest	withMatching(MatchingRequest matching) The process of matching duplicate profiles.
UpdateDomainRequest	withRuleBasedMatching(RuleBasedMatchingRequest ruleBasedMatching) The process of matching duplicate profiles using the rule-Based matching.
UpdateDomainRequest	withTags(Map<String,String> tags) The tags used to organize, track, or control access for this resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDomainRequest

public UpdateDomainRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

getDomainName

public String getDomainName()

The unique name of the domain.

Returns:

The unique name of the domain.

withDomainName

public UpdateDomainRequest withDomainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultExpirationDays

public void setDefaultExpirationDays(Integer defaultExpirationDays)

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

Parameters:

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

getDefaultExpirationDays

public Integer getDefaultExpirationDays()

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.

withDefaultExpirationDays

public UpdateDomainRequest withDefaultExpirationDays(Integer defaultExpirationDays)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultEncryptionKey

public void setDefaultEncryptionKey(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. If specified as an empty string, it will clear any existing value.

Parameters:

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. If specified as an empty string, it will clear any existing value.

getDefaultEncryptionKey

public String getDefaultEncryptionKey()

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. If specified as an empty string, it will clear any existing value.

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. If specified as an empty string, it will clear any existing value.

withDefaultEncryptionKey

public UpdateDomainRequest withDefaultEncryptionKey(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. If specified as an empty string, it will clear any existing value.

Parameters:

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. If specified as an empty string, it will clear any existing value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeadLetterQueueUrl

public void setDeadLetterQueueUrl(String deadLetterQueueUrl)

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. 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.

Parameters:

deadLetterQueueUrl - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. 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.

getDeadLetterQueueUrl

public String getDeadLetterQueueUrl()

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. 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. If specified as an empty string, it will clear any existing value. 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.

withDeadLetterQueueUrl

public UpdateDomainRequest withDeadLetterQueueUrl(String deadLetterQueueUrl)

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. 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.

Parameters:

deadLetterQueueUrl - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. 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:

Returns a reference to this object so that method calls can be chained together.

setMatching

public void setMatching(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.

Parameters:

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.

getMatching

public MatchingRequest getMatching()

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.

withMatching

public UpdateDomainRequest withMatching(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRuleBasedMatching

public void setRuleBasedMatching(RuleBasedMatchingRequest 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.

Parameters:

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.

getRuleBasedMatching

public RuleBasedMatchingRequest getRuleBasedMatching()

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.

withRuleBasedMatching

public UpdateDomainRequest withRuleBasedMatching(RuleBasedMatchingRequest 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

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

Returns:

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

setTags

public void setTags(Map<String,String> tags)

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

Parameters:

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

withTags

public UpdateDomainRequest withTags(Map<String,String> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public UpdateDomainRequest addTagsEntry(String key,
                                        String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public UpdateDomainRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateDomainRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()