FilterParameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.internetmonitor.model.FilterParameter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FilterParameter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A filter that you use with the results of a Amazon CloudWatch Internet Monitor query that you created and ran. The query sets up a repository of data that is a subset of your application's Internet Monitor data. FilterParameter is a string that defines how you want to filter the repository of data to return a set of results, based on your criteria.

The filter parameters that you can specify depend on the query type that you used to create the repository, since each query type returns a different set of Internet Monitor data.

For each filter, you specify a field (such as city), an operator (such as not_equals, and a value or array of values (such as ["Seattle", "Redmond"]). Separate values in the array with commas.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FilterParameter()

Constructors
Constructor and Description
`FilterParameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FilterParameter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getField()` A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query.
`String`	`getOperator()` The operator to use with the filter field and a value, such as `not_equals`.
`List<String>`	`getValues()` One or more values to be used, together with the specified operator, to filter data for a query.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setField(String field)` A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query.
`void`	`setOperator(String operator)` The operator to use with the filter field and a value, such as `not_equals`.
`void`	`setValues(Collection<String> values)` One or more values to be used, together with the specified operator, to filter data for a query.
`String`	`toString()` Returns a string representation of this object.
`FilterParameter`	`withField(String field)` A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query.
`FilterParameter`	`withOperator(Operator operator)` The operator to use with the filter field and a value, such as `not_equals`.
`FilterParameter`	`withOperator(String operator)` The operator to use with the filter field and a value, such as `not_equals`.
`FilterParameter`	`withValues(Collection<String> values)` One or more values to be used, together with the specified operator, to filter data for a query.
`FilterParameter`	`withValues(String... values)` One or more values to be used, together with the specified operator, to filter data for a query.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FilterParameter
```
public FilterParameter()
```
- Method Detail
  - setField
```
public void setField(String field)
```
    A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
    
    Parameters:
    
    field - A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
  - getField
```
public String getField()
```
    A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
    
    Returns:
    
    A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
  - withField
```
public FilterParameter withField(String field)
```
    A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
    
    Parameters:
    
    field - A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be city, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperator
```
public void setOperator(String operator)
```
    The operator to use with the filter field and a value, such as not_equals.
    
    Parameters:
    
    operator - The operator to use with the filter field and a value, such as not_equals.
    
    See Also:
    
    Operator
  - getOperator
```
public String getOperator()
```
    The operator to use with the filter field and a value, such as not_equals.
    
    Returns:
    
    The operator to use with the filter field and a value, such as not_equals.
    
    See Also:
    
    Operator
  - withOperator
```
public FilterParameter withOperator(String operator)
```
    The operator to use with the filter field and a value, such as not_equals.
    
    Parameters:
    
    operator - The operator to use with the filter field and a value, such as not_equals.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Operator
  - withOperator
```
public FilterParameter withOperator(Operator operator)
```
    The operator to use with the filter field and a value, such as not_equals.
    
    Parameters:
    
    operator - The operator to use with the filter field and a value, such as not_equals.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Operator
  - getValues
```
public List<String> getValues()
```
    One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
    
    Returns:
    
    One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
  - setValues
```
public void setValues(Collection<String> values)
```
    One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
    
    Parameters:
    
    values - One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
  - withValues
```
public FilterParameter withValues(String... values)
```
    One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
    
    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 - One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public FilterParameter withValues(Collection<String> values)
```
    One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
    
    Parameters:
    
    values - One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as ["Seattle", "Redmond"]. Values in the array are separated by commas.
    
    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 FilterParameter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class FilterParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterParameter

Method Detail

setField

getField

withField

setOperator

getOperator

withOperator

withOperator

getValues

setValues

withValues

withValues

toString

equals

hashCode

clone

marshall