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

Interface GetDomainResponse.Builder

    • Method Detail

      • domainName

        GetDomainResponse.Builder domainName​(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.

      • defaultExpirationDays

        GetDomainResponse.Builder defaultExpirationDays​(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.

      • defaultEncryptionKey

        GetDomainResponse.Builder defaultEncryptionKey​(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.

        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deadLetterQueueUrl

        GetDomainResponse.Builder deadLetterQueueUrl​(String deadLetterQueueUrl)

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

        Parameters:
        deadLetterQueueUrl - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stats

        GetDomainResponse.Builder stats​(DomainStats stats)

        Usage-specific statistics about the domain.

        Parameters:
        stats - Usage-specific statistics about the domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • matching

        GetDomainResponse.Builder matching​(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.

        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.

      • matching

        default GetDomainResponse.Builder matching​(Consumer<MatchingResponse.Builder> 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.

        This is a convenience method that creates an instance of the MatchingResponse.Builder avoiding the need to create one manually via MatchingResponse.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matching(MatchingResponse).

        Parameters:
        matching - a consumer that will call methods on MatchingResponse.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        matching(MatchingResponse)

      • ruleBasedMatching

        GetDomainResponse.Builder ruleBasedMatching​(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.

        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.

      • createdAt

        GetDomainResponse.Builder createdAt​(Instant createdAt)

        The timestamp of when the domain was created.

        Parameters:
        createdAt - The timestamp of when the domain was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedAt

        GetDomainResponse.Builder lastUpdatedAt​(Instant lastUpdatedAt)

        The timestamp of when the domain was most recently edited.

        Parameters:
        lastUpdatedAt - The timestamp of when the domain was most recently edited.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GetDomainResponse.Builder tags​(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.