com.amazonaws.services.ec2.model

Class Filter

java.lang.Object

com.amazonaws.services.ec2.model.Filter

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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 from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Filter() Default constructor for Filter object.
Filter(String name) Constructs a new Filter object.
Filter(String name, List<String> values) Constructs a new Filter object.

Method Summary

Modifier and Type	Method and Description
Filter	clone()
boolean	equals(Object obj)
String	getName() The name of the filter.
List<String>	getValues() The filter values.
int	hashCode()
void	setName(String name) The name of the filter.
void	setValues(Collection<String> values) The filter values.
String	toString() Returns a string representation of this object.
Filter	withName(String name) The name of the filter.
Filter	withValues(Collection<String> values) The filter values.
Filter	withValues(String... values) The filter values.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 - The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Returns:

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

setValues

public void setValues(Collection<String> values)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Parameters:

values - The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

withValues

public Filter withValues(String... values)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified 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 filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Returns:

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

withValues

public Filter withValues(Collection<String> values)

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

Parameters:

values - The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified 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 Filter clone()

Overrides:

clone in class Object