Class Rule

java.lang.Object
software.amazon.awssdk.services.transcribe.model.Rule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Rule.Builder,Rule>
@Generated("software.amazon.awssdk:codegen") public final class Rule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Rule.Builder,Rule>

A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

Rules can include these parameters: , , , and .

To learn more about Call Analytics rules and categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

To learn more about Call Analytics, see Analyzing call center audio with Call Analytics.

See Also:

  • Method Details

    • nonTalkTimeFilter

      public final NonTalkTimeFilter nonTalkTimeFilter()

      Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

      Returns:
      Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

    • interruptionFilter

      public final InterruptionFilter interruptionFilter()

      Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

      Returns:
      Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

    • transcriptFilter

      public final TranscriptFilter transcriptFilter()

      Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

      Returns:
      Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

    • sentimentFilter

      public final SentimentFilter sentimentFilter()

      Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

      Returns:
      Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

    • toBuilder

      public Rule.Builder 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 interface ToCopyableBuilder<Rule.Builder,Rule>
      Returns:
      a builder for type T

    • builder

      public static Rule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Rule.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • fromNonTalkTimeFilter

      public static Rule fromNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter)
      Create an instance of this class with nonTalkTimeFilter() initialized to the given value.

      Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      nonTalkTimeFilter - Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

    • fromNonTalkTimeFilter

      public static Rule fromNonTalkTimeFilter(Consumer<NonTalkTimeFilter.Builder> nonTalkTimeFilter)
      Create an instance of this class with nonTalkTimeFilter() initialized to the given value.

      Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      nonTalkTimeFilter - Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.

    • fromInterruptionFilter

      public static Rule fromInterruptionFilter(InterruptionFilter interruptionFilter)
      Create an instance of this class with interruptionFilter() initialized to the given value.

      Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      interruptionFilter - Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

    • fromInterruptionFilter

      public static Rule fromInterruptionFilter(Consumer<InterruptionFilter.Builder> interruptionFilter)
      Create an instance of this class with interruptionFilter() initialized to the given value.

      Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      interruptionFilter - Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.

    • fromTranscriptFilter

      public static Rule fromTranscriptFilter(TranscriptFilter transcriptFilter)
      Create an instance of this class with transcriptFilter() initialized to the given value.

      Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      transcriptFilter - Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

    • fromTranscriptFilter

      public static Rule fromTranscriptFilter(Consumer<TranscriptFilter.Builder> transcriptFilter)
      Create an instance of this class with transcriptFilter() initialized to the given value.

      Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      transcriptFilter - Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.

    • fromSentimentFilter

      public static Rule fromSentimentFilter(SentimentFilter sentimentFilter)
      Create an instance of this class with sentimentFilter() initialized to the given value.

      Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      sentimentFilter - Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

    • fromSentimentFilter

      public static Rule fromSentimentFilter(Consumer<SentimentFilter.Builder> sentimentFilter)
      Create an instance of this class with sentimentFilter() initialized to the given value.

      Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

      Parameters:
      sentimentFilter - Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.

    • type

      public Rule.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Rule.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Rule.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.