software.amazon.awssdk.services.transcribe.model.ContentRedaction Maven / Gradle / Ivy
Show all versions of transcribe Show documentation
/*
* 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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Settings for content redaction within a transcription job.
*
*
* You can redact transcripts in US English (en-us). For more information see: Automatic Content Redaction
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ContentRedaction implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField REDACTION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ContentRedaction::redactionTypeAsString)).setter(setter(Builder::redactionType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RedactionType").build()).build();
private static final SdkField REDACTION_OUTPUT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ContentRedaction::redactionOutputAsString)).setter(setter(Builder::redactionOutput))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RedactionOutput").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REDACTION_TYPE_FIELD,
REDACTION_OUTPUT_FIELD));
private static final long serialVersionUID = 1L;
private final String redactionType;
private final String redactionOutput;
private ContentRedaction(BuilderImpl builder) {
this.redactionType = builder.redactionType;
this.redactionOutput = builder.redactionOutput;
}
/**
*
* Request parameter that defines the entities to be redacted. The only accepted value is PII.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #redactionType}
* will return {@link RedactionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #redactionTypeAsString}.
*
*
* @return Request parameter that defines the entities to be redacted. The only accepted value is PII.
* @see RedactionType
*/
public RedactionType redactionType() {
return RedactionType.fromValue(redactionType);
}
/**
*
* Request parameter that defines the entities to be redacted. The only accepted value is PII.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #redactionType}
* will return {@link RedactionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #redactionTypeAsString}.
*
*
* @return Request parameter that defines the entities to be redacted. The only accepted value is PII.
* @see RedactionType
*/
public String redactionTypeAsString() {
return redactionType;
}
/**
*
* Request parameter where you choose whether to output only the redacted transcript or generate an additional
* unredacted transcript.
*
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted transcript and
* related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the unredacted
* transcript and related information in addition to the JSON file with the redacted transcript.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #redactionOutput}
* will return {@link RedactionOutput#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #redactionOutputAsString}.
*
*
* @return Request parameter where you choose whether to output only the redacted transcript or generate an
* additional unredacted transcript.
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted
* transcript and related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the
* unredacted transcript and related information in addition to the JSON file with the redacted transcript.
* @see RedactionOutput
*/
public RedactionOutput redactionOutput() {
return RedactionOutput.fromValue(redactionOutput);
}
/**
*
* Request parameter where you choose whether to output only the redacted transcript or generate an additional
* unredacted transcript.
*
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted transcript and
* related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the unredacted
* transcript and related information in addition to the JSON file with the redacted transcript.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #redactionOutput}
* will return {@link RedactionOutput#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #redactionOutputAsString}.
*
*
* @return Request parameter where you choose whether to output only the redacted transcript or generate an
* additional unredacted transcript.
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted
* transcript and related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the
* unredacted transcript and related information in addition to the JSON file with the redacted transcript.
* @see RedactionOutput
*/
public String redactionOutputAsString() {
return redactionOutput;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(redactionTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(redactionOutputAsString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ContentRedaction)) {
return false;
}
ContentRedaction other = (ContentRedaction) obj;
return Objects.equals(redactionTypeAsString(), other.redactionTypeAsString())
&& Objects.equals(redactionOutputAsString(), other.redactionOutputAsString());
}
/**
* 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 String toString() {
return ToString.builder("ContentRedaction").add("RedactionType", redactionTypeAsString())
.add("RedactionOutput", redactionOutputAsString()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RedactionType":
return Optional.ofNullable(clazz.cast(redactionTypeAsString()));
case "RedactionOutput":
return Optional.ofNullable(clazz.cast(redactionOutputAsString()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ContentRedaction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Request parameter that defines the entities to be redacted. The only accepted value is PII.
*
*
* @param redactionType
* Request parameter that defines the entities to be redacted. The only accepted value is
* PII.
* @see RedactionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see RedactionType
*/
Builder redactionType(String redactionType);
/**
*
* Request parameter that defines the entities to be redacted. The only accepted value is PII.
*
*
* @param redactionType
* Request parameter that defines the entities to be redacted. The only accepted value is
* PII.
* @see RedactionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see RedactionType
*/
Builder redactionType(RedactionType redactionType);
/**
*
* Request parameter where you choose whether to output only the redacted transcript or generate an additional
* unredacted transcript.
*
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted transcript
* and related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the
* unredacted transcript and related information in addition to the JSON file with the redacted transcript.
*
*
* @param redactionOutput
* Request parameter where you choose whether to output only the redacted transcript or generate an
* additional unredacted transcript.
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted
* transcript and related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the
* unredacted transcript and related information in addition to the JSON file with the redacted
* transcript.
* @see RedactionOutput
* @return Returns a reference to this object so that method calls can be chained together.
* @see RedactionOutput
*/
Builder redactionOutput(String redactionOutput);
/**
*
* Request parameter where you choose whether to output only the redacted transcript or generate an additional
* unredacted transcript.
*
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted transcript
* and related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the
* unredacted transcript and related information in addition to the JSON file with the redacted transcript.
*
*
* @param redactionOutput
* Request parameter where you choose whether to output only the redacted transcript or generate an
* additional unredacted transcript.
*
* When you choose redacted Amazon Transcribe outputs a JSON file with only the redacted
* transcript and related information.
*
*
* When you choose redacted_and_unredacted Amazon Transcribe outputs a JSON file with the
* unredacted transcript and related information in addition to the JSON file with the redacted
* transcript.
* @see RedactionOutput
* @return Returns a reference to this object so that method calls can be chained together.
* @see RedactionOutput
*/
Builder redactionOutput(RedactionOutput redactionOutput);
}
static final class BuilderImpl implements Builder {
private String redactionType;
private String redactionOutput;
private BuilderImpl() {
}
private BuilderImpl(ContentRedaction model) {
redactionType(model.redactionType);
redactionOutput(model.redactionOutput);
}
public final String getRedactionTypeAsString() {
return redactionType;
}
@Override
public final Builder redactionType(String redactionType) {
this.redactionType = redactionType;
return this;
}
@Override
public final Builder redactionType(RedactionType redactionType) {
this.redactionType(redactionType == null ? null : redactionType.toString());
return this;
}
public final void setRedactionType(String redactionType) {
this.redactionType = redactionType;
}
public final String getRedactionOutputAsString() {
return redactionOutput;
}
@Override
public final Builder redactionOutput(String redactionOutput) {
this.redactionOutput = redactionOutput;
return this;
}
@Override
public final Builder redactionOutput(RedactionOutput redactionOutput) {
this.redactionOutput(redactionOutput == null ? null : redactionOutput.toString());
return this;
}
public final void setRedactionOutput(String redactionOutput) {
this.redactionOutput = redactionOutput;
}
@Override
public ContentRedaction build() {
return new ContentRedaction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}