Class QueryFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic QueryFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Values property.final String
name()
The name of a key to search for.static Class
<? extends QueryFilter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.values()
The values of theName
that are to be be included in the returned results.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of a key to search for. The filter returns only the events that match the
Name
andValues
that you specify.Valid values for
Name
areBrowser
|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
andValues
that you specify.Valid values for
Name
areBrowser
|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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<QueryFilter.Builder,
QueryFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-