@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TopicFilter extends Object implements Serializable, Cloneable, StructuredPojo
A structure that represents a filter used to select items for a topic.
Constructor and Description |
---|
TopicFilter() |
Modifier and Type | Method and Description |
---|---|
TopicFilter |
clone() |
boolean |
equals(Object obj) |
TopicCategoryFilter |
getCategoryFilter()
The category filter that is associated with this filter.
|
TopicDateRangeFilter |
getDateRangeFilter()
The date range filter.
|
String |
getFilterClass()
The class of the filter.
|
String |
getFilterDescription()
A description of the filter used to select items for a topic.
|
String |
getFilterName()
The name of the filter.
|
List<String> |
getFilterSynonyms()
The other names or aliases for the filter.
|
String |
getFilterType()
The type of the filter.
|
TopicNumericEqualityFilter |
getNumericEqualityFilter()
The numeric equality filter.
|
TopicNumericRangeFilter |
getNumericRangeFilter()
The numeric range filter.
|
String |
getOperandFieldName()
The name of the field that the filter operates on.
|
TopicRelativeDateFilter |
getRelativeDateFilter()
The relative date filter.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCategoryFilter(TopicCategoryFilter categoryFilter)
The category filter that is associated with this filter.
|
void |
setDateRangeFilter(TopicDateRangeFilter dateRangeFilter)
The date range filter.
|
void |
setFilterClass(String filterClass)
The class of the filter.
|
void |
setFilterDescription(String filterDescription)
A description of the filter used to select items for a topic.
|
void |
setFilterName(String filterName)
The name of the filter.
|
void |
setFilterSynonyms(Collection<String> filterSynonyms)
The other names or aliases for the filter.
|
void |
setFilterType(String filterType)
The type of the filter.
|
void |
setNumericEqualityFilter(TopicNumericEqualityFilter numericEqualityFilter)
The numeric equality filter.
|
void |
setNumericRangeFilter(TopicNumericRangeFilter numericRangeFilter)
The numeric range filter.
|
void |
setOperandFieldName(String operandFieldName)
The name of the field that the filter operates on.
|
void |
setRelativeDateFilter(TopicRelativeDateFilter relativeDateFilter)
The relative date filter.
|
String |
toString()
Returns a string representation of this object.
|
TopicFilter |
withCategoryFilter(TopicCategoryFilter categoryFilter)
The category filter that is associated with this filter.
|
TopicFilter |
withDateRangeFilter(TopicDateRangeFilter dateRangeFilter)
The date range filter.
|
TopicFilter |
withFilterClass(FilterClass filterClass)
The class of the filter.
|
TopicFilter |
withFilterClass(String filterClass)
The class of the filter.
|
TopicFilter |
withFilterDescription(String filterDescription)
A description of the filter used to select items for a topic.
|
TopicFilter |
withFilterName(String filterName)
The name of the filter.
|
TopicFilter |
withFilterSynonyms(Collection<String> filterSynonyms)
The other names or aliases for the filter.
|
TopicFilter |
withFilterSynonyms(String... filterSynonyms)
The other names or aliases for the filter.
|
TopicFilter |
withFilterType(NamedFilterType filterType)
The type of the filter.
|
TopicFilter |
withFilterType(String filterType)
The type of the filter.
|
TopicFilter |
withNumericEqualityFilter(TopicNumericEqualityFilter numericEqualityFilter)
The numeric equality filter.
|
TopicFilter |
withNumericRangeFilter(TopicNumericRangeFilter numericRangeFilter)
The numeric range filter.
|
TopicFilter |
withOperandFieldName(String operandFieldName)
The name of the field that the filter operates on.
|
TopicFilter |
withRelativeDateFilter(TopicRelativeDateFilter relativeDateFilter)
The relative date filter.
|
public void setFilterDescription(String filterDescription)
A description of the filter used to select items for a topic.
filterDescription
- A description of the filter used to select items for a topic.public String getFilterDescription()
A description of the filter used to select items for a topic.
public TopicFilter withFilterDescription(String filterDescription)
A description of the filter used to select items for a topic.
filterDescription
- A description of the filter used to select items for a topic.public void setFilterClass(String filterClass)
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.
filterClass
- The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.FilterClass
public String getFilterClass()
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.
ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.FilterClass
public TopicFilter withFilterClass(String filterClass)
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.
filterClass
- The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.FilterClass
public TopicFilter withFilterClass(FilterClass filterClass)
The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.
filterClass
- The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER
,
CONDITIONAL_VALUE_FILTER
, and NAMED_VALUE_FILTER
.FilterClass
public void setFilterName(String filterName)
The name of the filter.
filterName
- The name of the filter.public String getFilterName()
The name of the filter.
public TopicFilter withFilterName(String filterName)
The name of the filter.
filterName
- The name of the filter.public List<String> getFilterSynonyms()
The other names or aliases for the filter.
public void setFilterSynonyms(Collection<String> filterSynonyms)
The other names or aliases for the filter.
filterSynonyms
- The other names or aliases for the filter.public TopicFilter withFilterSynonyms(String... filterSynonyms)
The other names or aliases for the filter.
NOTE: This method appends the values to the existing list (if any). Use
setFilterSynonyms(java.util.Collection)
or withFilterSynonyms(java.util.Collection)
if you want
to override the existing values.
filterSynonyms
- The other names or aliases for the filter.public TopicFilter withFilterSynonyms(Collection<String> filterSynonyms)
The other names or aliases for the filter.
filterSynonyms
- The other names or aliases for the filter.public void setOperandFieldName(String operandFieldName)
The name of the field that the filter operates on.
operandFieldName
- The name of the field that the filter operates on.public String getOperandFieldName()
The name of the field that the filter operates on.
public TopicFilter withOperandFieldName(String operandFieldName)
The name of the field that the filter operates on.
operandFieldName
- The name of the field that the filter operates on.public void setFilterType(String filterType)
The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
, and
RELATIVE_DATE_FILTER
.
filterType
- The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
,
and RELATIVE_DATE_FILTER
.NamedFilterType
public String getFilterType()
The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
, and
RELATIVE_DATE_FILTER
.
CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
,
and RELATIVE_DATE_FILTER
.NamedFilterType
public TopicFilter withFilterType(String filterType)
The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
, and
RELATIVE_DATE_FILTER
.
filterType
- The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
,
and RELATIVE_DATE_FILTER
.NamedFilterType
public TopicFilter withFilterType(NamedFilterType filterType)
The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
, and
RELATIVE_DATE_FILTER
.
filterType
- The type of the filter. Valid values for this structure are CATEGORY_FILTER
,
NUMERIC_EQUALITY_FILTER
, NUMERIC_RANGE_FILTER
, DATE_RANGE_FILTER
,
and RELATIVE_DATE_FILTER
.NamedFilterType
public void setCategoryFilter(TopicCategoryFilter categoryFilter)
The category filter that is associated with this filter.
categoryFilter
- The category filter that is associated with this filter.public TopicCategoryFilter getCategoryFilter()
The category filter that is associated with this filter.
public TopicFilter withCategoryFilter(TopicCategoryFilter categoryFilter)
The category filter that is associated with this filter.
categoryFilter
- The category filter that is associated with this filter.public void setNumericEqualityFilter(TopicNumericEqualityFilter numericEqualityFilter)
The numeric equality filter.
numericEqualityFilter
- The numeric equality filter.public TopicNumericEqualityFilter getNumericEqualityFilter()
The numeric equality filter.
public TopicFilter withNumericEqualityFilter(TopicNumericEqualityFilter numericEqualityFilter)
The numeric equality filter.
numericEqualityFilter
- The numeric equality filter.public void setNumericRangeFilter(TopicNumericRangeFilter numericRangeFilter)
The numeric range filter.
numericRangeFilter
- The numeric range filter.public TopicNumericRangeFilter getNumericRangeFilter()
The numeric range filter.
public TopicFilter withNumericRangeFilter(TopicNumericRangeFilter numericRangeFilter)
The numeric range filter.
numericRangeFilter
- The numeric range filter.public void setDateRangeFilter(TopicDateRangeFilter dateRangeFilter)
The date range filter.
dateRangeFilter
- The date range filter.public TopicDateRangeFilter getDateRangeFilter()
The date range filter.
public TopicFilter withDateRangeFilter(TopicDateRangeFilter dateRangeFilter)
The date range filter.
dateRangeFilter
- The date range filter.public void setRelativeDateFilter(TopicRelativeDateFilter relativeDateFilter)
The relative date filter.
relativeDateFilter
- The relative date filter.public TopicRelativeDateFilter getRelativeDateFilter()
The relative date filter.
public TopicFilter withRelativeDateFilter(TopicRelativeDateFilter relativeDateFilter)
The relative date filter.
relativeDateFilter
- The relative date filter.public String toString()
toString
in class Object
Object.toString()
public TopicFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.