Package software.amazon.awssdk.services.cleanroomsml.model

Interface GetAudienceGenerationJobResponse.Builder

    • Method Detail

      • createTime

        GetAudienceGenerationJobResponse.Builder createTime​(Instant createTime)

        The time at which the audience generation job was created.

        Parameters:
        createTime - The time at which the audience generation job was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • updateTime

        GetAudienceGenerationJobResponse.Builder updateTime​(Instant updateTime)

        The most recent time at which the audience generation job was updated.

        Parameters:
        updateTime - The most recent time at which the audience generation job was updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • audienceGenerationJobArn

        GetAudienceGenerationJobResponse.Builder audienceGenerationJobArn​(String audienceGenerationJobArn)

        The Amazon Resource Name (ARN) of the audience generation job.

        Parameters:
        audienceGenerationJobArn - The Amazon Resource Name (ARN) of the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        GetAudienceGenerationJobResponse.Builder name​(String name)

        The name of the audience generation job.

        Parameters:
        name - The name of the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        GetAudienceGenerationJobResponse.Builder description​(String description)

        The description of the audience generation job.

        Parameters:
        description - The description of the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusDetails

        GetAudienceGenerationJobResponse.Builder statusDetails​(StatusDetails statusDetails)

        Details about the status of the audience generation job.

        Parameters:
        statusDetails - Details about the status of the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • configuredAudienceModelArn

        GetAudienceGenerationJobResponse.Builder configuredAudienceModelArn​(String configuredAudienceModelArn)

        The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.

        Parameters:
        configuredAudienceModelArn - The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • seedAudience

        GetAudienceGenerationJobResponse.Builder seedAudience​(AudienceGenerationJobDataSource seedAudience)

        The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.

        Parameters:
        seedAudience - The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeSeedInOutput

        GetAudienceGenerationJobResponse.Builder includeSeedInOutput​(Boolean includeSeedInOutput)

        Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.

        Parameters:
        includeSeedInOutput - Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify TRUE, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first minimumSeedSize count of users are from the seed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • collaborationId

        GetAudienceGenerationJobResponse.Builder collaborationId​(String collaborationId)

        The identifier of the collaboration that this audience generation job is associated with.

        Parameters:
        collaborationId - The identifier of the collaboration that this audience generation job is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metrics

        GetAudienceGenerationJobResponse.Builder metrics​(AudienceQualityMetrics metrics)

        The relevance scores for different audience sizes and the recall score of the generated audience.

        Parameters:
        metrics - The relevance scores for different audience sizes and the recall score of the generated audience.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startedBy

        GetAudienceGenerationJobResponse.Builder startedBy​(String startedBy)

        The AWS account that started this audience generation job.

        Parameters:
        startedBy - The AWS account that started this audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        GetAudienceGenerationJobResponse.Builder tags​(Map<String,​String> tags)

        The tags that are associated to this audience generation job.

        Parameters:
        tags - The tags that are associated to this audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • protectedQueryIdentifier

        GetAudienceGenerationJobResponse.Builder protectedQueryIdentifier​(String protectedQueryIdentifier)

        The unique identifier of the protected query for this audience generation job.

        Parameters:
        protectedQueryIdentifier - The unique identifier of the protected query for this audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.