com.amazonaws.services.pinpoint.model

Class AttributeDimension

java.lang.Object

com.amazonaws.services.pinpoint.model.AttributeDimension

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies attribute-based criteria for including or excluding endpoints from a segment.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeDimension()

Method Summary

Modifier and Type	Method and Description
AttributeDimension	clone()
boolean	equals(Object obj)
String	getAttributeType() The type of segment dimension to use.
List<String>	getValues() The criteria values to use for the segment dimension.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttributeType(AttributeType attributeType) The type of segment dimension to use.
void	setAttributeType(String attributeType) The type of segment dimension to use.
void	setValues(Collection<String> values) The criteria values to use for the segment dimension.
String	toString() Returns a string representation of this object.
AttributeDimension	withAttributeType(AttributeType attributeType) The type of segment dimension to use.
AttributeDimension	withAttributeType(String attributeType) The type of segment dimension to use.
AttributeDimension	withValues(Collection<String> values) The criteria values to use for the segment dimension.
AttributeDimension	withValues(String... values) The criteria values to use for the segment dimension.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeDimension

public AttributeDimension()

Method Detail

setAttributeType

public void setAttributeType(String attributeType)

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Parameters:

attributeType - The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

See Also:

AttributeType

getAttributeType

public String getAttributeType()

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Returns:

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

See Also:

AttributeType

withAttributeType

public AttributeDimension withAttributeType(String attributeType)

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Parameters:

attributeType - The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Returns:

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

See Also:

AttributeType

setAttributeType

public void setAttributeType(AttributeType attributeType)

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Parameters:

attributeType - The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

See Also:

AttributeType

withAttributeType

public AttributeDimension withAttributeType(AttributeType attributeType)

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Parameters:

attributeType - The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Returns:

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

See Also:

AttributeType

getValues

public List<String> getValues()

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

Returns:

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

setValues

public void setValues(Collection<String> values)

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

Parameters:

values - The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

withValues

public AttributeDimension withValues(String... values)

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

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

Parameters:

values - The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

Returns:

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

withValues

public AttributeDimension withValues(Collection<String> values)

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

Parameters:

values - The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

Returns:

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

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

Overrides:

clone in class Object

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.