com.amazonaws.services.transcribe.model.Rule Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.transcribe.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Rule implements Serializable, Cloneable, StructuredPojo {
/**
*
* Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more
* detail.
*
*/
private NonTalkTimeFilter nonTalkTimeFilter;
/**
*
* Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more
* detail.
*
*/
private InterruptionFilter interruptionFilter;
/**
*
* Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to
* for more detail.
*
*/
private TranscriptFilter transcriptFilter;
/**
*
* Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for
* more detail.
*
*/
private SentimentFilter sentimentFilter;
/**
*
* Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more
* detail.
*
*
* @param nonTalkTimeFilter
* Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to
* for more detail.
*/
public void setNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter) {
this.nonTalkTimeFilter = nonTalkTimeFilter;
}
/**
*
* Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more
* detail.
*
*
* @return Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to
* for more detail.
*/
public NonTalkTimeFilter getNonTalkTimeFilter() {
return this.nonTalkTimeFilter;
}
/**
*
* Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more
* detail.
*
*
* @param nonTalkTimeFilter
* Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to
* for more detail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withNonTalkTimeFilter(NonTalkTimeFilter nonTalkTimeFilter) {
setNonTalkTimeFilter(nonTalkTimeFilter);
return this;
}
/**
*
* Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more
* detail.
*
*
* @param interruptionFilter
* Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for
* more detail.
*/
public void setInterruptionFilter(InterruptionFilter interruptionFilter) {
this.interruptionFilter = interruptionFilter;
}
/**
*
* Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more
* detail.
*
*
* @return Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for
* more detail.
*/
public InterruptionFilter getInterruptionFilter() {
return this.interruptionFilter;
}
/**
*
* Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more
* detail.
*
*
* @param interruptionFilter
* Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for
* more detail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withInterruptionFilter(InterruptionFilter interruptionFilter) {
setInterruptionFilter(interruptionFilter);
return this;
}
/**
*
* Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to
* for more detail.
*
*
* @param transcriptFilter
* Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.
* Refer to for more detail.
*/
public void setTranscriptFilter(TranscriptFilter transcriptFilter) {
this.transcriptFilter = transcriptFilter;
}
/**
*
* Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to
* for more detail.
*
*
* @return Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.
* Refer to for more detail.
*/
public TranscriptFilter getTranscriptFilter() {
return this.transcriptFilter;
}
/**
*
* Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to
* for more detail.
*
*
* @param transcriptFilter
* Flag the presence or absence of specific words or phrases in your Call Analytics transcription output.
* Refer to for more detail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withTranscriptFilter(TranscriptFilter transcriptFilter) {
setTranscriptFilter(transcriptFilter);
return this;
}
/**
*
* Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for
* more detail.
*
*
* @param sentimentFilter
* Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to
* for more detail.
*/
public void setSentimentFilter(SentimentFilter sentimentFilter) {
this.sentimentFilter = sentimentFilter;
}
/**
*
* Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for
* more detail.
*
*
* @return Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to
* for more detail.
*/
public SentimentFilter getSentimentFilter() {
return this.sentimentFilter;
}
/**
*
* Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for
* more detail.
*
*
* @param sentimentFilter
* Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to
* for more detail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Rule withSentimentFilter(SentimentFilter sentimentFilter) {
setSentimentFilter(sentimentFilter);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNonTalkTimeFilter() != null)
sb.append("NonTalkTimeFilter: ").append(getNonTalkTimeFilter()).append(",");
if (getInterruptionFilter() != null)
sb.append("InterruptionFilter: ").append(getInterruptionFilter()).append(",");
if (getTranscriptFilter() != null)
sb.append("TranscriptFilter: ").append(getTranscriptFilter()).append(",");
if (getSentimentFilter() != null)
sb.append("SentimentFilter: ").append(getSentimentFilter());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Rule == false)
return false;
Rule other = (Rule) obj;
if (other.getNonTalkTimeFilter() == null ^ this.getNonTalkTimeFilter() == null)
return false;
if (other.getNonTalkTimeFilter() != null && other.getNonTalkTimeFilter().equals(this.getNonTalkTimeFilter()) == false)
return false;
if (other.getInterruptionFilter() == null ^ this.getInterruptionFilter() == null)
return false;
if (other.getInterruptionFilter() != null && other.getInterruptionFilter().equals(this.getInterruptionFilter()) == false)
return false;
if (other.getTranscriptFilter() == null ^ this.getTranscriptFilter() == null)
return false;
if (other.getTranscriptFilter() != null && other.getTranscriptFilter().equals(this.getTranscriptFilter()) == false)
return false;
if (other.getSentimentFilter() == null ^ this.getSentimentFilter() == null)
return false;
if (other.getSentimentFilter() != null && other.getSentimentFilter().equals(this.getSentimentFilter()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNonTalkTimeFilter() == null) ? 0 : getNonTalkTimeFilter().hashCode());
hashCode = prime * hashCode + ((getInterruptionFilter() == null) ? 0 : getInterruptionFilter().hashCode());
hashCode = prime * hashCode + ((getTranscriptFilter() == null) ? 0 : getTranscriptFilter().hashCode());
hashCode = prime * hashCode + ((getSentimentFilter() == null) ? 0 : getSentimentFilter().hashCode());
return hashCode;
}
@Override
public Rule clone() {
try {
return (Rule) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transcribe.model.transform.RuleMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}