SentimentFilter (AWS Java SDK for Amazon Transcribe 1.12.141 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SentimentFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SentimentFilter()

Constructors
Constructor and Description
`SentimentFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SentimentFilter`	`clone()`
`boolean`	`equals(Object obj)`
`AbsoluteTimeRange`	`getAbsoluteTimeRange()` The time range, measured in seconds, of the sentiment.
`Boolean`	`getNegate()` Set to `TRUE` to look for sentiments that weren't specified in the request.
`String`	`getParticipantRole()` A value that determines whether the sentiment belongs to the customer or the agent.
`RelativeTimeRange`	`getRelativeTimeRange()` The time range, set in percentages, that correspond to proportion of the call.
`List<String>`	`getSentiments()` An array that enables you to specify sentiments for the customer or agent.
`int`	`hashCode()`
`Boolean`	`isNegate()` Set to `TRUE` to look for sentiments that weren't specified in the request.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)` The time range, measured in seconds, of the sentiment.
`void`	`setNegate(Boolean negate)` Set to `TRUE` to look for sentiments that weren't specified in the request.
`void`	`setParticipantRole(String participantRole)` A value that determines whether the sentiment belongs to the customer or the agent.
`void`	`setRelativeTimeRange(RelativeTimeRange relativeTimeRange)` The time range, set in percentages, that correspond to proportion of the call.
`void`	`setSentiments(Collection<String> sentiments)` An array that enables you to specify sentiments for the customer or agent.
`String`	`toString()` Returns a string representation of this object.
`SentimentFilter`	`withAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)` The time range, measured in seconds, of the sentiment.
`SentimentFilter`	`withNegate(Boolean negate)` Set to `TRUE` to look for sentiments that weren't specified in the request.
`SentimentFilter`	`withParticipantRole(ParticipantRole participantRole)` A value that determines whether the sentiment belongs to the customer or the agent.
`SentimentFilter`	`withParticipantRole(String participantRole)` A value that determines whether the sentiment belongs to the customer or the agent.
`SentimentFilter`	`withRelativeTimeRange(RelativeTimeRange relativeTimeRange)` The time range, set in percentages, that correspond to proportion of the call.
`SentimentFilter`	`withSentiments(Collection<String> sentiments)` An array that enables you to specify sentiments for the customer or agent.
`SentimentFilter`	`withSentiments(SentimentValue... sentiments)` An array that enables you to specify sentiments for the customer or agent.
`SentimentFilter`	`withSentiments(String... sentiments)` An array that enables you to specify sentiments for the customer or agent.

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

- Constructor Detail
  - SentimentFilter
```
public SentimentFilter()
```
- Method Detail
  - getSentiments
```
public List<String> getSentiments()
```
    An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Returns:
    
    An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    See Also:
    
    SentimentValue
  - setSentiments
```
public void setSentiments(Collection<String> sentiments)
```
    An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Parameters:
    
    sentiments - An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    See Also:
    
    SentimentValue
  - withSentiments
```
public SentimentFilter withSentiments(String... sentiments)
```
    An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    NOTE: This method appends the values to the existing list (if any). Use setSentiments(java.util.Collection) or withSentiments(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sentiments - An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SentimentValue
  - withSentiments
```
public SentimentFilter withSentiments(Collection<String> sentiments)
```
    An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Parameters:
    
    sentiments - An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SentimentValue
  - withSentiments
```
public SentimentFilter withSentiments(SentimentValue... sentiments)
```
    An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Parameters:
    
    sentiments - An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SentimentValue
  - setAbsoluteTimeRange
```
public void setAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)
```
    The time range, measured in seconds, of the sentiment.
    
    Parameters:
    
    absoluteTimeRange - The time range, measured in seconds, of the sentiment.
  - getAbsoluteTimeRange
```
public AbsoluteTimeRange getAbsoluteTimeRange()
```
    The time range, measured in seconds, of the sentiment.
    
    Returns:
    
    The time range, measured in seconds, of the sentiment.
  - withAbsoluteTimeRange
```
public SentimentFilter withAbsoluteTimeRange(AbsoluteTimeRange absoluteTimeRange)
```
    The time range, measured in seconds, of the sentiment.
    
    Parameters:
    
    absoluteTimeRange - The time range, measured in seconds, of the sentiment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRelativeTimeRange
```
public void setRelativeTimeRange(RelativeTimeRange relativeTimeRange)
```
    The time range, set in percentages, that correspond to proportion of the call.
    
    Parameters:
    
    relativeTimeRange - The time range, set in percentages, that correspond to proportion of the call.
  - getRelativeTimeRange
```
public RelativeTimeRange getRelativeTimeRange()
```
    The time range, set in percentages, that correspond to proportion of the call.
    
    Returns:
    
    The time range, set in percentages, that correspond to proportion of the call.
  - withRelativeTimeRange
```
public SentimentFilter withRelativeTimeRange(RelativeTimeRange relativeTimeRange)
```
    The time range, set in percentages, that correspond to proportion of the call.
    
    Parameters:
    
    relativeTimeRange - The time range, set in percentages, that correspond to proportion of the call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParticipantRole
```
public void setParticipantRole(String participantRole)
```
    A value that determines whether the sentiment belongs to the customer or the agent.
    
    Parameters:
    
    participantRole - A value that determines whether the sentiment belongs to the customer or the agent.
    
    See Also:
    
    ParticipantRole
  - getParticipantRole
```
public String getParticipantRole()
```
    A value that determines whether the sentiment belongs to the customer or the agent.
    
    Returns:
    
    A value that determines whether the sentiment belongs to the customer or the agent.
    
    See Also:
    
    ParticipantRole
  - withParticipantRole
```
public SentimentFilter withParticipantRole(String participantRole)
```
    A value that determines whether the sentiment belongs to the customer or the agent.
    
    Parameters:
    
    participantRole - A value that determines whether the sentiment belongs to the customer or the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantRole
  - withParticipantRole
```
public SentimentFilter withParticipantRole(ParticipantRole participantRole)
```
    A value that determines whether the sentiment belongs to the customer or the agent.
    
    Parameters:
    
    participantRole - A value that determines whether the sentiment belongs to the customer or the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParticipantRole
  - setNegate
```
public void setNegate(Boolean negate)
```
    Set to TRUE to look for sentiments that weren't specified in the request.
    
    Parameters:
    
    negate - Set to TRUE to look for sentiments that weren't specified in the request.
  - getNegate
```
public Boolean getNegate()
```
    Set to TRUE to look for sentiments that weren't specified in the request.
    
    Returns:
    
    Set to TRUE to look for sentiments that weren't specified in the request.
  - withNegate
```
public SentimentFilter withNegate(Boolean negate)
```
    Set to TRUE to look for sentiments that weren't specified in the request.
    
    Parameters:
    
    negate - Set to TRUE to look for sentiments that weren't specified in the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNegate
```
public Boolean isNegate()
```
    Set to TRUE to look for sentiments that weren't specified in the request.
    
    Returns:
    
    Set to TRUE to look for sentiments that weren't specified in the request.
  - 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 SentimentFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SentimentFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SentimentFilter

Method Detail

getSentiments

setSentiments

withSentiments

withSentiments

withSentiments

setAbsoluteTimeRange

getAbsoluteTimeRange

withAbsoluteTimeRange

setRelativeTimeRange

getRelativeTimeRange

withRelativeTimeRange

setParticipantRole

getParticipantRole

withParticipantRole

withParticipantRole

setNegate

getNegate

withNegate

isNegate

toString

equals

hashCode

clone

marshall