Class ContentRedaction
- All Implemented Interfaces:
Serializable
,SdkPojo
,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: RedactionOutput
and
RedactionType
. You can optionally include PiiEntityTypes
to choose which types of PII you
want to redact.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ContentRedaction.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PiiEntityTypes property.final List
<PiiEntityType> Specify which types of personally identifiable information (PII) you want to redact in your transcript.Specify which types of personally identifiable information (PII) you want to redact in your transcript.final RedactionOutput
Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.final String
Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.final RedactionType
Specify the category of information you want to redact;PII
(personally identifiable information) is the only valid value.final String
Specify the category of information you want to redact;PII
(personally identifiable information) is the only valid value.static Class
<? extends ContentRedaction.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
redactionType
Specify the category of information you want to redact;
PII
(personally identifiable information) is the only valid value. You can usePiiEntityTypes
to choose which types of PII you want to redact. If you do not includePiiEntityTypes
in your request, all PII is redacted.If the service returns an enum value that is not available in the current SDK version,
redactionType
will returnRedactionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredactionTypeAsString()
.- Returns:
- Specify the category of information you want to redact;
PII
(personally identifiable information) is the only valid value. You can usePiiEntityTypes
to choose which types of PII you want to redact. If you do not includePiiEntityTypes
in your request, all PII is redacted. - See Also:
-
redactionTypeAsString
Specify the category of information you want to redact;
PII
(personally identifiable information) is the only valid value. You can usePiiEntityTypes
to choose which types of PII you want to redact. If you do not includePiiEntityTypes
in your request, all PII is redacted.If the service returns an enum value that is not available in the current SDK version,
redactionType
will returnRedactionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredactionTypeAsString()
.- Returns:
- Specify the category of information you want to redact;
PII
(personally identifiable information) is the only valid value. You can usePiiEntityTypes
to choose which types of PII you want to redact. If you do not includePiiEntityTypes
in your request, all PII is redacted. - See Also:
-
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 returnRedactionOutput.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredactionOutputAsString()
.- 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:
-
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 returnRedactionOutput.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromredactionOutputAsString()
.- 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:
-
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
. If you do not includePiiEntityTypes
in your request, all PII is redacted.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
. If you do not includePiiEntityTypes
in your request, all PII is redacted.
-
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 theisEmpty()
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
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
. If you do not includePiiEntityTypes
in your request, all PII is redacted.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
. If you do not includePiiEntityTypes
in your request, all PII is redacted.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ContentRedaction.Builder,
ContentRedaction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-