com.amazonaws.services.cloudwatchrum.model

Class QueryFilter

java.lang.Object

com.amazonaws.services.cloudwatchrum.model.QueryFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A structure that defines a key and values that you can use to filter the results. The only performance events that are returned are those that have values matching the ones that you specify in one of your QueryFilter structures.

For example, you could specify Browser as the Name and specify Chrome,Firefox as the Values to return events generated only from those browsers.

Specifying Invert as the Name works as a "not equal to" filter. For example, specify Invert as the Name and specify Chrome as the value to return all events except events from user sessions with the Chrome browser.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryFilter()

Method Summary

Modifier and Type	Method and Description
QueryFilter	clone()
boolean	equals(Object obj)
String	getName() The name of a key to search for.
List<String>	getValues() The values of the Name that are to be be included in the returned results.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setName(String name) The name of a key to search for.
void	setValues(Collection<String> values) The values of the Name that are to be be included in the returned results.
String	toString() Returns a string representation of this object.
QueryFilter	withName(String name) The name of a key to search for.
QueryFilter	withValues(Collection<String> values) The values of the Name that are to be be included in the returned results.
QueryFilter	withValues(String... values) The values of the Name that are to be be included in the returned results.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryFilter

public QueryFilter()

Method Detail

setName

public void setName(String name)

The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

Parameters:

name - The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

getName

public String getName()

The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

Returns:

The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

withName

public QueryFilter withName(String name)

The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

Parameters:

name - The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

Returns:

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

getValues

public List<String> getValues()

The values of the Name that are to be be included in the returned results.

Returns:

The values of the Name that are to be be included in the returned results.

setValues

public void setValues(Collection<String> values)

The values of the Name that are to be be included in the returned results.

Parameters:

values - The values of the Name that are to be be included in the returned results.

withValues

public QueryFilter withValues(String... values)

The values of the Name that are to be be included in the returned results.

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 values of the Name that are to be be included in the returned results.

Returns:

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

withValues

public QueryFilter withValues(Collection<String> values)

The values of the Name that are to be be included in the returned results.

Parameters:

values - The values of the Name that are to be be included in the returned results.

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo