public class Filter
extends java.lang.Object
implements java.io.Serializable, java.lang.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.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
name
The name of the filter.
|
private SdkInternalList<java.lang.String> |
values
One or more filter values.
|
Constructor and Description |
---|
Filter()
Default constructor for Filter object.
|
Filter(java.lang.String name)
Constructs a new Filter object.
|
Filter(java.lang.String name,
java.util.List<java.lang.String> values)
Constructs a new Filter object.
|
Modifier and Type | Method and Description |
---|---|
Filter |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getName()
The name of the filter.
|
java.util.List<java.lang.String> |
getValues()
One or more filter values.
|
int |
hashCode() |
void |
setName(java.lang.String name)
The name of the filter.
|
void |
setValues(java.util.Collection<java.lang.String> values)
One or more filter values.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Filter |
withName(java.lang.String name)
The name of the filter.
|
Filter |
withValues(java.util.Collection<java.lang.String> values)
One or more filter values.
|
Filter |
withValues(java.lang.String... values)
One or more filter values.
|
private java.lang.String name
The name of the filter. Filter names are case-sensitive.
private SdkInternalList<java.lang.String> values
One or more filter values. Filter values are case-sensitive.
public Filter()
public Filter(java.lang.String name)
name
- The name of the filter. Filter names are case-sensitive.public Filter(java.lang.String name, java.util.List<java.lang.String> values)
name
- The name of the filter. Filter names are case-sensitive.values
- One or more filter values. Filter values are case-sensitive.public void setName(java.lang.String name)
The name of the filter. Filter names are case-sensitive.
name
- The name of the filter. Filter names are case-sensitive.public java.lang.String getName()
The name of the filter. Filter names are case-sensitive.
public Filter withName(java.lang.String name)
The name of the filter. Filter names are case-sensitive.
name
- The name of the filter. Filter names are case-sensitive.public java.util.List<java.lang.String> getValues()
One or more filter values. Filter values are case-sensitive.
public void setValues(java.util.Collection<java.lang.String> values)
One or more filter values. Filter values are case-sensitive.
values
- One or more filter values. Filter values are case-sensitive.public Filter withValues(java.lang.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)
or
withValues(java.util.Collection)
if you want to override the
existing values.
values
- One or more filter values. Filter values are case-sensitive.public Filter withValues(java.util.Collection<java.lang.String> values)
One or more filter values. Filter values are case-sensitive.
values
- One or more filter values. Filter values are case-sensitive.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Filter clone()
clone
in class java.lang.Object