software.amazon.awssdk.services.pinpoint.model

Class SegmentGroup

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SegmentGroup

All Implemented Interfaces:

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

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

Segment group definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SegmentGroup.Builder

Method Summary

Modifier and Type	Method and Description
static SegmentGroup.Builder	builder()
List<SegmentDimensions>	dimensions() List of dimensions to include or exclude.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SegmentGroup.Builder>	serializableBuilderClass()
List<SegmentReference>	sourceSegments() The base segment that you build your segment on.
SourceType	sourceType() Specify how to handle multiple source segments.
String	sourceTypeAsString() Specify how to handle multiple source segments.
SegmentGroup.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Type	type() Specify how to handle multiple segment dimensions.
String	typeAsString() Specify how to handle multiple segment dimensions.

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

dimensions

public List<SegmentDimensions> dimensions()

List of dimensions to include or exclude.

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

Returns:

List of dimensions to include or exclude.

sourceSegments

public List<SegmentReference> sourceSegments()

The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.

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

Returns:

The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.

sourceType

public SourceType sourceType()

Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.

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

Returns:

Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.

See Also:

SourceType

sourceTypeAsString

public String sourceTypeAsString()

Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.

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

Returns:

Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.

See Also:

SourceType

type

public Type type()

Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.

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

Returns:

Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.

See Also:

Type

typeAsString

public String typeAsString()

Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.

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

Returns:

Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.

See Also:

Type

toBuilder

public SegmentGroup.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<SegmentGroup.Builder,SegmentGroup>

Returns:

a builder for type T

builder

public static SegmentGroup.Builder builder()

serializableBuilderClass

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.