software.amazon.awssdk.services.transcribe.model

Class ContentRedaction

java.lang.Object

software.amazon.awssdk.services.transcribe.model.ContentRedaction

All Implemented Interfaces:

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

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

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ContentRedaction.Builder

Method Summary

Modifier and Type	Method and Description
static ContentRedaction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPiiEntityTypes() For responses, this returns true if the service returned a value for the PiiEntityTypes property.
List<PiiEntityType>	piiEntityTypes() Specify which types of personally identifiable information (PII) you want to redact in your transcript.
List<String>	piiEntityTypesAsStrings() Specify which types of personally identifiable information (PII) you want to redact in your transcript.
RedactionOutput	redactionOutput() Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.
String	redactionOutputAsString() Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.
RedactionType	redactionType() Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value.
String	redactionTypeAsString() Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value.
List<SdkField<?>>	sdkFields()
static Class<? extends ContentRedaction.Builder>	serializableBuilderClass()
ContentRedaction.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

redactionType

public final RedactionType redactionType()

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.

If the service returns an enum value that is not available in the current SDK version, redactionType will return RedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionTypeAsString().

Returns:

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.

See Also:

RedactionType

redactionTypeAsString

public final String redactionTypeAsString()

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.

If the service returns an enum value that is not available in the current SDK version, redactionType will return RedactionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionTypeAsString().

Returns:

Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.

See Also:

RedactionType

redactionOutput

public final RedactionOutput redactionOutput()

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

When you choose redacted Amazon Transcribe creates only a redacted transcript.

When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

If the service returns an enum value that is not available in the current SDK version, redactionOutput will return RedactionOutput.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionOutputAsString().

Returns:

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

When you choose redacted Amazon Transcribe creates only a redacted transcript.

When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

See Also:

RedactionOutput

redactionOutputAsString

public final String redactionOutputAsString()

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

When you choose redacted Amazon Transcribe creates only a redacted transcript.

When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

If the service returns an enum value that is not available in the current SDK version, redactionOutput will return RedactionOutput.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redactionOutputAsString().

Returns:

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.

When you choose redacted Amazon Transcribe creates only a redacted transcript.

When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).

See Also:

RedactionOutput

piiEntityTypes

public final List<PiiEntityType> piiEntityTypes()

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select 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 hasPiiEntityTypes() method.

Returns:

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

hasPiiEntityTypes

public final boolean hasPiiEntityTypes()

For responses, this returns true if the service returned a value for the PiiEntityTypes 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.

piiEntityTypesAsStrings

public final List<String> piiEntityTypesAsStrings()

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select 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 hasPiiEntityTypes() method.

Returns:

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

toBuilder

public ContentRedaction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ContentRedaction.Builder,ContentRedaction>

builder

public static ContentRedaction.Builder builder()

serializableBuilderClass

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