Class Rule
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Rule.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static Rule
fromInterruptionFilter
(Consumer<InterruptionFilter.Builder> interruptionFilter) Create an instance of this class withinterruptionFilter()
initialized to the given value.static Rule
fromInterruptionFilter
(InterruptionFilter interruptionFilter) Create an instance of this class withinterruptionFilter()
initialized to the given value.static Rule
fromNonTalkTimeFilter
(Consumer<NonTalkTimeFilter.Builder> nonTalkTimeFilter) Create an instance of this class withnonTalkTimeFilter()
initialized to the given value.static Rule
fromNonTalkTimeFilter
(NonTalkTimeFilter nonTalkTimeFilter) Create an instance of this class withnonTalkTimeFilter()
initialized to the given value.static Rule
fromSentimentFilter
(Consumer<SentimentFilter.Builder> sentimentFilter) Create an instance of this class withsentimentFilter()
initialized to the given value.static Rule
fromSentimentFilter
(SentimentFilter sentimentFilter) Create an instance of this class withsentimentFilter()
initialized to the given value.static Rule
fromTranscriptFilter
(Consumer<TranscriptFilter.Builder> transcriptFilter) Create an instance of this class withtranscriptFilter()
initialized to the given value.static Rule
fromTranscriptFilter
(TranscriptFilter transcriptFilter) Create an instance of this class withtranscriptFilter()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InterruptionFilter
Flag the presence or absence of interruptions in your Call Analytics transcription output.final NonTalkTimeFilter
Flag the presence or absence of periods of silence in your Call Analytics transcription output.final SentimentFilter
Flag the presence or absence of specific sentiments in your Call Analytics transcription output.static Class
<? extends Rule.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TranscriptFilter
Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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 interfaceToCopyableBuilder<Rule.Builder,
Rule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromNonTalkTimeFilter
Create an instance of this class withnonTalkTimeFilter()
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
Create an instance of this class withnonTalkTimeFilter()
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
Create an instance of this class withinterruptionFilter()
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
Create an instance of this class withinterruptionFilter()
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
Create an instance of this class withtranscriptFilter()
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
Create an instance of this class withtranscriptFilter()
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
Create an instance of this class withsentimentFilter()
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
Create an instance of this class withsentimentFilter()
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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beRule.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 beRule.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-