Class GetAudienceGenerationJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse
software.amazon.awssdk.services.cleanroomsml.model.GetAudienceGenerationJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAudienceGenerationJobResponse.Builder,GetAudienceGenerationJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetAudienceGenerationJobResponse extends CleanRoomsMlResponse implements ToCopyableBuilder<GetAudienceGenerationJobResponse.Builder,GetAudienceGenerationJobResponse>

  • Method Details

    • 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.

    • 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.

    • 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.

    • name

      public final String name()

      The name of the audience generation job.

      Returns:
      The name of the audience generation job.

    • description

      public final String description()

      The description of the audience generation job.

      Returns:
      The description of the audience generation job.

    • status

      public final AudienceGenerationJobStatus status()

      The status of the audience generation job.

      If the service returns an enum value that is not available in the current SDK version, status will return AudienceGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the audience generation job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the audience generation job.

      If the service returns an enum value that is not available in the current SDK version, status will return AudienceGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the audience generation job.
      See Also:

    • statusDetails

      public final StatusDetails statusDetails()

      Details about the status of the audience generation job.

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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • startedBy

      public final String startedBy()

      The AWS account that started this audience generation job.

      Returns:
      The AWS account that started this 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.

    • protectedQueryIdentifier

      public final String protectedQueryIdentifier()

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

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

    • toBuilder

      public GetAudienceGenerationJobResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetAudienceGenerationJobResponse.Builder,GetAudienceGenerationJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetAudienceGenerationJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.