software.amazon.awssdk.services.pinpoint.model

Class SetDimension

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SetDimension

All Implemented Interfaces:

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

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

Specifies the dimension type and values for a segment dimension.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetDimension.Builder

Method Summary

Modifier and Type	Method and Description
static SetDimension.Builder	builder()
DimensionType	dimensionType() The type of segment dimension to use.
String	dimensionTypeAsString() The type of segment dimension to use.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends SetDimension.Builder>	serializableBuilderClass()
SetDimension.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The criteria values to use for the segment dimension.

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

dimensionType

public DimensionType dimensionType()

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

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

Returns:

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

See Also:

DimensionType

dimensionTypeAsString

public String dimensionTypeAsString()

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

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

Returns:

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

See Also:

DimensionType

hasValues

public boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

public List<String> values()

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasValues() to see if a value was sent in this field.

Returns:

The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

toBuilder

public SetDimension.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetDimension.Builder,SetDimension>

builder

public static SetDimension.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo