com.amazonaws.services.elasticbeanstalk.model

Class SearchFilter

java.lang.Object

com.amazonaws.services.elasticbeanstalk.model.SearchFilter

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchFilter
extends Object
implements Serializable, Cloneable

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchFilter()

Method Summary

Modifier and Type	Method and Description
SearchFilter	clone()
boolean	equals(Object obj)
String	getAttribute() The result attribute to which the filter values are applied.
String	getOperator() The operator to apply to the Attribute with each of the Values.
List<String>	getValues() The list of values applied to the Attribute and Operator attributes.
int	hashCode()
void	setAttribute(String attribute) The result attribute to which the filter values are applied.
void	setOperator(String operator) The operator to apply to the Attribute with each of the Values.
void	setValues(Collection<String> values) The list of values applied to the Attribute and Operator attributes.
String	toString() Returns a string representation of this object.
SearchFilter	withAttribute(String attribute) The result attribute to which the filter values are applied.
SearchFilter	withOperator(String operator) The operator to apply to the Attribute with each of the Values.
SearchFilter	withValues(Collection<String> values) The list of values applied to the Attribute and Operator attributes.
SearchFilter	withValues(String... values) The list of values applied to the Attribute and Operator attributes.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchFilter

public SearchFilter()

Method Detail

setAttribute

public void setAttribute(String attribute)

The result attribute to which the filter values are applied. Valid values vary by API action.

Parameters:

attribute - The result attribute to which the filter values are applied. Valid values vary by API action.

getAttribute

public String getAttribute()

The result attribute to which the filter values are applied. Valid values vary by API action.

Returns:

The result attribute to which the filter values are applied. Valid values vary by API action.

withAttribute

public SearchFilter withAttribute(String attribute)

The result attribute to which the filter values are applied. Valid values vary by API action.

Parameters:

attribute - The result attribute to which the filter values are applied. Valid values vary by API action.

Returns:

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

setOperator

public void setOperator(String operator)

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Parameters:

operator - The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

getOperator

public String getOperator()

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Returns:

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

withOperator

public SearchFilter withOperator(String operator)

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Parameters:

operator - The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Returns:

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

getValues

public List<String> getValues()

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Returns:

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

setValues

public void setValues(Collection<String> values)

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Parameters:

values - The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

withValues

public SearchFilter withValues(String... values)

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

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 list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Returns:

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

withValues

public SearchFilter withValues(Collection<String> values)

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Parameters:

values - The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

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

Overrides:

clone in class Object