Package software.amazon.awssdk.services.personalize.model

Class CreateMetricAttributionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.personalize.model.PersonalizeRequest

software.amazon.awssdk.services.personalize.model.CreateMetricAttributionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateMetricAttributionRequest.Builder,CreateMetricAttributionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateMetricAttributionRequest
extends PersonalizeRequest
implements ToCopyableBuilder<CreateMetricAttributionRequest.Builder,CreateMetricAttributionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateMetricAttributionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateMetricAttributionRequest.Builder	builder()
String	datasetGroupArn()	The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetrics()	For responses, this returns true if the service returned a value for the Metrics property.
List<MetricAttribute>	metrics()	A list of metric attributes for the metric attribution.
MetricAttributionOutput	metricsOutputConfig()	The output configuration details for the metric attribution.
String	name()	A name for the metric attribution.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateMetricAttributionRequest.Builder>	serializableBuilderClass()
CreateMetricAttributionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

A name for the metric attribution.

Returns:

A name for the metric attribution.

datasetGroupArn

public final String datasetGroupArn()

The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

Returns:

The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

hasMetrics

public final boolean hasMetrics()

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

metrics

public final List<MetricAttribute> metrics()

A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

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

Returns:

A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

metricsOutputConfig

public final MetricAttributionOutput metricsOutputConfig()

The output configuration details for the metric attribution.

Returns:

The output configuration details for the metric attribution.

toBuilder

public CreateMetricAttributionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateMetricAttributionRequest.Builder,CreateMetricAttributionRequest>

Specified by:

toBuilder in class PersonalizeRequest

builder

public static CreateMetricAttributionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo