software.amazon.awssdk.services.pinpoint.model

Class SetDimension

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<SetDimension.Builder,SetDimension>

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

Dimension specification of a segment.

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 dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment.
String	dimensionTypeAsString() The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends SetDimension.Builder>	serializableBuilderClass()
SetDimension.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<String>	values() The criteria values for the segment dimension.

Methods inherited from class java.lang.Object

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 dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. 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 dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

See Also:

DimensionType

dimensionTypeAsString

public String dimensionTypeAsString()

The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. 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 dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

See Also:

DimensionType

values

public List<String> values()

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

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

Returns:

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

toBuilder

public SetDimension.Builder 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 interface ToCopyableBuilder<SetDimension.Builder,SetDimension>

Returns:

a builder for type T

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

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.