Class GetConfiguredAudienceModelResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetConfiguredAudienceModelResponse.Builder,
GetConfiguredAudienceModelResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) of the audience model used for this configured audience model.final AudienceSizeConfig
The list of output sizes of audiences that can be created using this configured audience model.builder()
final TagOnCreatePolicy
Provides thechildResourceTagOnCreatePolicy
that was used for this configured audience model.final String
Provides thechildResourceTagOnCreatePolicy
that was used for this configured audience model.final String
The Amazon Resource Name (ARN) of the configured audience model.final Instant
The time at which the configured audience model was created.final String
The description of the configured audience model.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SharedAudienceMetrics property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
The minimum number of users from the seed audience that must match with users in the training data of the audience model.final String
name()
The name of the configured audience model.The output configuration of the configured audience modelstatic Class
<? extends GetConfiguredAudienceModelResponse.Builder> final List
<SharedAudienceMetrics> Whether audience metrics are shared.Whether audience metrics are shared.status()
The status of the configured audience model.final String
The status of the configured audience model.tags()
The tags that are associated to this configured audience model.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The most recent time at which the configured audience model was updated.Methods inherited from class software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createTime
The time at which the configured audience model was created.
- Returns:
- The time at which the configured audience model was created.
-
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
The Amazon Resource Name (ARN) of the configured audience model.
- Returns:
- The Amazon Resource Name (ARN) of the configured audience model.
-
name
The name of the configured audience model.
- Returns:
- The name of the configured audience model.
-
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
The output configuration of the configured audience model
- Returns:
- The output configuration of the configured audience model
-
description
The description of the configured audience model.
- Returns:
- The description of the configured audience model.
-
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 returnConfiguredAudienceModelStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the configured audience model.
- See Also:
-
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 returnConfiguredAudienceModelStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the configured audience model.
- See Also:
-
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
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 theABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use thePercentage
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 theABSOLUTE
AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use thePercentage
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 theisEmpty()
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
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
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 returnTagOnCreatePolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildResourceTagOnCreatePolicyAsString()
.- Returns:
- Provides the
childResourceTagOnCreatePolicy
that was used for this configured audience model. - See Also:
-
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 returnTagOnCreatePolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildResourceTagOnCreatePolicyAsString()
.- Returns:
- Provides the
childResourceTagOnCreatePolicy
that was used for this configured audience model. - See Also:
-
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 interfaceToCopyableBuilder<GetConfiguredAudienceModelResponse.Builder,
GetConfiguredAudienceModelResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetConfiguredAudienceModelResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-