software.amazon.awssdk.services.rum.model

Class QueryFilter

java.lang.Object

software.amazon.awssdk.services.rum.model.QueryFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QueryFilter.Builder,QueryFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QueryFilter.Builder,QueryFilter>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryFilter.Builder

Method Summary

Modifier and Type	Method and Description
static QueryFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
String	name() The name of a key to search for.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryFilter.Builder>	serializableBuilderClass()
QueryFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The values of the Name that are to be be included in the returned results.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final 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

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

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

values

public final List<String> values()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

Returns:

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

toBuilder

public QueryFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryFilter.Builder,QueryFilter>

builder

public static QueryFilter.Builder builder()

serializableBuilderClass

public static Class<? extends QueryFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo