Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transcribe.model.Rule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`InterruptionFilter`	`getInterruptionFilter()` Flag the presence or absence of interruptions in your Call Analytics transcription output.
`NonTalkTimeFilter`	`getNonTalkTimeFilter()` Flag the presence or absence of periods of silence in your Call Analytics transcription output.
`SentimentFilter`	`getSentimentFilter()` Flag the presence or absence of specific sentiments in your Call Analytics transcription output.
`TranscriptFilter`	`getTranscriptFilter()` Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInterruptionFilter(InterruptionFilter interruptionFilter)` Flag the presence or absence of interruptions in your Call Analytics transcription output.
`void`	`setNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter)` Flag the presence or absence of periods of silence in your Call Analytics transcription output.
`void`	`setSentimentFilter(SentimentFilter sentimentFilter)` Flag the presence or absence of specific sentiments in your Call Analytics transcription output.
`void`	`setTranscriptFilter(TranscriptFilter transcriptFilter)` Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withInterruptionFilter(InterruptionFilter interruptionFilter)` Flag the presence or absence of interruptions in your Call Analytics transcription output.
`Rule`	`withNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter)` Flag the presence or absence of periods of silence in your Call Analytics transcription output.
`Rule`	`withSentimentFilter(SentimentFilter sentimentFilter)` Flag the presence or absence of specific sentiments in your Call Analytics transcription output.
`Rule`	`withTranscriptFilter(TranscriptFilter transcriptFilter)` Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setNonTalkTimeFilter
```
public void setNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter)
```
    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.
  - getNonTalkTimeFilter
```
public NonTalkTimeFilter getNonTalkTimeFilter()
```
    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.
  - withNonTalkTimeFilter
```
public Rule withNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter)
```
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterruptionFilter
```
public void setInterruptionFilter(InterruptionFilter interruptionFilter)
```
    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.
  - getInterruptionFilter
```
public InterruptionFilter getInterruptionFilter()
```
    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.
  - withInterruptionFilter
```
public Rule withInterruptionFilter(InterruptionFilter interruptionFilter)
```
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTranscriptFilter
```
public void setTranscriptFilter(TranscriptFilter transcriptFilter)
```
    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.
  - getTranscriptFilter
```
public TranscriptFilter getTranscriptFilter()
```
    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.
  - withTranscriptFilter
```
public Rule withTranscriptFilter(TranscriptFilter transcriptFilter)
```
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSentimentFilter
```
public void setSentimentFilter(SentimentFilter sentimentFilter)
```
    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.
  - getSentimentFilter
```
public SentimentFilter getSentimentFilter()
```
    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.
  - withSentimentFilter
```
public Rule withSentimentFilter(SentimentFilter sentimentFilter)
```
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Rule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setNonTalkTimeFilter

getNonTalkTimeFilter

withNonTalkTimeFilter

setInterruptionFilter

getInterruptionFilter

withInterruptionFilter

setTranscriptFilter

getTranscriptFilter

withTranscriptFilter

setSentimentFilter

getSentimentFilter

withSentimentFilter

toString

equals

hashCode

clone

marshall