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

Interface MetricFilterV2.Builder

    • Method Detail

      • metricFilterKey

        MetricFilterV2.Builder metricFilterKey​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • metricFilterValues

        MetricFilterV2.Builder metricFilterValues​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricFilterValues

        MetricFilterV2.Builder metricFilterValues​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • negate

        MetricFilterV2.Builder negate​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.