java.lang.Object
- software.amazon.awssdk.services.connect.model.MetricFilterV2

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MetricFilterV2.Builder,MetricFilterV2>
```
@Generated("software.amazon.awssdk:codegen")
public final class MetricFilterV2
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MetricFilterV2.Builder,MetricFilterV2>
```
Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MetricFilterV2.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MetricFilterV2.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMetricFilterValues()`	For responses, this returns true if the service returned a value for the MetricFilterValues property.
`String`	`metricFilterKey()`	The key to use for filtering data.
`List<String>`	`metricFilterValues()`	The values to use for filtering data.
`Boolean`	`negate()`	If set to `true`, the API response contains results that filter out the results matched by the metric-level filters condition.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MetricFilterV2.Builder>`	`serializableBuilderClass()`
`MetricFilterV2.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
  - metricFilterKey
```
public final String metricFilterKey()
```
    The key to use for filtering data.
    
    Valid metric filter keys:
    
    ANSWERING_MACHINE_DETECTION_STATUS
    
    CASE_STATUS
    
    DISCONNECT_REASON
    
    FLOWS_ACTION_IDENTIFIER
    
    FLOWS_NEXT_ACTION_IDENTIFIER
    
    FLOWS_OUTCOME_TYPE
    
    FLOWS_RESOURCE_TYPE
    
    INITIATION_METHOD
    Returns:
    
    The key to use for filtering data.
    
    Valid metric filter keys:
    
    ANSWERING_MACHINE_DETECTION_STATUS
    
    CASE_STATUS
    
    DISCONNECT_REASON
    
    FLOWS_ACTION_IDENTIFIER
    
    FLOWS_NEXT_ACTION_IDENTIFIER
    
    FLOWS_OUTCOME_TYPE
    
    FLOWS_RESOURCE_TYPE
    
    INITIATION_METHOD
  - hasMetricFilterValues
```
public final boolean hasMetricFilterValues()
```
    For responses, this returns true if the service returned a value for the MetricFilterValues 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.
  - metricFilterValues
```
public final List<String> metricFilterValues()
```
    The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
    
    For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
    
    For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
    
    For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
    
    For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
    
    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 hasMetricFilterValues() method.
    
    Returns:
    
    The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
    
    For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
    
    For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
    
    For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
    
    For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
  - negate
```
public final Boolean negate()
```
    If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false.
    
    Returns:
    
    If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false.
  - toBuilder
```
public MetricFilterV2.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MetricFilterV2.Builder,MetricFilterV2>
  - builder
```
public static MetricFilterV2.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MetricFilterV2.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class MetricFilterV2

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

metricFilterKey

hasMetricFilterValues

metricFilterValues

negate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField