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

Segment group definition.

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() List of dimensions to include or exclude.
List<SegmentReference>	getSourceSegments() The base segment that you build your segment on.
String	getSourceType() Specify how to handle multiple source segments.
String	getType() Specify how to handle multiple segment dimensions.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDimensions(Collection<SegmentDimensions> dimensions) List of dimensions to include or exclude.
void	setSourceSegments(Collection<SegmentReference> sourceSegments) The base segment that you build your segment on.
void	setSourceType(String sourceType) Specify how to handle multiple source segments.
void	setType(String type) Specify how to handle multiple segment dimensions.
String	toString() Returns a string representation of this object.
SegmentGroup	withDimensions(Collection<SegmentDimensions> dimensions) List of dimensions to include or exclude.
SegmentGroup	withDimensions(SegmentDimensions... dimensions) List of dimensions to include or exclude.
SegmentGroup	withSourceSegments(Collection<SegmentReference> sourceSegments) The base segment that you build your segment on.
SegmentGroup	withSourceSegments(SegmentReference... sourceSegments) The base segment that you build your segment on.
SegmentGroup	withSourceType(SourceType sourceType) Specify how to handle multiple source segments.
SegmentGroup	withSourceType(String sourceType) Specify how to handle multiple source segments.
SegmentGroup	withType(String type) Specify how to handle multiple segment dimensions.
SegmentGroup	withType(Type type) Specify how to handle multiple segment dimensions.

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()

List of dimensions to include or exclude.

Returns:

List of dimensions to include or exclude.

setDimensions

public void setDimensions(Collection<SegmentDimensions> dimensions)

List of dimensions to include or exclude.

Parameters:

dimensions - List of dimensions to include or exclude.

withDimensions

public SegmentGroup withDimensions(SegmentDimensions... dimensions)

List of dimensions to include or exclude.

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 - List of dimensions to include or exclude.

Returns:

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

withDimensions

public SegmentGroup withDimensions(Collection<SegmentDimensions> dimensions)

List of dimensions to include or exclude.

Parameters:

dimensions - List of dimensions to include or exclude.

Returns:

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

getSourceSegments

public List<SegmentReference> getSourceSegments()

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.

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.

setSourceSegments

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

Parameters:

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.

withSourceSegments

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

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 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.

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 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.

Parameters:

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.

Returns:

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

setSourceType

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

Parameters:

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.

See Also:

SourceType

getSourceType

public String getSourceType()

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.

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

withSourceType

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

Parameters:

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.

Returns:

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

See Also:

SourceType

withSourceType

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

Parameters:

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.

Returns:

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

See Also:

SourceType

setType

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

Parameters:

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.

See Also:

Type

getType

public String getType()

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.

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

withType

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

Parameters:

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.

Returns:

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

See Also:

Type

withType

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

Parameters:

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.

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