com.amazonaws.services.pinpoint.model

Class SegmentGroup

java.lang.Object

com.amazonaws.services.pinpoint.model.SegmentGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SegmentGroup
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SegmentGroup()

Method Summary

Modifier and Type	Method and Description
SegmentGroup	clone()
boolean	equals(Object obj)
List<SegmentDimensions>	getDimensions() An array that defines the dimensions for the segment.
List<SegmentReference>	getSourceSegments() The base segment to build the segment on.
String	getSourceType() Specifies how to handle multiple base segments for the segment.
String	getType() Specifies how to handle multiple dimensions for the segment.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDimensions(Collection<SegmentDimensions> dimensions) An array that defines the dimensions for the segment.
void	setSourceSegments(Collection<SegmentReference> sourceSegments) The base segment to build the segment on.
void	setSourceType(String sourceType) Specifies how to handle multiple base segments for the segment.
void	setType(String type) Specifies how to handle multiple dimensions for the segment.
String	toString() Returns a string representation of this object.
SegmentGroup	withDimensions(Collection<SegmentDimensions> dimensions) An array that defines the dimensions for the segment.
SegmentGroup	withDimensions(SegmentDimensions... dimensions) An array that defines the dimensions for the segment.
SegmentGroup	withSourceSegments(Collection<SegmentReference> sourceSegments) The base segment to build the segment on.
SegmentGroup	withSourceSegments(SegmentReference... sourceSegments) The base segment to build the segment on.
SegmentGroup	withSourceType(SourceType sourceType) Specifies how to handle multiple base segments for the segment.
SegmentGroup	withSourceType(String sourceType) Specifies how to handle multiple base segments for the segment.
SegmentGroup	withType(String type) Specifies how to handle multiple dimensions for the segment.
SegmentGroup	withType(Type type) Specifies how to handle multiple dimensions for the segment.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SegmentGroup

public SegmentGroup()

Method Detail

getDimensions

public List<SegmentDimensions> getDimensions()

An array that defines the dimensions for the segment.

Returns:

An array that defines the dimensions for the segment.

setDimensions

public void setDimensions(Collection<SegmentDimensions> dimensions)

An array that defines the dimensions for the segment.

Parameters:

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

withDimensions

public SegmentGroup withDimensions(SegmentDimensions... dimensions)

An array that defines the dimensions for the segment.

NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.

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.

withDimensions

public SegmentGroup withDimensions(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.

getSourceSegments

public List<SegmentReference> getSourceSegments()

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:

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.

setSourceSegments

public void setSourceSegments(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.

withSourceSegments

public SegmentGroup withSourceSegments(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.

NOTE: This method appends the values to the existing list (if any). Use setSourceSegments(java.util.Collection) or withSourceSegments(java.util.Collection) if you want to override the existing values.

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.

withSourceSegments

public SegmentGroup withSourceSegments(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.

setSourceType

public void setSourceType(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.

See Also:

SourceType

getSourceType

public String getSourceType()

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:

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.

See Also:

SourceType

withSourceType

public SegmentGroup withSourceType(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

withSourceType

public SegmentGroup withSourceType(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

setType

public void setType(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.

See Also:

Type

getType

public String getType()

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:

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.

See Also:

Type

withType

public SegmentGroup withType(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

withType

public SegmentGroup withType(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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SegmentGroup clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo