Class GetConfiguredAudienceModelResponse

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.GetConfiguredAudienceModelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetConfiguredAudienceModelResponse.Builder,GetConfiguredAudienceModelResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetConfiguredAudienceModelResponse extends CleanRoomsMlResponse implements ToCopyableBuilder<GetConfiguredAudienceModelResponse.Builder,GetConfiguredAudienceModelResponse>

  • Method Details

    • createTime

      public final Instant createTime()

      The time at which the configured audience model was created.

      Returns:
      The time at which the configured audience model was created.

    • updateTime

      public final Instant updateTime()

      The most recent time at which the configured audience model was updated.

      Returns:
      The most recent time at which the configured audience model was updated.

    • configuredAudienceModelArn

      public final String configuredAudienceModelArn()

      The Amazon Resource Name (ARN) of the configured audience model.

      Returns:
      The Amazon Resource Name (ARN) of the configured audience model.

    • name

      public final String name()

      The name of the configured audience model.

      Returns:
      The name of the configured audience model.

    • audienceModelArn

      public final String audienceModelArn()

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

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

    • outputConfig

      public final ConfiguredAudienceModelOutputConfig outputConfig()

      The output configuration of the configured audience model

      Returns:
      The output configuration of the configured audience model

    • description

      public final String description()

      The description of the configured audience model.

      Returns:
      The description of the configured audience model.

    • status

      public final ConfiguredAudienceModelStatus status()

      The status of the configured audience model.

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

      Returns:
      The status of the configured audience model.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the configured audience model.

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

      Returns:
      The status of the configured audience model.
      See Also:

    • sharedAudienceMetrics

      public final List<SharedAudienceMetrics> sharedAudienceMetrics()

      Whether audience metrics are shared.

      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 hasSharedAudienceMetrics() method.

      Returns:
      Whether audience metrics are shared.

    • hasSharedAudienceMetrics

      public final boolean hasSharedAudienceMetrics()
      For responses, this returns true if the service returned a value for the SharedAudienceMetrics 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.

    • sharedAudienceMetricsAsStrings

      public final List<String> sharedAudienceMetricsAsStrings()

      Whether audience metrics are shared.

      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 hasSharedAudienceMetrics() method.

      Returns:
      Whether audience metrics are shared.

    • minMatchingSeedSize

      public final Integer minMatchingSeedSize()

      The minimum number of users from the seed audience that must match with users in the training data of the audience model.

      Returns:
      The minimum number of users from the seed audience that must match with users in the training data of the audience model.

    • audienceSizeConfig

      public final AudienceSizeConfig audienceSizeConfig()

      The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      Returns:
      The list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

    • 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 configured audience model.

      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 configured audience model.

    • childResourceTagOnCreatePolicy

      public final TagOnCreatePolicy childResourceTagOnCreatePolicy()

      Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

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

      Returns:
      Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
      See Also:

    • childResourceTagOnCreatePolicyAsString

      public final String childResourceTagOnCreatePolicyAsString()

      Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.

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

      Returns:
      Provides the childResourceTagOnCreatePolicy that was used for this configured audience model.
      See Also:

    • toBuilder

      public GetConfiguredAudienceModelResponse.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<GetConfiguredAudienceModelResponse.Builder,GetConfiguredAudienceModelResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetConfiguredAudienceModelResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetConfiguredAudienceModelResponse.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.