software.amazon.awssdk.services.pinpoint.model

Interface SegmentGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SegmentGroup.Builder,SegmentGroup>, SdkBuilder<SegmentGroup.Builder,SegmentGroup>, SdkPojo

Enclosing class:

SegmentGroup

public static interface SegmentGroup.Builder
extends SdkPojo, CopyableBuilder<SegmentGroup.Builder,SegmentGroup>

Method Summary

Modifier and Type	Method and Description
SegmentGroup.Builder	dimensions(Collection<SegmentDimensions> dimensions) An array that defines the dimensions for the segment.
SegmentGroup.Builder	dimensions(Consumer<SegmentDimensions.Builder>... dimensions) An array that defines the dimensions for the segment.
SegmentGroup.Builder	dimensions(SegmentDimensions... dimensions) An array that defines the dimensions for the segment.
SegmentGroup.Builder	sourceSegments(Collection<SegmentReference> sourceSegments) The base segment to build the segment on.
SegmentGroup.Builder	sourceSegments(Consumer<SegmentReference.Builder>... sourceSegments) The base segment to build the segment on.
SegmentGroup.Builder	sourceSegments(SegmentReference... sourceSegments) The base segment to build the segment on.
SegmentGroup.Builder	sourceType(SourceType sourceType) Specifies how to handle multiple base segments for the segment.
SegmentGroup.Builder	sourceType(String sourceType) Specifies how to handle multiple base segments for the segment.
SegmentGroup.Builder	type(String type) Specifies how to handle multiple dimensions for the segment.
SegmentGroup.Builder	type(Type type) Specifies how to handle multiple dimensions for the segment.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dimensions

SegmentGroup.Builder dimensions(Collection<SegmentDimensions> dimensions)

An array that defines the dimensions for the segment.

Parameters:

dimensions - An array that defines the dimensions for the segment.

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

SegmentGroup.Builder dimensions(SegmentDimensions... dimensions)

An array that defines the dimensions for the segment.

Parameters:

dimensions - An array that defines the dimensions for the segment.

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

SegmentGroup.Builder dimensions(Consumer<SegmentDimensions.Builder>... dimensions)

An array that defines the dimensions for the segment.

This is a convenience method that creates an instance of the SegmentDimensions.Builder avoiding the need to create one manually via SegmentDimensions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dimensions(List).

Parameters:

dimensions - a consumer that will call methods on SegmentDimensions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#dimensions(java.util.Collection)

sourceSegments

SegmentGroup.Builder sourceSegments(Collection<SegmentReference> sourceSegments)

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

Parameters:

sourceSegments - The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceSegments

SegmentGroup.Builder sourceSegments(SegmentReference... sourceSegments)

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

Parameters:

sourceSegments - The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceSegments

SegmentGroup.Builder sourceSegments(Consumer<SegmentReference.Builder>... sourceSegments)

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

This is a convenience method that creates an instance of the SegmentReference.Builder avoiding the need to create one manually via SegmentReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sourceSegments(List).

Parameters:

sourceSegments - a consumer that will call methods on SegmentReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#sourceSegments(java.util.Collection)

sourceType

SegmentGroup.Builder sourceType(String sourceType)

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

Parameters:

sourceType - Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SourceType, SourceType

sourceType

SegmentGroup.Builder sourceType(SourceType sourceType)

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

Parameters:

sourceType - Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SourceType, SourceType

type

SegmentGroup.Builder type(String type)

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Parameters:

type - Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type, Type

type

SegmentGroup.Builder type(Type type)

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Parameters:

type - Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type, Type