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

Class GetAudienceGenerationJobResponse

    • Method Detail

      • audienceGenerationJobArn

        public final String audienceGenerationJobArn()

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

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

      • collaborationId

        public final String collaborationId()

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

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

      • configuredAudienceModelArn

        public final String configuredAudienceModelArn()

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

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

      • createTime

        public final Instant createTime()

        The time at which the audience generation job was created.

        Returns:
        The time at which the audience generation job was created.

      • description

        public final String description()

        The description of the audience generation job.

        Returns:
        The description of the audience generation job.

      • includeSeedInOutput

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

        Returns:
        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.

      • metrics

        public final AudienceQualityMetrics metrics()

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

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

      • name

        public final String name()

        The name of the audience generation job.

        Returns:
        The name of the audience generation job.

      • seedAudience

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

        Returns:
        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.

      • startedBy

        public final String startedBy()

        The AWS account that started this audience generation job.

        Returns:
        The AWS account that started this audience generation job.

      • statusDetails

        public final StatusDetails statusDetails()

        Details about the status of the audience generation job.

        Returns:
        Details about the status of the audience generation job.

      • 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 that are associated to this audience generation job.

        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 that are associated to this audience generation job.

      • updateTime

        public final Instant updateTime()

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

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

      • 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