@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class MetricFilterV2 extends Object implements Serializable, Cloneable, StructuredPojo
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
.
Constructor and Description |
---|
MetricFilterV2() |
Modifier and Type | Method and Description |
---|---|
MetricFilterV2 |
clone() |
boolean |
equals(Object obj) |
String |
getMetricFilterKey()
The key to use for filtering data.
|
List<String> |
getMetricFilterValues()
The values to use for filtering data.
|
Boolean |
getNegate()
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
|
int |
hashCode() |
Boolean |
isNegate()
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setMetricFilterKey(String metricFilterKey)
The key to use for filtering data.
|
void |
setMetricFilterValues(Collection<String> metricFilterValues)
The values to use for filtering data.
|
void |
setNegate(Boolean negate)
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
|
String |
toString()
Returns a string representation of this object.
|
MetricFilterV2 |
withMetricFilterKey(String metricFilterKey)
The key to use for filtering data.
|
MetricFilterV2 |
withMetricFilterValues(Collection<String> metricFilterValues)
The values to use for filtering data.
|
MetricFilterV2 |
withMetricFilterValues(String... metricFilterValues)
The values to use for filtering data.
|
MetricFilterV2 |
withNegate(Boolean negate)
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
|
public void setMetricFilterKey(String metricFilterKey)
The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the same
values as the InitiationMethod
and DisconnectReason
in the contact record. For more
information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
metricFilterKey
- The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the
same values as the InitiationMethod
and DisconnectReason
in the contact record.
For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
public String getMetricFilterKey()
The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the same
values as the InitiationMethod
and DisconnectReason
in the contact record. For more
information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the
same values as the InitiationMethod
and DisconnectReason
in the contact record.
For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
public MetricFilterV2 withMetricFilterKey(String metricFilterKey)
The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the same
values as the InitiationMethod
and DisconnectReason
in the contact record. For more
information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
metricFilterKey
- The key to use for filtering data.
Valid metric filter keys: INITIATION_METHOD
, DISCONNECT_REASON
. These are the
same values as the InitiationMethod
and DisconnectReason
in the contact record.
For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
public List<String> getMetricFilterValues()
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
| OUTBOUND
|
TRANSFER
| QUEUE_TRANSFER
| CALLBACK
| API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
Valid metric filter values for INITIATION_METHOD
: INBOUND
|
OUTBOUND
| TRANSFER
| QUEUE_TRANSFER
| CALLBACK
|
API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
public void setMetricFilterValues(Collection<String> metricFilterValues)
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
| OUTBOUND
|
TRANSFER
| QUEUE_TRANSFER
| CALLBACK
| API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
metricFilterValues
- The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
|
OUTBOUND
| TRANSFER
| QUEUE_TRANSFER
| CALLBACK
|
API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
public MetricFilterV2 withMetricFilterValues(String... metricFilterValues)
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
| OUTBOUND
|
TRANSFER
| QUEUE_TRANSFER
| CALLBACK
| API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
NOTE: This method appends the values to the existing list (if any). Use
setMetricFilterValues(java.util.Collection)
or withMetricFilterValues(java.util.Collection)
if
you want to override the existing values.
metricFilterValues
- The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
|
OUTBOUND
| TRANSFER
| QUEUE_TRANSFER
| CALLBACK
|
API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
public MetricFilterV2 withMetricFilterValues(Collection<String> metricFilterValues)
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
| OUTBOUND
|
TRANSFER
| QUEUE_TRANSFER
| CALLBACK
| API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
metricFilterValues
- The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD
: INBOUND
|
OUTBOUND
| TRANSFER
| QUEUE_TRANSFER
| CALLBACK
|
API
Valid metric filter values for DISCONNECT_REASON
: CUSTOMER_DISCONNECT
|
AGENT_DISCONNECT
| THIRD_PARTY_DISCONNECT
| TELECOM_PROBLEM
|
BARGED
| CONTACT_FLOW_DISCONNECT
| OTHER
| EXPIRED
|
API
public void setNegate(Boolean negate)
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
By default the negate is false
, which indicates to filter on the requested metric filter.
negate
- The flag to use to filter on requested metric filter values or to not filter on requested metric filter
values. By default the negate is false
, which indicates to filter on the requested metric
filter.public Boolean getNegate()
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
By default the negate is false
, which indicates to filter on the requested metric filter.
false
, which indicates to filter on the requested metric
filter.public MetricFilterV2 withNegate(Boolean negate)
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
By default the negate is false
, which indicates to filter on the requested metric filter.
negate
- The flag to use to filter on requested metric filter values or to not filter on requested metric filter
values. By default the negate is false
, which indicates to filter on the requested metric
filter.public Boolean isNegate()
The flag to use to filter on requested metric filter values or to not filter on requested metric filter values.
By default the negate is false
, which indicates to filter on the requested metric filter.
false
, which indicates to filter on the requested metric
filter.public String toString()
toString
in class Object
Object.toString()
public MetricFilterV2 clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.