software.amazon.awssdk.services.transcribe.model.ToxicityDetectionSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of transcribe Show documentation
Show all versions of transcribe Show documentation
The AWS Java SDK for Transcribe module holds the client classes that are used for
communicating with Transcribe.
/*
* Copyright 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 software.amazon.awssdk.services.transcribe.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection (
* ToxicityDetection) in your transcription request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ToxicityDetectionSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> TOXICITY_CATEGORIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ToxicityCategories")
.getter(getter(ToxicityDetectionSettings::toxicityCategoriesAsStrings))
.setter(setter(Builder::toxicityCategoriesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ToxicityCategories").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TOXICITY_CATEGORIES_FIELD));
private static final long serialVersionUID = 1L;
private final List toxicityCategories;
private ToxicityDetectionSettings(BuilderImpl builder) {
this.toxicityCategories = builder.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 {@link #hasToxicityCategories} method.
*
*
* @return If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
*/
public final List toxicityCategories() {
return ToxicityCategoriesCopier.copyStringToEnum(toxicityCategories);
}
/**
* 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 {@code 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.
*/
public final boolean hasToxicityCategories() {
return toxicityCategories != null && !(toxicityCategories instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasToxicityCategories} method.
*
*
* @return If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
*/
public final List toxicityCategoriesAsStrings() {
return toxicityCategories;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasToxicityCategories() ? toxicityCategoriesAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ToxicityDetectionSettings)) {
return false;
}
ToxicityDetectionSettings other = (ToxicityDetectionSettings) obj;
return hasToxicityCategories() == other.hasToxicityCategories()
&& Objects.equals(toxicityCategoriesAsStrings(), other.toxicityCategoriesAsStrings());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ToxicityDetectionSettings")
.add("ToxicityCategories", hasToxicityCategories() ? toxicityCategoriesAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ToxicityCategories":
return Optional.ofNullable(clazz.cast(toxicityCategoriesAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ToxicityDetectionSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
*
*
* @param toxicityCategories
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toxicityCategoriesWithStrings(Collection toxicityCategories);
/**
*
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
*
*
* @param toxicityCategories
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toxicityCategoriesWithStrings(String... toxicityCategories);
/**
*
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
*
*
* @param toxicityCategories
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toxicityCategories(Collection toxicityCategories);
/**
*
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
*
*
* @param toxicityCategories
* If you include ToxicityDetection in your transcription request, you must also include
* ToxicityCategories. The only accepted value for this parameter is ALL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toxicityCategories(ToxicityCategory... toxicityCategories);
}
static final class BuilderImpl implements Builder {
private List toxicityCategories = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ToxicityDetectionSettings model) {
toxicityCategoriesWithStrings(model.toxicityCategories);
}
public final Collection getToxicityCategories() {
if (toxicityCategories instanceof SdkAutoConstructList) {
return null;
}
return toxicityCategories;
}
public final void setToxicityCategories(Collection toxicityCategories) {
this.toxicityCategories = ToxicityCategoriesCopier.copy(toxicityCategories);
}
@Override
public final Builder toxicityCategoriesWithStrings(Collection toxicityCategories) {
this.toxicityCategories = ToxicityCategoriesCopier.copy(toxicityCategories);
return this;
}
@Override
@SafeVarargs
public final Builder toxicityCategoriesWithStrings(String... toxicityCategories) {
toxicityCategoriesWithStrings(Arrays.asList(toxicityCategories));
return this;
}
@Override
public final Builder toxicityCategories(Collection toxicityCategories) {
this.toxicityCategories = ToxicityCategoriesCopier.copyEnumToString(toxicityCategories);
return this;
}
@Override
@SafeVarargs
public final Builder toxicityCategories(ToxicityCategory... toxicityCategories) {
toxicityCategories(Arrays.asList(toxicityCategories));
return this;
}
@Override
public ToxicityDetectionSettings build() {
return new ToxicityDetectionSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy