software.amazon.awssdk.services.transcribe.model

Class Rule

java.lang.Object

software.amazon.awssdk.services.transcribe.model.Rule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Rule.Builder,Rule>

@Generated(value="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 batch transcriptions and Creating categories for streaming transcriptions.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Rule.Builder
static class	Rule.Type

Method Summary

Modifier and Type	Method and Description
static Rule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static Rule	fromInterruptionFilter(Consumer<InterruptionFilter.Builder> interruptionFilter) Create an instance of this class with interruptionFilter() initialized to the given value.
static Rule	fromInterruptionFilter(InterruptionFilter interruptionFilter) Create an instance of this class with interruptionFilter() initialized to the given value.
static Rule	fromNonTalkTimeFilter(Consumer<NonTalkTimeFilter.Builder> nonTalkTimeFilter) Create an instance of this class with nonTalkTimeFilter() initialized to the given value.
static Rule	fromNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter) Create an instance of this class with nonTalkTimeFilter() initialized to the given value.
static Rule	fromSentimentFilter(Consumer<SentimentFilter.Builder> sentimentFilter) Create an instance of this class with sentimentFilter() initialized to the given value.
static Rule	fromSentimentFilter(SentimentFilter sentimentFilter) Create an instance of this class with sentimentFilter() initialized to the given value.
static Rule	fromTranscriptFilter(Consumer<TranscriptFilter.Builder> transcriptFilter) Create an instance of this class with transcriptFilter() initialized to the given value.
static Rule	fromTranscriptFilter(TranscriptFilter transcriptFilter) Create an instance of this class with transcriptFilter() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InterruptionFilter	interruptionFilter() Flag the presence or absence of interruptions in your Call Analytics transcription output.
NonTalkTimeFilter	nonTalkTimeFilter() Flag the presence or absence of periods of silence in your Call Analytics transcription output.
List<SdkField<?>>	sdkFields()
SentimentFilter	sentimentFilter() Flag the presence or absence of specific sentiments in your Call Analytics transcription output.
static Class<? extends Rule.Builder>	serializableBuilderClass()
Rule.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TranscriptFilter	transcriptFilter() Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.
Rule.Type	type() Retrieve an enum value representing which member of this object is populated.

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<Rule.Builder,Rule>

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)

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)

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