Package software.amazon.awssdk.services.customerprofiles.model

Class Dimension

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.Dimension

All Implemented Interfaces:

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

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

Object that holds what profile and calculated attributes to segment on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Dimension.Builder
static class	Dimension.Type

Method Summary

Modifier and Type	Method	Description
static Dimension.Builder	builder()
Map<String,CalculatedAttributeDimension>	calculatedAttributes()	Object that holds the calculated attributes to segment on.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static Dimension	fromCalculatedAttributes(Map<String,CalculatedAttributeDimension> calculatedAttributes)	Create an instance of this class with calculatedAttributes() initialized to the given value.
static Dimension	fromProfileAttributes(Consumer<ProfileAttributes.Builder> profileAttributes)	Create an instance of this class with profileAttributes() initialized to the given value.
static Dimension	fromProfileAttributes(ProfileAttributes profileAttributes)	Create an instance of this class with profileAttributes() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCalculatedAttributes()	For responses, this returns true if the service returned a value for the CalculatedAttributes property.
int	hashCode()
ProfileAttributes	profileAttributes()	Object that holds the profile attributes to segment on.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Dimension.Builder>	serializableBuilderClass()
Dimension.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Dimension.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

profileAttributes

public final ProfileAttributes profileAttributes()

Object that holds the profile attributes to segment on.

Returns:

Object that holds the profile attributes to segment on.

hasCalculatedAttributes

public final boolean hasCalculatedAttributes()

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

calculatedAttributes

public final Map<String,CalculatedAttributeDimension> calculatedAttributes()

Object that holds the calculated attributes to segment on.

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

Returns:

Object that holds the calculated attributes to segment on.

toBuilder

public Dimension.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Dimension.Builder,Dimension>

builder

public static Dimension.Builder builder()

serializableBuilderClass

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

fromProfileAttributes

public static Dimension fromProfileAttributes(ProfileAttributes profileAttributes)

Create an instance of this class with profileAttributes() initialized to the given value.

Object that holds the profile attributes to segment on.

Parameters:

profileAttributes - Object that holds the profile attributes to segment on.

fromProfileAttributes

public static Dimension fromProfileAttributes(Consumer<ProfileAttributes.Builder> profileAttributes)

Create an instance of this class with profileAttributes() initialized to the given value.

Object that holds the profile attributes to segment on.

Parameters:

profileAttributes - Object that holds the profile attributes to segment on.

fromCalculatedAttributes

public static Dimension fromCalculatedAttributes(Map<String,CalculatedAttributeDimension> calculatedAttributes)

Create an instance of this class with calculatedAttributes() initialized to the given value.

Object that holds the calculated attributes to segment on.

Parameters:

calculatedAttributes - Object that holds the calculated attributes to segment on.

type

public Dimension.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Dimension.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Dimension.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo