Class Filter
- java.lang.Object
-
- com.amazonaws.services.ec2.model.Filter
-
- All Implemented Interfaces:
Serializable,Cloneable
public class Filter extends Object implements Serializable, Cloneable
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Filterclone()booleanequals(Object obj)StringgetName()The name of the filter.List<String>getValues()One or more filter values.inthashCode()voidsetName(String name)The name of the filter.voidsetValues(Collection<String> values)One or more filter values.StringtoString()Returns a string representation of this object; useful for testing and debugging.FilterwithName(String name)The name of the filter.FilterwithValues(String... values)One or more filter values.FilterwithValues(Collection<String> values)One or more filter values.
-
-
-
Constructor Detail
-
Filter
public Filter()
Default constructor for Filter object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
Filter
public Filter(String name)
Constructs a new Filter object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
name- The name of the filter. Filter names are case-sensitive.
-
Filter
public Filter(String name, List<String> values)
Constructs a new Filter object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
name- The name of the filter. Filter names are case-sensitive.values- One or more filter values. Filter values are case-sensitive.
-
-
Method Detail
-
setName
public void setName(String name)
The name of the filter. Filter names are case-sensitive.
- Parameters:
name- The name of the filter. Filter names are case-sensitive.
-
getName
public String getName()
The name of the filter. Filter names are case-sensitive.
- Returns:
- The name of the filter. Filter names are case-sensitive.
-
withName
public Filter withName(String name)
The name of the filter. Filter names are case-sensitive.
- Parameters:
name- The name of the filter. Filter names are case-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getValues
public List<String> getValues()
One or more filter values. Filter values are case-sensitive.
- Returns:
- One or more filter values. Filter values are case-sensitive.
-
setValues
public void setValues(Collection<String> values)
One or more filter values. Filter values are case-sensitive.
- Parameters:
values- One or more filter values. Filter values are case-sensitive.
-
withValues
public Filter withValues(String... values)
One or more filter values. Filter values are case-sensitive.
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)orwithValues(java.util.Collection)if you want to override the existing values.- Parameters:
values- One or more filter values. Filter values are case-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withValues
public Filter withValues(Collection<String> values)
One or more filter values. Filter values are case-sensitive.
- Parameters:
values- One or more filter values. Filter values are case-sensitive.- 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; useful for testing and debugging.- Overrides:
toStringin classObject- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-