Package software.amazon.awssdk.services.transcribe.model

Class ToxicityDetectionSettings

java.lang.Object

software.amazon.awssdk.services.transcribe.model.ToxicityDetectionSettings

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class ToxicityDetectionSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ToxicityDetectionSettings.Builder,ToxicityDetectionSettings>

Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection ( ToxicityDetection) in your transcription request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToxicityDetectionSettings.Builder

Method Summary

Modifier and Type	Method	Description
static ToxicityDetectionSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasToxicityCategories()	For responses, this returns true if the service returned a value for the ToxicityCategories property.
List<SdkField<?>>	sdkFields()
static Class<? extends ToxicityDetectionSettings.Builder>	serializableBuilderClass()
ToxicityDetectionSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<ToxicityCategory>	toxicityCategories()	If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories.
List<String>	toxicityCategoriesAsStrings()	If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories.

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

toxicityCategories

public final List<ToxicityCategory> toxicityCategories()

If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasToxicityCategories() method.

Returns:

If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.

hasToxicityCategories

public final boolean hasToxicityCategories()

For responses, this returns true if the service returned a value for the ToxicityCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

toxicityCategoriesAsStrings

public final List<String> toxicityCategoriesAsStrings()

If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasToxicityCategories() method.

Returns:

If you include ToxicityDetection in your transcription request, you must also include ToxicityCategories. The only accepted value for this parameter is ALL.

toBuilder

public ToxicityDetectionSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToxicityDetectionSettings.Builder,ToxicityDetectionSettings>

builder

public static ToxicityDetectionSettings.Builder builder()

serializableBuilderClass

public static Class<? extends ToxicityDetectionSettings.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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo