@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AttributeFilter extends Object implements Serializable, Cloneable, StructuredPojo
The filter criteria used on responses based on document attributes or metadata fields.
Constructor and Description |
---|
AttributeFilter() |
Modifier and Type | Method and Description |
---|---|
AttributeFilter |
clone() |
boolean |
equals(Object obj) |
List<AttributeFilter> |
getAndAllFilters()
Performs a logical
AND operation on all supplied filters. |
DocumentAttribute |
getContainsAll()
Returns
true when a document contains all the specified document attributes or metadata fields. |
DocumentAttribute |
getContainsAny()
Returns
true when a document contains any of the specified document attributes or metadata fields. |
DocumentAttribute |
getEqualsTo()
Performs an equals operation on two document attributes or metadata fields.
|
DocumentAttribute |
getGreaterThan()
Performs a greater than operation on two document attributes or metadata fields.
|
DocumentAttribute |
getGreaterThanOrEquals()
Performs a greater than or equals operation on two document attributes or metadata fields.
|
DocumentAttribute |
getLessThan()
Performs a less than operation on two document attributes or metadata fields.
|
DocumentAttribute |
getLessThanOrEquals()
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type:
dateValue and longValue . |
AttributeFilter |
getNotFilter()
Performs a logical
NOT operation on all supplied filters. |
List<AttributeFilter> |
getOrAllFilters()
Performs a logical
OR operation on all supplied filters. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAndAllFilters(Collection<AttributeFilter> andAllFilters)
Performs a logical
AND operation on all supplied filters. |
void |
setContainsAll(DocumentAttribute containsAll)
Returns
true when a document contains all the specified document attributes or metadata fields. |
void |
setContainsAny(DocumentAttribute containsAny)
Returns
true when a document contains any of the specified document attributes or metadata fields. |
void |
setEqualsTo(DocumentAttribute equalsTo)
Performs an equals operation on two document attributes or metadata fields.
|
void |
setGreaterThan(DocumentAttribute greaterThan)
Performs a greater than operation on two document attributes or metadata fields.
|
void |
setGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)
Performs a greater than or equals operation on two document attributes or metadata fields.
|
void |
setLessThan(DocumentAttribute lessThan)
Performs a less than operation on two document attributes or metadata fields.
|
void |
setLessThanOrEquals(DocumentAttribute lessThanOrEquals)
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type:
dateValue and longValue . |
void |
setNotFilter(AttributeFilter notFilter)
Performs a logical
NOT operation on all supplied filters. |
void |
setOrAllFilters(Collection<AttributeFilter> orAllFilters)
Performs a logical
OR operation on all supplied filters. |
String |
toString()
Returns a string representation of this object.
|
AttributeFilter |
withAndAllFilters(AttributeFilter... andAllFilters)
Performs a logical
AND operation on all supplied filters. |
AttributeFilter |
withAndAllFilters(Collection<AttributeFilter> andAllFilters)
Performs a logical
AND operation on all supplied filters. |
AttributeFilter |
withContainsAll(DocumentAttribute containsAll)
Returns
true when a document contains all the specified document attributes or metadata fields. |
AttributeFilter |
withContainsAny(DocumentAttribute containsAny)
Returns
true when a document contains any of the specified document attributes or metadata fields. |
AttributeFilter |
withEqualsTo(DocumentAttribute equalsTo)
Performs an equals operation on two document attributes or metadata fields.
|
AttributeFilter |
withGreaterThan(DocumentAttribute greaterThan)
Performs a greater than operation on two document attributes or metadata fields.
|
AttributeFilter |
withGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)
Performs a greater than or equals operation on two document attributes or metadata fields.
|
AttributeFilter |
withLessThan(DocumentAttribute lessThan)
Performs a less than operation on two document attributes or metadata fields.
|
AttributeFilter |
withLessThanOrEquals(DocumentAttribute lessThanOrEquals)
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type:
dateValue and longValue . |
AttributeFilter |
withNotFilter(AttributeFilter notFilter)
Performs a logical
NOT operation on all supplied filters. |
AttributeFilter |
withOrAllFilters(AttributeFilter... orAllFilters)
Performs a logical
OR operation on all supplied filters. |
AttributeFilter |
withOrAllFilters(Collection<AttributeFilter> orAllFilters)
Performs a logical
OR operation on all supplied filters. |
public List<AttributeFilter> getAndAllFilters()
Performs a logical AND
operation on all supplied filters.
AND
operation on all supplied filters.public void setAndAllFilters(Collection<AttributeFilter> andAllFilters)
Performs a logical AND
operation on all supplied filters.
andAllFilters
- Performs a logical AND
operation on all supplied filters.public AttributeFilter withAndAllFilters(AttributeFilter... andAllFilters)
Performs a logical AND
operation on all supplied filters.
NOTE: This method appends the values to the existing list (if any). Use
setAndAllFilters(java.util.Collection)
or withAndAllFilters(java.util.Collection)
if you want
to override the existing values.
andAllFilters
- Performs a logical AND
operation on all supplied filters.public AttributeFilter withAndAllFilters(Collection<AttributeFilter> andAllFilters)
Performs a logical AND
operation on all supplied filters.
andAllFilters
- Performs a logical AND
operation on all supplied filters.public List<AttributeFilter> getOrAllFilters()
Performs a logical OR
operation on all supplied filters.
OR
operation on all supplied filters.public void setOrAllFilters(Collection<AttributeFilter> orAllFilters)
Performs a logical OR
operation on all supplied filters.
orAllFilters
- Performs a logical OR
operation on all supplied filters.public AttributeFilter withOrAllFilters(AttributeFilter... orAllFilters)
Performs a logical OR
operation on all supplied filters.
NOTE: This method appends the values to the existing list (if any). Use
setOrAllFilters(java.util.Collection)
or withOrAllFilters(java.util.Collection)
if you want to
override the existing values.
orAllFilters
- Performs a logical OR
operation on all supplied filters.public AttributeFilter withOrAllFilters(Collection<AttributeFilter> orAllFilters)
Performs a logical OR
operation on all supplied filters.
orAllFilters
- Performs a logical OR
operation on all supplied filters.public void setNotFilter(AttributeFilter notFilter)
Performs a logical NOT
operation on all supplied filters.
notFilter
- Performs a logical NOT
operation on all supplied filters.public AttributeFilter getNotFilter()
Performs a logical NOT
operation on all supplied filters.
NOT
operation on all supplied filters.public AttributeFilter withNotFilter(AttributeFilter notFilter)
Performs a logical NOT
operation on all supplied filters.
notFilter
- Performs a logical NOT
operation on all supplied filters.public void setEqualsTo(DocumentAttribute equalsTo)
Performs an equals operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue
, longValue
, stringListValue
and
stringValue
.
equalsTo
- Performs an equals operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
, longValue
, stringListValue
and stringValue
.public DocumentAttribute getEqualsTo()
Performs an equals operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue
, longValue
, stringListValue
and
stringValue
.
dateValue
, longValue
, stringListValue
and stringValue
.public AttributeFilter withEqualsTo(DocumentAttribute equalsTo)
Performs an equals operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue
, longValue
, stringListValue
and
stringValue
.
equalsTo
- Performs an equals operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
, longValue
, stringListValue
and stringValue
.public void setContainsAll(DocumentAttribute containsAll)
Returns true
when a document contains all the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue
.
containsAll
- Returns true
when a document contains all the specified document attributes or metadata
fields. Supported for the following document
attribute value types: stringListValue
.public DocumentAttribute getContainsAll()
Returns true
when a document contains all the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue
.
true
when a document contains all the specified document attributes or metadata
fields. Supported for the following document
attribute value types: stringListValue
.public AttributeFilter withContainsAll(DocumentAttribute containsAll)
Returns true
when a document contains all the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue
.
containsAll
- Returns true
when a document contains all the specified document attributes or metadata
fields. Supported for the following document
attribute value types: stringListValue
.public void setContainsAny(DocumentAttribute containsAny)
Returns true
when a document contains any of the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue
.
containsAny
- Returns true
when a document contains any of the specified document attributes or metadata
fields. Supported for the following document
attribute value types: stringListValue
.public DocumentAttribute getContainsAny()
Returns true
when a document contains any of the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue
.
true
when a document contains any of the specified document attributes or metadata
fields. Supported for the following document
attribute value types: stringListValue
.public AttributeFilter withContainsAny(DocumentAttribute containsAny)
Returns true
when a document contains any of the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue
.
containsAny
- Returns true
when a document contains any of the specified document attributes or metadata
fields. Supported for the following document
attribute value types: stringListValue
.public void setGreaterThan(DocumentAttribute greaterThan)
Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.
greaterThan
- Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.public DocumentAttribute getGreaterThan()
Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.
dateValue
and longValue
.public AttributeFilter withGreaterThan(DocumentAttribute greaterThan)
Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.
greaterThan
- Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.public void setGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)
Performs a greater than or equals operation on two document attributes or metadata fields. Supported for
the following document
attribute value types: dateValue
and longValue
.
greaterThanOrEquals
- Performs a greater than or equals operation on two document attributes or metadata fields.
Supported for the following document
attribute value types: dateValue
and longValue
.public DocumentAttribute getGreaterThanOrEquals()
Performs a greater than or equals operation on two document attributes or metadata fields. Supported for
the following document
attribute value types: dateValue
and longValue
.
dateValue
and longValue
.public AttributeFilter withGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)
Performs a greater than or equals operation on two document attributes or metadata fields. Supported for
the following document
attribute value types: dateValue
and longValue
.
greaterThanOrEquals
- Performs a greater than or equals operation on two document attributes or metadata fields.
Supported for the following document
attribute value types: dateValue
and longValue
.public void setLessThan(DocumentAttribute lessThan)
Performs a less than operation on two document attributes or metadata fields. Supported for the following
document
attribute value types: dateValue
and longValue
.
lessThan
- Performs a less than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.public DocumentAttribute getLessThan()
Performs a less than operation on two document attributes or metadata fields. Supported for the following
document
attribute value types: dateValue
and longValue
.
dateValue
and longValue
.public AttributeFilter withLessThan(DocumentAttribute lessThan)
Performs a less than operation on two document attributes or metadata fields. Supported for the following
document
attribute value types: dateValue
and longValue
.
lessThan
- Performs a less than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue
and longValue
.public void setLessThanOrEquals(DocumentAttribute lessThanOrEquals)
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type: dateValue
and longValue
.
lessThanOrEquals
- Performs a less than or equals operation on two document attributes or metadata fields.Supported
for the following document
attribute value type: dateValue
and longValue
.public DocumentAttribute getLessThanOrEquals()
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type: dateValue
and longValue
.
dateValue
and longValue
.public AttributeFilter withLessThanOrEquals(DocumentAttribute lessThanOrEquals)
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type: dateValue
and longValue
.
lessThanOrEquals
- Performs a less than or equals operation on two document attributes or metadata fields.Supported
for the following document
attribute value type: dateValue
and longValue
.public String toString()
toString
in class Object
Object.toString()
public AttributeFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.