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

Class AudienceSizeConfig

java.lang.Object

software.amazon.awssdk.services.cleanroomsml.model.AudienceSizeConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AudienceSizeConfig.Builder,AudienceSizeConfig>

@Generated("software.amazon.awssdk:codegen")
public final class AudienceSizeConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AudienceSizeConfig.Builder,AudienceSizeConfig>

Returns the relevance scores at these audience sizes when used in the GetAudienceGenerationJob for a specified audience generation job and configured audience model.

Specifies the list of allowed audienceSize values when used in the StartAudienceExportJob for an audience generation job. 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AudienceSizeConfig.Builder

Method Summary

Modifier and Type	Method	Description
List<Integer>	audienceSizeBins()	An array of the different audience output sizes.
AudienceSizeType	audienceSizeType()	Whether the audience output sizes are defined as an absolute number or a percentage.
String	audienceSizeTypeAsString()	Whether the audience output sizes are defined as an absolute number or a percentage.
static AudienceSizeConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudienceSizeBins()	For responses, this returns true if the service returned a value for the AudienceSizeBins property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AudienceSizeConfig.Builder>	serializableBuilderClass()
AudienceSizeConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

audienceSizeType

public final AudienceSizeType audienceSizeType()

Whether the audience output sizes are defined as an absolute number or a percentage.

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

Returns:

Whether the audience output sizes are defined as an absolute number or a percentage.

See Also:

AudienceSizeType

audienceSizeTypeAsString

public final String audienceSizeTypeAsString()

Whether the audience output sizes are defined as an absolute number or a percentage.

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

Returns:

Whether the audience output sizes are defined as an absolute number or a percentage.

See Also:

AudienceSizeType

hasAudienceSizeBins

public final boolean hasAudienceSizeBins()

For responses, this returns true if the service returned a value for the AudienceSizeBins 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.

audienceSizeBins

public final List<Integer> audienceSizeBins()

An array of the different audience output sizes.

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

Returns:

An array of the different audience output sizes.

toBuilder

public AudienceSizeConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AudienceSizeConfig.Builder,AudienceSizeConfig>

builder

public static AudienceSizeConfig.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo