TranscriptFilter (AWS Java SDK for Amazon Transcribe 1.12.141 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TranscriptFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TranscriptFilter()

Constructors
Constructor and Description
`TranscriptFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TranscriptFilter`	`clone()`
`boolean`	`equals(Object obj)`
`AbsoluteTimeRange`	`getAbsoluteTimeRange()` A time range, set in seconds, between two points in the call.
`Boolean`	`getNegate()` If `TRUE`, the rule that you specify is applied to everything except for the phrases that you specify.
`String`	`getParticipantRole()` Determines whether the customer or the agent is speaking the phrases that you've specified.
`RelativeTimeRange`	`getRelativeTimeRange()` An object that allows percentages to specify the proportion of the call where you would like to apply a filter.
`List<String>`	`getTargets()` The phrases that you're specifying for the transcript filter to match.
`String`	`getTranscriptFilterType()` Matches the phrase to the transcription output in a word for word fashion.
`int`	`hashCode()`
`Boolean`	`isNegate()` If `TRUE`, the rule that you specify is applied to everything except for the phrases that you specify.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)` A time range, set in seconds, between two points in the call.
`void`	`setNegate(Boolean negate)` If `TRUE`, the rule that you specify is applied to everything except for the phrases that you specify.
`void`	`setParticipantRole(String participantRole)` Determines whether the customer or the agent is speaking the phrases that you've specified.
`void`	`setRelativeTimeRange(RelativeTimeRange relativeTimeRange)` An object that allows percentages to specify the proportion of the call where you would like to apply a filter.
`void`	`setTargets(Collection<String> targets)` The phrases that you're specifying for the transcript filter to match.
`void`	`setTranscriptFilterType(String transcriptFilterType)` Matches the phrase to the transcription output in a word for word fashion.
`String`	`toString()` Returns a string representation of this object.
`TranscriptFilter`	`withAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)` A time range, set in seconds, between two points in the call.
`TranscriptFilter`	`withNegate(Boolean negate)` If `TRUE`, the rule that you specify is applied to everything except for the phrases that you specify.
`TranscriptFilter`	`withParticipantRole(ParticipantRole participantRole)` Determines whether the customer or the agent is speaking the phrases that you've specified.
`TranscriptFilter`	`withParticipantRole(String participantRole)` Determines whether the customer or the agent is speaking the phrases that you've specified.
`TranscriptFilter`	`withRelativeTimeRange(RelativeTimeRange relativeTimeRange)` An object that allows percentages to specify the proportion of the call where you would like to apply a filter.
`TranscriptFilter`	`withTargets(Collection<String> targets)` The phrases that you're specifying for the transcript filter to match.
`TranscriptFilter`	`withTargets(String... targets)` The phrases that you're specifying for the transcript filter to match.
`TranscriptFilter`	`withTranscriptFilterType(String transcriptFilterType)` Matches the phrase to the transcription output in a word for word fashion.
`TranscriptFilter`	`withTranscriptFilterType(TranscriptFilterType transcriptFilterType)` Matches the phrase to the transcription output in a word for word fashion.

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

- Constructor Detail
  - TranscriptFilter
```
public TranscriptFilter()
```
- Method Detail
  - setTranscriptFilterType
```
public void setTranscriptFilterType(String transcriptFilterType)
```
    Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    Parameters:
    
    transcriptFilterType - Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    See Also:
    
    TranscriptFilterType
  - getTranscriptFilterType
```
public String getTranscriptFilterType()
```
    Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    Returns:
    
    Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    See Also:
    
    TranscriptFilterType
  - withTranscriptFilterType
```
public TranscriptFilter withTranscriptFilterType(String transcriptFilterType)
```
    Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    Parameters:
    
    transcriptFilterType - Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptFilterType
  - withTranscriptFilterType
```
public TranscriptFilter withTranscriptFilterType(TranscriptFilterType transcriptFilterType)
```
    Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    Parameters:
    
    transcriptFilterType - Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase "I want to speak to the manager." Amazon Transcribe attempts to match that specific phrase to the transcription.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptFilterType
  - setAbsoluteTimeRange
```
public void setAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)
```
    A time range, set in seconds, between two points in the call.
    
    Parameters:
    
    absoluteTimeRange - A time range, set in seconds, between two points in the call.
  - getAbsoluteTimeRange
```
public AbsoluteTimeRange getAbsoluteTimeRange()
```
    A time range, set in seconds, between two points in the call.
    
    Returns:
    
    A time range, set in seconds, between two points in the call.
  - withAbsoluteTimeRange
```
public TranscriptFilter withAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)
```
    A time range, set in seconds, between two points in the call.
    
    Parameters:
    
    absoluteTimeRange - A time range, set in seconds, between two points in the call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRelativeTimeRange
```
public void setRelativeTimeRange(RelativeTimeRange relativeTimeRange)
```
    An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
    
    Parameters:
    
    relativeTimeRange - An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
  - getRelativeTimeRange
```
public RelativeTimeRange getRelativeTimeRange()
```
    An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
    
    Returns:
    
    An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
  - withRelativeTimeRange
```
public TranscriptFilter withRelativeTimeRange(RelativeTimeRange relativeTimeRange)
```
    An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
    
    Parameters:
    
    relativeTimeRange - An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParticipantRole
```
public void setParticipantRole(String participantRole)
```
    Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    Parameters:
    
    participantRole - Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    See Also:
    
    ParticipantRole
  - getParticipantRole
```
public String getParticipantRole()
```
    Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    Returns:
    
    Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    See Also:
    
    ParticipantRole
  - withParticipantRole
```
public TranscriptFilter withParticipantRole(String participantRole)
```
    Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    Parameters:
    
    participantRole - Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantRole
  - withParticipantRole
```
public TranscriptFilter withParticipantRole(ParticipantRole participantRole)
```
    Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    Parameters:
    
    participantRole - Determines whether the customer or the agent is speaking the phrases that you've specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantRole
  - setNegate
```
public void setNegate(Boolean negate)
```
    If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
    
    Parameters:
    
    negate - If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
  - getNegate
```
public Boolean getNegate()
```
    If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
    
    Returns:
    
    If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
  - withNegate
```
public TranscriptFilter withNegate(Boolean negate)
```
    If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
    
    Parameters:
    
    negate - If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNegate
```
public Boolean isNegate()
```
    If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
    
    Returns:
    
    If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
  - getTargets
```
public List<String> getTargets()
```
    The phrases that you're specifying for the transcript filter to match.
    
    Returns:
    
    The phrases that you're specifying for the transcript filter to match.
  - setTargets
```
public void setTargets(Collection<String> targets)
```
    The phrases that you're specifying for the transcript filter to match.
    
    Parameters:
    
    targets - The phrases that you're specifying for the transcript filter to match.
  - withTargets
```
public TranscriptFilter withTargets(String... targets)
```
    The phrases that you're specifying for the transcript filter to match.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targets - The phrases that you're specifying for the transcript filter to match.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargets
```
public TranscriptFilter withTargets(Collection<String> targets)
```
    The phrases that you're specifying for the transcript filter to match.
    
    Parameters:
    
    targets - The phrases that you're specifying for the transcript filter to match.
    
    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 TranscriptFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class TranscriptFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TranscriptFilter

Method Detail

setTranscriptFilterType

getTranscriptFilterType

withTranscriptFilterType

withTranscriptFilterType

setAbsoluteTimeRange

getAbsoluteTimeRange

withAbsoluteTimeRange

setRelativeTimeRange

getRelativeTimeRange

withRelativeTimeRange

setParticipantRole

getParticipantRole

withParticipantRole

withParticipantRole

setNegate

getNegate

withNegate

isNegate

getTargets

setTargets

withTargets

withTargets

toString

equals

hashCode

clone

marshall