Package software.amazon.awssdk.services.connect.model

Class FilterV2

java.lang.Object

software.amazon.awssdk.services.connect.model.FilterV2

All Implemented Interfaces:

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

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

Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterV2.Builder

Method Summary

Modifier and Type	Method	Description
static FilterV2.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterKey()	The key to use for filtering data.
List<String>	filterValues()	The identifiers to use for filtering data.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilterValues()	For responses, this returns true if the service returned a value for the FilterValues property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FilterV2.Builder>	serializableBuilderClass()
FilterV2.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

filterKey

public final String filterKey()

The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.

Returns:

The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.

hasFilterValues

public final boolean hasFilterValues()

For responses, this returns true if the service returned a value for the FilterValues 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.

filterValues

public final List<String> filterValues()

The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you would add queue IDs or ARNs in FilterValues.

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 hasFilterValues() method.

Returns:

The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you would add queue IDs or ARNs in FilterValues.

toBuilder

public FilterV2.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterV2.Builder,FilterV2>

builder

public static FilterV2.Builder builder()

serializableBuilderClass

public static Class<? extends FilterV2.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